深入淺析JAVA註解

標籤：java ee   屬性   break   val   分享   分類   href   javaee   sys   

註解，相信大家都會知道，像@requestMapping，@Resource，@Controller等等的一些註解，大家都用過，那麼，他的工具類你用過嗎？下面就和大家一起來分享一下註解工具類。

 

註解的作用：

             1、產生文檔。這是最常見的，也是Java 最早提供的註解。常用的有@see @param @return 等

             2、跟蹤代碼依賴性，實現替代設定檔功能。比較常見的是spring 2.5 開始的基於註解配置。作用就是減少配置。現在的架構基本都使用了這種配置來減少設定檔的數量。以後java的程式開發，最多的也將實現註解配置，具有很大用處;

             3、在編譯時間進行格式檢查。如@override 放在方法前，如果你這個方法並不是覆蓋了超類方法，則編譯時間就能檢查出。

 

 

註解的分類：

　　根據註解使用方法和用途，我們可以將Annotation分為三類：
　　　　1.JDK內建系統註解
　           2.元註解
　　       3.自訂註解

 

 系統內建標準註解：

　　註解的文法比較簡單，除了@符號的使用外，他基本與Java固有的文法一致，Java中內建三個標準註解，定義在java.lang中：
　　　　@Override：用於修飾此方法覆蓋了父類的方法；
　　　　@Deprecated：用於修飾已經過時的方法；
　　　　@SuppressWarnnings:用於通知java編譯器禁止特定的編譯警告。

下面我們依次看看三個內建標準註解的作用和使用情境。

 

@Override，限定重寫父類方法：

　　@Override是一個標記註解類型，它被用作標註方法。它說明了被標註的方法重載了父類的方法，起到了斷言的作用。如果我們使用了這種Annotation在一個沒有覆蓋父類方法的方法時，java編譯器將以一個編譯錯誤來警示。這個annotaton常常在我們試圖覆蓋父類方法而又寫錯了方法名時發揮威力。使用方法極其簡單：在使用此annotation時只要在被修飾的方法前面加上@Override即可。@Override註解只能用於方法，不能用於其他程式元素。

@Deprecated，標記已淘汰：

　　同樣Deprecated也是一個標記註解。當一個類型或者類型成員使用@Deprecated修飾的話，編譯器將不鼓勵使用這個被標註的程式元素。而且這種修飾具有一定的 “延續性”：如果我們在代碼中通過繼承或者覆蓋的方式使用了這個過時的類型或者成員，雖然繼承或者覆蓋後的類型或者成員並不是被聲明為@Deprecated，但編譯器仍然要警示。

　　值得注意，@Deprecated這個annotation類型和javadoc中的 @deprecated這個tag是有區別的：前者是java編譯器識別的，而後者是被javadoc工具所識別用來產生文檔（包含程式成員為什麼已經過時、它應當如何被禁止或者替代的描述）。

在java5.0，java編譯器仍然像其從前版本那樣尋找@deprecated這個javadoc tag，並使用它們產生警告資訊。但是這種狀況將在後續版本中改變，我們應在現在就開始使用@Deprecated來修飾過時的方法而不是 @deprecated javadoctag。

 

@SuppressWarnnings，抑制編譯器警告：

　　@SuppressWarnings被用於有選擇的關閉編譯器對類、方法、成員變數、變數初始化的警告。在java5.0，sun提供的javac編譯器為我們提供了-Xlint選項來使編譯器對合法的程式碼提出警告，此種警告從某種程度上代表了程式錯誤。例如當我們使用一個generic collection類而又沒有提供它的類型時，編譯器將提示出"uncheckedwarning"的警告。通常當這種情況發生時，我們就需要尋找引起警告的代碼。如果它真的表示錯誤，我們就需要糾正它。例如如果警告資訊表明我們代碼中的switch語句沒有覆蓋所有可能的case，那麼我們就應增加一個預設的case來避免這種警告。
　　有時我們無法避免這種警告，例如，我們使用必須和非generic的舊代碼互動的generic collection類時，我們不能避免這個unchecked warning。此時@SuppressWarning就要派上用場了，在調用的方法前增加@SuppressWarnings修飾，告訴編譯器停止對此方法的警告。
　　@SuppressWarning不是一個標記註解。它有一個類型為String[]的成員，這個成員的值為被禁止的警告名。對於javac編譯器來講，被-Xlint選項有效警告名也同樣對@SuppressWarings有效，同時編譯器忽略掉無法識別的警告名。

 SuppressWarnings註解的常見參數值的簡單說明：

