Java 注解 Annotation自定義實戰

概念：

Java 提供的一種原程式中的元素關聯任何資訊和任何中繼資料的途徑和方法

内容：

Java 中常見的注解
注解分類
自定義注解
注解應用實戰

一、Java 中常見的注解

1、JDK 自帶注解

@Override 覆寫
@Deprecated 廢棄
@SuppressWarnings 抑制警告

示例代碼：

AnnotationDemo.java

package demo;


interface Human{
    public void sayHello();
    public void sayHi();
}


class Person implements Human{

    @Override
    public void sayHello() {
        System.out.println("hello");
    }

    @Deprecated
    @Override
    public void sayHi() {
        System.out.println("hi");
    }
}


public class AnnotationDemo {
    public static void main(String[] args) {
        Person person = new Person();
        person.sayHi();
    }
}

以上代碼執行編譯的時候會有提示

$ javac AnnotationDemo.java
注: AnnotationDemo.java使用或覆寫了已過時的 API。
注: 有關詳細資訊, 請使用 -Xlint:deprecation 重新編譯。


$ javac AnnotationDemo.java -Xlint:deprecation
AnnotationDemo.java:28: 警告: [deprecation] Person中的sayHi()已過時
        person.sayHi();
              ^
1 個警告

可以抑制警告

public class AnnotationDemo {
    @SuppressWarnings("deprecation")
    public static void main(String[] args) {
        Person person = new Person();
        person.sayHi();
    }
}

再次編譯就沒有提示了

2、常見的第三方注解

Spring

@Autowired
@Service
@Repository

MyBatis

@InsertProvider
@UpdateProvider
@Options

二、注解分類

1、按照運作機制分

源碼注解注解隻存在于源碼中，編譯後成.class 檔案就不存在了
編譯時注解注解在源碼和.class 檔案都存在
運作時注解在運作階段還起作用，會影響運作邏輯

eg: @Autowired

2、按照來源分

JDK 注解
第三方注解

元注解：注解的注解、

三、自定義注解

1、自定義注解文法

示例及說明

package demo;

import java.lang.annotation.*;

/**
 * Target是注解作用域：
 *  TYPE 類，接口
 *  FIELD 字段聲明
 *  METHOD 方法聲明
 *  PARAMETER 參數聲明
 *  CONSTRUCTOR 構造方法聲明
 *  LOCAL_VARIABLE 局部變量聲明
 *  ANNOTATION_TYPE
 *  PACKAGE 包聲明
 *
 * Retention 生命周期
 *  SOURCE 隻在源碼顯示，編譯時會丢棄
 *  CLASS 編譯時會記錄到class中，運作時忽略
 *  RUNTIME 運作時存在，可以通過反射讀取
 *
 * Inherited 允許子類繼承
 *
 * Documented 生成javadoc時會包含注解資訊
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
// 1、使用關鍵詞@interface 定義注解
public @interface Description {
    // 2、成員以無參無異常方式聲明
    String desc();

    // 3、可以用default為成員指定預設值
    int age() default 18;

    // 4、成員類型是受限的，合法的類型包括原始類型及
    // String, Class, Annotation, Enumeration
    String author();
}
/**
 * 5、如果注解隻有一個成員，則成員名必須取名為: value()
 * 在使用時可以忽略成員名和指派号（=）
 *
 * 6、注解類可以沒有成員，沒有成員的注解稱為 辨別注解
 */

2、使用注解的文法

// @<注解名>(<成員名>=<成員值>...)

class Demo {
    @Description(desc = "i am  eyeColor", author = "Tom", age = 18)
    public String eyeColor() {
        return "red";
    }

    public static void main(String[] args) {

    }
}

3、解析注解

通過反射擷取類、函數或成員上運作時注解資訊，進而實作動态控制程式運作的邏輯

package demo;

import java.lang.annotation.*;
import java.lang.reflect.Method;

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Description {
    String value();
}

@Description("a class annotation")
class Demo {
    @Description("a method annotation")
    public String eyeColor() {
        return "red";
    }
}

class DemoTest {
    public static void main(String[] args) throws ClassNotFoundException {
        // 1、使用類加載器
        Class clazz = Class.forName("demo.Demo");

        // 2、找到類上面的注解
        boolean isExist = clazz.isAnnotationPresent(Description.class);
        if (isExist) {
            // 3、拿到注解執行個體
            Description description = (Description) clazz.getAnnotation(Description.class);
            System.out.println(description.value());
            // a class annotation
        }

        // 找到方法上的注解
        Method[] methods = clazz.getMethods();
        for (Method method : methods) {
            boolean isMethodExist = method.isAnnotationPresent(Description.class);
            if (isMethodExist) {
                Description description = (Description) method.getAnnotation(Description.class);
                System.out.println(description.value());
            }
        }

        // 另一種解析方法
        for (Method method : methods) {
            Annotation[] annotations = method.getAnnotations();
            for (Annotation annotation : annotations) {
                if (annotation instanceof Description) {
                    Description description = (Description) annotation;
                    System.out.println(description.value());
                }
            }
        }
    }
}

