Java註解(Annotation)詳解

標籤：bool   pac   row   des   ack   detail   位元組   例子   enum   

轉：http://blog.csdn.net/zen99t/article/details/49508447

（二）自訂註解

先上一段代碼有個大概的印象，再慢慢講解（其實代碼注釋已經講解地很清楚了）：

[java] view plain copy 

1. package diyDescription;  
2.   
3. import java.lang.annotation.Documented;  
4. import java.lang.annotation.ElementType;  
5. import java.lang.annotation.Inherited;  
6. import java.lang.annotation.Retention;  
7. import java.lang.annotation.RetentionPolicy;  
8. import java.lang.annotation.Target;  
9.   
10. @Target({ElementType.METHOD,ElementType.TYPE})  
11. @Retention(RetentionPolicy.RUNTIME)  
12. @Inherited  
13. @Documented  
14. public @interface Description { //使用@interface關鍵字定義註解  
15.   
16.     //成員以無參數無異常方式聲明  
17.     String desc();  
18.     /* String desc(int a); 
19.      * String desc() throws Exception; 
20.      * 都是錯誤的聲明方式 
21.      */  
22.       
23.     String author();  
24.     // String author() default ”“; 合法的聲明  
25.       
26.     //可以用default為成員指定一個預設值  
27.     int age() default 18;  
28.       
29.     /* 
30.      * 如果聲明：Map map(); 則會報錯： 
31.      * Invalid type Map for the annotation attribute Description.map;  
32.      * only primitive type, String, Class, annotation, enumeration  
33.      * are permitted or 1-dimensional arrays thereof 
34.      *  
35.      * 只有原始類型和String, Class, annotation, enumeration才可以 
36.      */  
37. }  