　　　　1.deprecation：使用了不贊成使用的類或方法時的警告；
　　　　2. unchecked：執行了未檢查的轉換時的警告，例如當使用集合時沒有用泛型        (Generics) 來指定集合儲存的類型;
　　　　3. fallthrough：當switch程式塊直接通往下一種情況而沒有 Break 時的警告;
　　　　4. path：在類路徑、源檔案路徑等中有不存在的路徑時的警告;
　　　　5. serial：當在可序列化的類上缺少serialVersionUID定義時的警告;
　　　　6. finally：任何finally子句不能正常完成時的警告;
　　　　7. all：關於以上所有情況的警告。

以下是JDK內建系統註解的一個簡單應用：

 

元註解：

　　元註解的作用就是負責註解其他註解。Java5.0定義了4個標準的meta-annotation類型，它們被用來提供對其它annotation類型作說明。Java5.0定義的元註解：
　　　　[email protected],
　　　　[email protected],
　　　　[email protected],
　　　　[email protected]
　　這些類型和它們所支援的類在java.lang.annotation包中可以找到。下面我們看一下每個元註解的作用和相應分參數的使用說明。

　@Target：

　　　@Target說明了Annotation所修飾的物件範圍：Annotation可被用於 packages、types（類、介面、枚舉、Annotation類型）、類型成員（方法、構造方法、成員變數、枚舉值）、方法參數和本地變數（如迴圈變數、catch參數）。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標。

　　作用：用於描述註解的使用範圍（即：被描述的註解可以用在什麼地方）

　　取值(ElementType)有：

　　　　1.CONSTRUCTOR：用於描述構造器
　　　　2.FIELD：用於描述域
　　       3.LOCAL_VARIABLE：用於描述局部變數
　　　　4.METHOD：用於描述方法
　　　　5.PACKAGE：用於描述包
　　　    6.PARAMETER：用於描述參數
　　       7.TYPE：用於描述類、介面(包括註解類型)或enum聲明

@Retention：

　　@Retention定義了該Annotation被保留的時間長短：某些Annotation僅出現在原始碼中，而被編譯器丟棄；而另一些卻被編譯在class檔案中；編譯在class檔案中的Annotation可能會被虛擬機器忽略，而另一些在class被裝載時將被讀取（請注意並不影響class的執行，因為Annotation與class在使用上是被分離的）。使用這個meta-Annotation可以對 Annotation的“生命週期”限制。

　　作用：表示需要在什麼層級儲存該注釋資訊，用於描述註解的生命週期（即：被描述的註解在什麼範圍內有效）

　　取值（RetentionPoicy）有：

　　　　1.SOURCE：在源檔案中有效（即源檔案保留）
　　       2.CLASS：在class檔案中有效（即class保留）
　　       3.RUNTIME：在運行時有效（即運行時保留）

　　Retentionmeta-annotation類型有唯一的value作為成員，它的取值來自java.lang.annotation.RetentionPolicy的枚舉類型值。Column註解的的RetentionPolicy的屬性值是RUTIME,這樣註解處理器可以通過反射，擷取到該註解的屬性值，從而去做一些運行時的邏輯處理                                                                                                                                                                                                                                                                                                                                                                                                                                                              

@Documented:

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

@Inherited：

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

　　注意：@Inherited annotation類型會被標註過的class的子類所繼承。類並不從它所實現的介面繼承annotation，方法並不從它所重載的方法繼承annotation。

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

 

自訂註解：

