Java自定義註解之元註解(meta-annotation)Target、Retention、Documented、Inherited介紹
元註解:
元註解的作用就是負責註解其他(如:自定義)註解,用來對其它 annotation型別作說明。Java定義了4個標準的meta-annotation型別:
這些型別和它們所支援的類在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
}
@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註解就只有一個引數成員。