Java自定義註解之元註解（meta-annotation）Target、Retention、Documented、Inherited介紹

 元註解：

  元註解的做用就是負責註解其餘（如：自定義）註解，用來對其它 annotation類型做說明。Java定義了4個標準的meta-annotation類型：

　　　1.@Target

　　　2.@Retention

　　　3.@Documented

   4.@Inherited

  這些類型和它們所支持的類在java.lang.annotation包中能夠找到。下面咱們看一下每一個元註解的做用和相應分參數的使用說明。

@Target：說明了Annotation所修飾的對象範圍做；用於描述註解的使用範圍（即：被描述的註解能夠用在什麼地方）

  @Target註解可被用於：

  （1）packages、types（類、接口、枚舉、Annotation類型）、

  （2）類型成員（方法、構造方法、成員變量、枚舉值）、

  （3）方法參數和本地變量（如循環變量、catch參數）。

  （4）在Annotation類型的聲明中使用了target可更加明晰其修飾的目標。　　

　　取值(ElementType)有：

　　　1.CONSTRUCTOR:用於描述構造器

　　　2.FIELD:用於描述域

　　　3.LOCAL_VARIABLE:用於描述局部變量

　　　4.METHOD:用於描述方法

　　　5.PACKAGE:用於描述包
　　　6.PARAMETER:用於描述參數

　　　7.TYPE:用於描述類、接口(包括註解類型) 或enum聲明

使用實例：

註解Target能夠用於註解類、接口(包括註解類型) 或enum聲明,而註解NoDBColumn僅可用於註解類的成員變量。

@Target(ElementType.TYPE)

public @interface Test {

public String TestName() default "testName";

}

@Target(ElementType.FIELD)

public @interface NoDBColumn {

}

@Retention：定義了該Annotation被保留的時間長短，使用這個meta-Annotation能夠對註解的「生命週期」限制，用於描述註解的生命週期（即：被描述的註解在什麼範圍內有效）

       Retention meta-annotation類型有惟一的value做爲成員，它的取值來自java.lang.annotation.RetentionPolicy的枚舉類型值。

　　 取值（RetentionPoicy）有：

　　　1.SOURCE:這種類型的Annotations只在源代碼級別保留,編譯時就會被忽略

　　　2.CLASS:在c這種類型的Annotations編譯時被保留,在class文件中存在,但JVM將會忽略

　　　3.RUNTIME:這種類型的Annotations將被JVM保留,因此他們能在運行時被JVM或其餘使用反射機制的代碼所讀取和使用。請注意並不影響class的執行，由於Annotation與class在使用上是被分離的

使用實例：

DbColumn類註解的元註解RetentionPolicy的屬性值是RUTIME，這樣註解處理器能夠經過反射，獲取到該註解的屬性值，從而去作一些運行時的邏輯處理。

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)
public @interface DbColumn {
public String name() default "fieldName";
public String setFuncName() default "setField";
public String getFuncName() default "getField";

public boolean defaultDBValue() default false;

}

@Documented:用於描述其它類型的annotation應該被做爲被標註的程序成員的公共API，所以能夠被例如javadoc此類的工具文檔化，Documented是一個標記註解，沒有成員。

Documented 註解代表這個註解應該被 javadoc工具記錄，默認狀況下javadoc是不包括註解的，但若是聲明註解時指定了 @Documented，則它會被 javadoc 之類的工具處理, 因此註解類型信息也會被包括在生成的文檔中。 

使用實例：

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DbColumn {
public String name() default "fieldName";
public String setFuncName() default "setField";
public String getFuncName() default "getField"; public boolean defaultDBValue() default false;

}

@Inherited：元註解是一個標記註解，闡述了某個被標註的類型是被繼承的。若是一個使用了@Inherited修飾的註解類型被用於一個class，則這個註解將被用於該class的子類。

　　注意：@Inherited 註解類型是被標註過的class的子類所繼承，類並不從它所實現的接口繼承註解，方法並不從它所重載的方法繼承註解。

　　當@Inherited 註解類型標註的註解Retention是RetentionPolicy.RUNTIME，則反射API加強了這種繼承性。若是咱們使用java.lang.reflect去查詢一個@Inherited 註解類型時，反射代碼檢查將展開工做：檢查class和其父類，直到發現指定的註解類型被發現，或者到達類繼承結構的頂層。

　　實例代碼：

@Inherited
public @interface MyParentObject { 
   boolean isInherited() default true;

   String doSomething() default "Do what?";

}

@MyParentObject
public Class MyChildObject {

}

正如你看到的,你不須要在實現類中定義接口方法. 由於使用 @Inherited標記，這些都自動繼承了.

自定義註解：

　　使用@interface自定義註解時，自動繼承了java.lang.annotation.Annotation接口，由編譯程序自動完成其餘細節。在定義註解時，不能繼承其餘的註解或接口。@interface用來聲明一個註解，其中的每個方法其實是聲明瞭一個配置參數。方法的名稱就是參數的名稱，返回值類型就是參數的類型（返回值類型只能是基本類型、Class、String、enum）。能夠經過default來聲明參數的默認值。

定義註解格式：

　　1.全部基本數據類型（int,float,boolean,byte,double,char,long,short)

　　2.String類型
　　3.Class類型
　　4.enum類型
　　5.Annotation類型
　　第一,只能用public或默認(default)這兩個訪問權修飾.例如,String value();這裏把方法設爲defaul默認類型；　 　
　　第二,參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和 String,Enum,Class,annotations等數據類型,以及這一些類型的數組.例如,String value();這裏的參數成員就爲String;　　

　　6.以上全部類型的數組

  註解類型裏面的參數該怎麼設定:

　　第三,若是隻有一個參數成員,最好把參數名稱設爲"value",後加小括號.例:下面的例子FruitName註解就只有一個參數成員。