詳解java自定義註解及其開發

java註解簡介

java中的常見註解主要包括以下兩類：jdk自帶註解和元註解（可實現自定義註解）

jdk的自帶註解

1. @Override：告訴編譯器我重寫了接口方法
2. @Deprecated：告訴編譯器這個方法過時了，不建議使用，Ide會在方法上劃橫線
3. @SuppressWarnings("deprecation"):關閉方法中出現的警告

等等

元註解

元註解的作用就是註解其他註解，一般我們使用自定義註解時，就需要用元註解來標註我們自己的註解，一共有四個元註解：

1、@Target：說明了Annotation被修飾的範圍，可被用於packages、types（類、接口、枚舉、Annotation類型）、類型成員（方法、構造方法、成員變量、枚舉值）、方法參數和本地變量（如循環變量、catch參數）。在Annotation類型的聲明中使用了target可更加清晰其修飾的目標。

例：@Target(ElementType.TYPE)
1.ElementType.CONSTRUCTOR:用於描述構造器
2.ElementType.FIELD:用於描述域（類的成員變量）
3.ElementType.LOCAL_VARIABLE:用於描述局部變量（方法內部變量）
4.ElementType.METHOD:用於描述方法
5.ElementType.PACKAGE:用於描述包
6.ElementType.PARAMETER:用於描述參數
7.ElementType.TYPE:用於描述類、接口(包括註解類型) 或enum聲明

2、@Retention：定義了該Annotation被保留的時間長短，有些只在源碼中保留，有時需要編譯成的class中保留，有些需要程序運行時保留。即描述註解的生命週期。

例：@Retention(RetentionPolicy.RUNTIME)
1.RetentionPoicy.SOURCE:在源文件中有效（即源文件保留）
2.RetentionPoicy.CLASS:在class文件中有效（即class保留）
3.RetentionPoicy.RUNTIME:在運行時有效（即運行時保留）

3、@Documented：它是一個標記註解，即沒有成員的註解，用於描述其它類型的annotation應該被作爲被標註的程序成員的公共API，因此可以被例如javadoc此類的工具文檔化

4、@Inherited：它也是一個標記註解，它的作用是，被它標註的類型是可被繼承的，比如一個class被@Inherited標記，那麼一個子類繼承該class後，則這個annotation將被用於該class的子類。

自定義註解

public @interface 註解名 {定義體}

使用@interface定義一個註解，自動繼承java.lang.annotation.Annotation接口，其中的每一個方法實際上是聲明瞭一個配置參數。方法的名稱就是參數的名稱，返回值類型就是參數的類型（返回值類型只能是基本類型、Class、String、enum）。可通過default來聲明參數的默認值。default來聲明參數的默認。註解參數的可支持數據類型：

1.所有基本數據類型（int,float,boolean,byte,double,char,long,short)
2.String類型
3.Class類型
4.enum類型
5.Annotation類型
6.以上所有類型的數組

定義註解成員的注意點：

第一，只能用public或默認（default）這個訪問權修改。例如，String value();這裏把方法設爲default默認類型：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface userName {
    String value() default "";
}

第二，參數成員只能用基本類型byte,char,int,long,float,double,boolean八種基本數據類型和和 String,Enum,Class,annotations等。數據類型，以及這一些類型的數組。

//定義一個枚舉
public enum RequestMethod {
	GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE
}


@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
    String name() default "";

    String[] path() default {};

    RequestMethod[] method() default {};//枚舉數組
}

第三,如果只有一個參數成員,最好把參數名稱設爲"value",後加小括號。

註解的默認值

註解元素必須有確定的值，要麼指定時給默認值，要麼使用時給值。不過有時候我們需要確定表達一個元素不存在值，所以使用空字符串或者負數表示某個元素不存在，在定義註解，這已經成爲一個約定用法。

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface User {

    public int id() default -1;
    public String name() default "";
    public String address() default "";
}

父類的類上和方法上有自定義註解，並且被@Inherited標記，那麼子類只有繼承的情況下才會繼承父類註解。重寫、重載實現父類方法這些都不會繼承。

總結AnnotatedElement的常用方法

注意：

getDeclaredAnnotations和getAnnotations得到的都是當前類上面所有的註解（不包括方法上註解和屬性上註解），不同的是，前者不包括繼承的。而getAnnotations得到的是包括繼承的所有註解。

註解處理器實例

自定義註解定義：

@MyTable(value = "tb_student")
public class Student {
    @MyField(columnName = "sname", type = "varchar2", length = 128)
    private String name;
    @MyField(columnName = "age", type = "int", length = 3)
    private int age;
    @MyField(columnName = "id", type = "int", length = 128)
    private int id;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    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 class Demo {
    public static void main(String[] args) {

        try {
            //通過反射獲取Student類對象
            Class clazz = Class.forName("com.wsh.annotation02.Student");

            //獲取Student類的所有有效註解
            Annotation[] annotations = clazz.getAnnotations();
            for (Annotation annotation : annotations) {
                //@com.wsh.annotation02.MyTable(value=tb_student)
                System.out.println(annotation);
            }

            //獲取類指定的註解
            MyTable myTable = (MyTable) clazz.getAnnotation(MyTable.class);
            System.out.println(myTable.value());  //tb_student

            //獲取類的屬性的註解
            Field name_field = clazz.getDeclaredField("name");
            MyField nameField = name_field.getAnnotation(MyField.class);
            System.out.println(nameField.columnName());   //sname
            System.out.println(nameField.type());  //varchar2
            System.out.println(nameField.length());  //128

            //至此，各個字段的屬性名稱、長度、類型都獲取了、就可以動態拼接創建數據表的sql...

        } catch (ClassNotFoundException | NoSuchFieldException e) {
            e.printStackTrace();
        }

    }
}