4、繼承@Inherited

package demo;

import java.lang.annotation.*;
import java.lang.reflect.Method;

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Description {
    String value();
}

@Description("a class annotation")
class Person {
    @Description("a method annotation")
    public String eyeColor() {
        return "red";
    }
}


class Child extends Person {
    @Override
    public String eyeColor() {
        return "red";
    }
}

// Child 繼承 Person 可以擷取類上面的注解

四、注解實戰

1、項目說明

用注解實作持久層架構，替代 Hibernate 解決方案

2、需求：

有一張使用者表，字段包括使用者使用者名，年齡，電話

友善對每個對象進行儲存，并列印出 SQL。

使用方式要足夠簡單，見代碼示例。

3、思路：

考慮代碼如何與資料庫進行映射

實作 save

4、代碼實作

檔案目錄

.
├── Column.java
├── Demo.java
├── Table.java
└── User.java

Table.java

package anno;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Table {
    String value();
}

Column.java

package anno;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    String value();
}

User.java

package anno;

@Table("user")
public class User {
    @Column("name")
    private String name;

    @Column("age")
    private Integer age;

    @Column("phone_number")
    private String phoneNumber;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getPhoneNumber() {
        return phoneNumber;
    }

    public void setPhoneNumber(String phoneNumber) {
        this.phoneNumber = phoneNumber;
    }
}

Demo.java

package anno;

import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class Demo {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InvocationTargetException {
        User user = new User();
        user.setAge(12);

        System.out.println(save(user));
        //insert into `user` (`name`, `phone_number`, `age`) values('null', 'null', '12')
    }

    private static String save(User user) throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        // 擷取class
        Class clazz = user.getClass();

        // 擷取表名
        if (!clazz.isAnnotationPresent(Table.class)) {
            return null;
        }

        StringBuilder builder = new StringBuilder();
        builder.append("insert into ");

        Table table = (Table) clazz.getAnnotation(Table.class);
        String tableName = table.value();
        builder.append("`").append(tableName).append("` ");

        // 擷取所有字段名和字段值
        Map<String, String> map = new HashMap<>();

        Field[] fields = clazz.getDeclaredFields();
        for (Field field : fields) {
            if (!field.isAnnotationPresent(Column.class)) {
                continue;
            }

            // 通過注解擷取字段名稱
            Column column = field.getAnnotation(Column.class);
            String columnName = column.value();

            // 通過反射擷取字段的值
            String fieldName = field.getName();
            String methodName = "get" + fieldName.substring(0, 1).toUpperCase() + fieldName.substring(1);
            Method method = clazz.getMethod(methodName);
            String columnValue = String.valueOf(method.invoke(user));

            map.put(columnName, columnValue);
        }

        // 拼裝sql
        builder.append("(");
        Object[] columns = map.keySet().toArray();
        for (int i = 0; i < columns.length; i++) {
            builder.append("`").append(columns[i].toString()).append("`");
            if (i != columns.length - 1) {
                builder.append(", ");
            }
        }

        builder.append(") ");

        builder.append("values");

        builder.append("(");
        Object[] values = map.values().toArray();
        for (int i = 0; i < values.length; i++) {
            builder.append("'").append(values[i].toString()).append("'");
            if (i != values.length - 1) {
                builder.append(", ");
            }
        }
        builder.append(") ");

        return builder.toString();
    }
}

五、總結

1、認識注解

2、注解的作用範圍@Target 和生命周期@Retention

（1）作用範圍：包、類、字段、方法、方法參數、局部變量

（2）生命周期：源檔案 source,編譯 class, 運作 runtime

3、讀懂注解

4、使用注解解決實際開發問題

Java 注解 Annotation自定義實戰

一、Java 中常見的注解

二、注解分類

三、自定義注解

四、注解實戰

五、總結

繼續閱讀

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

用mybatis的generator插件在項目中自動生成dao及entity

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

NOSQL安全攻擊

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

登入plsql 報錯 the account is locked --使用者被鎖

sqlServer根據經緯查距離

Effective Java 8:通用程式設計

SequoiaDB巨杉資料庫C++驅動概述

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

從mybatis到mybatis plus(mp)

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method