package diyDescription; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Inherited; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target({ElementType.METHOD,ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Inherited @Documented public @interface Description { //使用@interface關鍵字定義註解 //成員以無參數無異常方式聲明 String desc(); /* String desc(int a); * String desc() throws Exception; * 都是錯誤的聲明方式 */ String author(); // String author() default ""; 合法的聲明 //可以用default為成員指定一個預設值 int age() default 18; /* * 如果聲明：Map map(); 則會報錯： * Invalid type Map for the annotation attribute Description.map; * only primitive type, String, Class, annotation, enumeration * are permitted or 1-dimensional arrays thereof * * 只有原始類型和String, Class, annotation, enumeration才可以 */ }

1.自訂註解的文法要求首先看上面代碼的下面部分： 1.使用@interface關鍵字定義註解，注意關鍵字的位置 2.成員以無參數無異常的方式聲明，注意區別一般類成員變數的聲明 3.可以使用default為成員指定一個預設值，如上所示 4.成員類型是受限的，合法的類型包括原始類型以及String、Class、Annotation、Enumeration （JAVA的基礎資料型別 (Elementary Data Type)有8種：byte(位元組)、short(短整型)、int(整數型)、long(長整型)、float(單精確度浮點數類型)、double(雙精確度浮點數類型)、char(字元類型)、boolean(布爾類型） 5.註解類可以沒有成員，沒有成員的註解稱為標識註解，例如JDK註解中的@Override、@Deprecation  6.如果註解只有一個成員，並且把成員取名為value()，則在使用時可以忽略成員名和賦值號“=” ,例如JDK註解的@SuppviseWarnings ；如果成員名不為value，則使用時需指明成員名和賦值號”=”，例子代碼如下： [java] view plain copy 

1. package jtzeng;  
2. import java.lang.annotation.ElementType;  
3. import java.lang.annotation.Target;  
4. @Target({ElementType.TYPE})  
5. public @interface SingleValue1 {  
6.     String desc();  
7. }  
8.   
9.   
10. package jtzeng;  
11. import java.lang.annotation.ElementType;  
12. import java.lang.annotation.Target;  
13. @Target({ElementType.METHOD})  
14. public @interface SingleValue2 {  
15.     String value();  
16. }  
17.   
18.   
19. package jtzeng;  
20. @SingleValue1( desc = “這是TYPE註解” )  //使用時需指明成員名和賦值號”=”  
21. public class Test {  
22.     @SingleValue2(“這是METHOD註解”)    //使用時可以忽略成員名和賦值號“=”  
23.     public void print() {  
24.         System.out.println();  
25.     }  
26. }   

package jtzeng; import java.lang.annotation.ElementType; import java.lang.annotation.Target; @Target({ElementType.TYPE}) public @interface SingleValue1 { String desc(); } package jtzeng; import java.lang.annotation.ElementType; import java.lang.annotation.Target; @Target({ElementType.METHOD}) public @interface SingleValue2 { String value(); } package jtzeng; @SingleValue1( desc = "這是TYPE註解" ) //使用時需指明成員名和賦值號"=" public class Test { @SingleValue2("這是METHOD註解") //使用時可以忽略成員名和賦值號“=” public void print() { System.out.println(); } }

2.元註解         何為元註解？就是註解的註解，就是給你自己定義的註解添加註解，你自己定義了一個註解，但你想要你的註解有什麼樣的功能，此時就需要用元註解對你的註解進行說明了。        元註解有4個，如下代碼的上面部分： 2.1. @Target即註解的範圍，用於說明註解的使用範圍（即註解可以用在什麼地方，比如類的註解，方法註解，成員變數註解等等） 取值：          ElemenetType.CONSTRUCTOR—————————-構造器聲明 
          ElemenetType.FIELD ————————————–域聲明（包括 enum 執行個體） 
          ElemenetType.LOCAL_VARIABLE————————- 局部變數聲明 
          ElemenetType.METHOD ———————————-方法聲明 
          ElemenetType.PACKAGE ——————————— 包聲明 
          ElemenetType.PARAMETER ——————————參數聲明 
          ElemenetType.TYPE————————————— 類，介面（包括註解類型）或enum聲明 使用執行個體：        首先定義一個Description註解， [java] view plain copy 

1. package jtzeng;  
2. import java.lang.annotation.ElementType;  
3. import java.lang.annotation.Target;  
4.   
5. @Target({ElementType.TYPE,ElementType.FIELD})  
6. public @interface Description {   
7.   
8.     String desc();  
9.     String author();  
10.     int age() default 21;  
11. }   

package jtzeng; import java.lang.annotation.ElementType; import java.lang.annotation.Target; @Target({ElementType.TYPE,ElementType.FIELD}) public @interface Description { String desc(); String author(); int age() default 21; }

        然後再定義一個Test類進行測試，為了能讓大家看出錯誤，此處用圖片給出。        可以發現，因為上面定義註解時候，@Target只包含了 ElemenetType.TYPE和 ElemenetType.FIELD，所以在類和聲明中註解是可以的，而在方法上註解會報錯。 2.2. @Retention描述的註解在什麼範圍內有效。 取值有：          RetentionPolicy.SOURCE————————–只在源碼顯示，編譯時間會丟失
          RetentionPolicy.CLASS—————————–編譯時間會記錄到class中，運行時忽略 
          RetentionPolicy.RUNTIME————————- 運行時存在，可以通過反射讀取 使用執行個體：         下面給出的是簡單的定義，至於會有什麼不同的效果，往後的 解析註解部分會講解。 [java] view plain copy 

1. package jtzeng;  
2. import java.lang.annotation.Retention;  
3. import java.lang.annotation.RetentionPolicy;  
4.   
5. @Retention(RetentionPolicy.RUNTIME)     //運行時存在，可以通過反射讀取  
6. //@Retention(RetentionPolicy.SOURCE)    //只在源碼顯示，編譯時間會丟失  
7. //@Retention(RetentionPolicy.CLASS)     //編譯時間會記錄到class中，運行時忽略   
8. public @interface Description {   
9.     String desc();  
10.     String author() default “JTZeng”;  
11.     int age() default 21;  
12. }  

package jtzeng; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @Retention(RetentionPolicy.RUNTIME) //運行時存在，可以通過反射讀取 //@Retention(RetentionPolicy.SOURCE) //只在源碼顯示，編譯時間會丟失 //@Retention(RetentionPolicy.CLASS) //編譯時間會記錄到class中，運行時忽略 public @interface Description { String desc(); String author() default "JTZeng"; int age() default 21; }

2.3. @Inherited1. 是一個標記註解，沒有成員，表示允許子類繼承該註解，也就是說如果一個使用了@Inherited修飾的註解被用於一個class時，則這個註解將被該class的子類繼承擁有2. 使用了@Inherited修飾的註解只能被子類所繼承，並不可以從它所實現的介面繼承3. 子類繼承父類的註解時，並不能從它所重載的方法繼承註解 使用執行個體： [java] view plain copy 

1. package jtzeng;  
2. import java.lang.annotation.Inherited;  
3.   
4. @Inherited  
5. public @interface Description {   
6.     String desc();  
7.     String author() default “JTZeng”;  
8.     int age() default 21;  
9. }  

package jtzeng; import java.lang.annotation.Inherited; @Inherited public @interface Description { String desc(); String author() default "JTZeng"; int age() default 21; }

2.4. @Documented@Documented是一個標記註解，沒有成員。用於描述其它類型的annotation應該被作為被標註的程式成員的公用API，因此可以被例如javadoc此類的工具文檔化。（有點抽象，看例子吧） 使用執行個體： [java] view plain copy 

1. /* 
2.  * 測試@Documented的功能 
3.  */  
4. package jtzeng;  
5. import java.lang.annotation.Documented;  
6. import java.lang.annotation.ElementType;  
7. import java.lang.annotation.Inherited;  
8. import java.lang.annotation.Retention;  
9. import java.lang.annotation.RetentionPolicy;  
10. import java.lang.annotation.Target;  
11. @Target({ElementType.METHOD,ElementType.TYPE})  
12. @Retention(RetentionPolicy.RUNTIME)  
13. @Inherited  
14. @Documented  
15. public @interface Description {   
16.     String desc();  
17.     String author() default “JTZeng”;  
18.     int age() default 21;  
19. }  
20.   
21. /* 
22.  * 定義一個Test測試類別，類和方法都有註解 
23.  */  
24. package jtzeng;  
25. @Description(desc=“這是TYPE註解”,author=“JTZeng”,age=21)  
26. public class Test {  
27.     private String field = “自訂註解”;  
28.     @Description(desc=“這是METHOD註解”,author=“JTZeng”,age=21)  
29.     public void print() {  
30.         System.out.println(field);  
31.     }  
32. }  

/* * 測試@Documented的功能 */ package jtzeng; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Inherited; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target({ElementType.METHOD,ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Inherited @Documented public @interface Description { String desc(); String author() default "JTZeng"; int age() default 21; } /* * 定義一個Test測試類別，類和方法都有註解 */ package jtzeng; @Description(desc="這是TYPE註解",author="JTZeng",age=21) public class Test { private String field = "自訂註解"; @Description(desc="這是METHOD註解",author="JTZeng",age=21) public void print() { System.out.println(field); } }

        然後，在Eclipse中，右鍵項目名稱，選擇Export，選擇Java——>javadoc，下一步，完成。看結果，左邊是添加了@Documented的效果，右邊是沒有添加的效果。  自訂註解結束~~

Java註解(Annotation)詳解