　　使用@interface自訂註解時，自動繼承了java.lang.annotation.Annotation介面，由編譯器自動完成其他細節。在定義註解時，不能繼承其他的註解或介面。@interface用來聲明一個註解，其中的每一個方法實際上是聲明了一個配置參數。方法的名稱就是參數的名稱，傳回值類型就是參數的類型（傳回值類型只能是基本類型、Class、String、enum）。可以通過default來聲明參數的預設值。

　　定義註解格式：
　　public @interface 註解名 {定義體}

　　註解參數的可支援資料類型：

　　　　1.所有基礎資料型別 (Elementary Data Type)（int,float,boolean,byte,double,char,long,short)
　　　　2. String類型
　　　　3. Class類型
　　　　4. enum類型
　　　　5. Annotation類型
　　　　6. 以上所有類型的數組

　　Annotation類型裡面的參數該怎麼設定：
　　第一, 只能用public或預設(default)這兩個訪問權修飾。例如，String value();這裡把方法設為defaul預設類型；　 　
　　第二, 參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基礎資料型別 (Elementary Data Type)和String, Enum, Class, annotations等資料類型，以及這一些類型的數組。例如String value();這裡的參數成員就為String；
　　第三, 如果只有一個參數成員，最好把參數名稱設為"value"，後加小括弧。例如下面的例子FruitName註解就只有一個參數成員。

 

以下還有一個通過反射機制來擷取註解值的一個實現可以供大家來深入的學習註解以及理解JAVA中的反射機制

首先是是自訂註解HelloAnnotation2.java

package Test;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE,ElementType.METHOD,ElementType.PARAMETER})public @interface HelloAnnotation2 {String color() default "red";String age();}

　　HelloAnnotation3.java

package Test;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE,ElementType.FIELD})public @interface HelloAnnotation3 {String getAddress();String tel() default "110";}

　　測試類別 AnnotationTest.java

package Test;import java.lang.reflect.Field;import java.lang.reflect.InvocationTargetException;import java.lang.reflect.Method;/** *  * 功能：測試Annotation * 時間：2016年12月12日 上午9:07:28 * 茹子赫 */public class AnnotationTest {@HelloAnnotation2(age="2")public static String testColor(String color){System.out.println(color);return color;}@HelloAnnotation3(getAddress="北京市海澱區")String address;public static void main(String[] args) {//擷取方法上的註解值Method[] methods = AnnotationTest.class.getDeclaredMethods();if(methods != null){for (Method method : methods) {HelloAnnotation2 anntotion2 = method.getAnnotation(HelloAnnotation2.class);if(anntotion2 == null){continue;}Method[] me = anntotion2.annotationType().getDeclaredMethods();for (Method meth : me) {try {String color = (String) meth.invoke(anntotion2, null);System.out.println("擷取到方法上的註解值:"+color);} catch (IllegalAccessException e) {e.printStackTrace();} catch (IllegalArgumentException e) {e.printStackTrace();} catch (InvocationTargetException e) {e.printStackTrace();}}}}//擷取欄位上的註解值AnnotationTest noon = new AnnotationTest();Field[] field = AnnotationTest.class.getDeclaredFields();if(field != null){for (Field fie : field) {if(!fie.isAccessible()){fie.setAccessible(true);}HelloAnnotation3 annon = fie.getAnnotation(HelloAnnotation3.class);Method[] meth = annon.annotationType().getDeclaredMethods();for (Method me : meth) {if(!me.isAccessible()){me.setAccessible(true);}try {fie.set(noon, me.invoke(annon, null));System.out.println("擷取到欄位上的註解值:"+fie.get(noon));} catch (IllegalArgumentException e) {// TODO Auto-generated catch blocke.printStackTrace();} catch (IllegalAccessException e) {// TODO Auto-generated catch blocke.printStackTrace();} catch (InvocationTargetException e) {// TODO Auto-generated catch blocke.printStackTrace();}}}}}}

　　運行結果：

擷取到方法上的註解值:red擷取到方法上的註解值:2擷取到欄位上的註解值:北京市海澱區擷取到欄位上的註解值:110

　　

深入淺析JAVA註解