元註解的深度理解 自定義註解 |
註解
爲元數據加以說明的 補充文字，用於解釋包,類, 構造器, 方法, 成員變量, 參數, 局部變量的聲明,
常見的幾種註解（√）
@Override
標明 定義的方法爲重寫的方法，會自動檢測是否爲合法的重寫，如果不是，報編譯錯誤！！！
@Deprecated
當我們設計的方法不再適用，但又不能刪除，需要做一些提醒給
後面的調用者，可以考慮使用註解方式，會自動添加刪除線
@SuppressWarnings 忽略警告
（一）自定義註解
1、自定義註解：
<1>使用@interface自定義註解時，自動繼承java.lang.annotation.Annotation接口
<2>由編譯程序自動完成其他細節。在定義註解時，不能繼承其他的註解或接口。
<3>@interface用來聲明一個註解，其中的每一個方法實際上是聲明瞭一個配置參數。
<4>方法的名稱就是參數的名稱，
返回值類型就是參數的類型（返回值類型只能是基本類型、Class、String、enum）。
<5>可以通過default來聲明參數的默認值。
2自定義註解語法如下：
[修飾符] @interface 註解名{
類型 變量名() default 默認值;
}
注意：默認值可以省略、
使用註解語法：
在修飾的包、類、方法、屬性等上面：
@註解類名(變量名=值)
注意： 如果變量名 爲value，則 可以簡寫 ：@註解類名(值)
如果定義時有默認值，可以簡寫：@註解類名
（二）、元註解
1、定義：
註解其他註解。被用來提供對其它 annotation類型作說明。
Java5.0定義了4個標準的meta-annotation類型（元註解）
這些類型和它們所支持的類在java.lang.annotation包中可以找到
每個元註解的作用和相應參數的使用說明。
1.@Target, 2.@Retention, 3.@Documented, 4.@Inherited
2、四個元註解的描述和參數：
@Target：
(1)描述：
用於描述註解的使用範圍（即：被描述的註解可以用在什麼地方）
說明了Annotation所修飾的對象範圍：
<1>Annotation可被用於 packages、types（類、接口、枚舉、 Annotation類型）
<2>類型成員（方法、構造方法、成員變量、枚舉值）
<3>方法參數和本地變量（如循環變量、catch參數）
<4>在Annotation類型的聲明中使用了target可更加明晰其修飾的目標。
(2)取值(ElementType)有：
1.CONSTRUCTOR:用於描述構造器
2.FIELD:用於描述域
3.LOCAL_VARIABLE:用於描述局部變量
4.METHOD:用於描述方法
5.PACKAGE:用於描述包
6.PARAMETER:用於描述參數
7.TYPE:用於描述類、接口(包括註解類型) 或enum聲明
(3)舉例如下：
註解Table 可以用於註解類、接口(包括註解類型) 或enum聲明,
而註解NoDBColumn僅可用於註解類的成員變量。
代碼如下
@Target(ElementType.TYPE)
public @interface Table{
/**
* 數據表名稱註解，默認值爲類名稱
* @return
*/
public String tableName() default "className";
}
@Target(ElementType.FIELD)
public @interface NoDBColumn {
}
@Retention：
（1）描述：
作用：表示需要在什麼級別保存該註釋信息，
用於描述註解的生命週期（即：被描述的註解在什麼範圍內有效）
<1>@Retention定義了該Annotation被保留的時間長短：
某些Annotation僅出現在源代碼中，而被編譯器丟棄；
<2>而另一些卻被編譯在class文件中；編譯在class文件中的
Annotation可能會被虛擬機忽略，而另一些在class被裝載時將被讀取
<3>（請注意並不影響class的執行，因爲Annotation與class在使用上是被分離的）。
<4>使用這個meta-Annotation可以對 Annotation的“生命週期”限制。
(2)取值（RetentionPoicy）有：
1.SOURCE:在源文件中有效（即源文件保留）
2.CLASS:在class文件中有效（即class保留）
3.RUNTIME:在運行時有效（即運行時保留）
Retention meta-annotation類型有唯一的value作爲成員，它的取值來自
java.lang.annotation.RetentionPolicy的枚舉類型值。
具體實例如下：
Column註解的的RetentionPolicy的屬性值是RUTIME,
這樣註解處理器可以通過反射，獲取到該註解的屬性值，從而去做一些運行時的邏輯處理
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
public String name() default "fieldName";
public String setFuncName() default "setField";
public String getFuncName() default "getField";
public boolean defaultDBValue() default false;
}
@Documented:
(1)描述：
@Document 能否在文檔註釋顯示
用於描述其它類型的annotation應該被作爲被標註的程序成員的公共API，
因此可以被例如javadoc此類的工具文檔化。Documented是一個標記註解，沒有成員。
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
public String name() default "fieldName";
public String setFuncName() default "setField";
public String getFuncName() default "getField";
public boolean defaultDBValue() default false;
}
@Inherited：
<1>@Inherited 元註解是一個標記註解
<2>@Inherited闡述了某個被標註的類型是被繼承的。
<3>如果一個使用了@Inherited修飾的annotation類型被用於一個class，
則這個annotation將被用於該class的子類。
<4>注意：@Inherited annotation類型是被標註過的class的子類所繼承。
類並不從它所實現的接口繼承annotation，方法並不從它所重載的方法繼承annotation。
<5>當@Inherited annotation類型標註的annotation的Retention是
RetentionPolicy.RUNTIME，則反射API增強了這種繼承性。
<6>如果我們使用java.lang.reflect去查詢一個@Inherited annotation類型的
annotation時、反射代碼檢查將展開工作：檢查class和其父類，
直到發現指定的annotation類型被發現，或者到達類繼承結構的頂層。
實現如下：
@Inherited
public @interface Greeting {
public enum FontColor{ BULE,RED,GREEN};
String name();
FontColor fontColor() default FontColor.GREEN;
}