博客園首頁新隨筆聯繫訂閱管理 隨筆

註解Annotation實現原理與自定義註解例子

什麼是註解？

      對於不少初次接觸的開發者來講應該都有這個疑問？Annontation是Java5開始引入的新特徵，中文名稱叫註解。它提供了一種安全的相似註釋的機制，用來將任何的信息或元數據（metadata）與程序元素（類、方法、成員變量等）進行關聯。爲程序的元素（類、方法、成員變量）加上更直觀更明瞭的說明，這些說明信息是與程序的業務邏輯無關，而且供指定的工具或框架使用。Annontation像一種修飾符同樣，應用於包、類型、構造方法、方法、成員變量、參數及本地變量的聲明語句中。
　　Java註解是附加在代碼中的一些元信息，用於一些工具在編譯、運行時進行解析和使用，起到說明、配置的功能。註解不會也不能影響代碼的實際邏輯，僅僅起到輔助性的做用。包含在 java.lang.annotation 包中。

 

註解的用處：

      一、生成文檔。這是最多見的，也是java 最先提供的註解。經常使用的有@param @return 等
      二、跟蹤代碼依賴性，實現替代配置文件功能。好比Dagger 2依賴注入，將來java開發，將大量註解配置，具備很大用處;
      三、在編譯時進行格式檢查。如@override 放在方法前，若是你這個方法並非覆蓋了超類方法，則編譯時就能檢查出。

 

註解的原理：

　　註解本質是一個繼承了Annotation的特殊接口，其具體實現類是Java運行時生成的動態代理類。而咱們經過反射獲取註解時，返回的是Java運行時生成的動態代理對象$Proxy1。經過代理對象調用自定義註解（接口）的方法，會最終調用AnnotationInvocationHandler的invoke方法。該方法會從memberValues這個Map中索引出對應的值。而memberValues的來源是Java常量池。

 

元註解：

java.lang.annotation提供了四種元註解，專門註解其餘的註解（在自定義註解的時候，須要使用到元註解）：
   @Documented –註解是否將包含在JavaDoc中
   @Retention –何時使用該註解
   @Target –註解用於什麼地方
   @Inherited – 是否容許子類繼承該註解

  1.）@Retention– 定義該註解的生命週期
  ●   RetentionPolicy.SOURCE : 在編譯階段丟棄。這些註解在編譯結束以後就再也不有任何意義，因此它們不會寫入字節碼。@Override, @SuppressWarnings都屬於這類註解。
  ●   RetentionPolicy.CLASS : 在類加載的時候丟棄。在字節碼文件的處理中有用。註解默認使用這種方式
  ●   RetentionPolicy.RUNTIME : 始終不會丟棄，運行期也保留該註解，所以可使用反射機制讀取該註解的信息。咱們自定義的註解一般使用這種方式。

  2.）Target – 表示該註解用於什麼地方。默認值爲任何元素，表示該註解用於什麼地方。可用的ElementType參數包括
  ● ElementType.CONSTRUCTOR:用於描述構造器
  ● ElementType.FIELD:成員變量、對象、屬性（包括enum實例）
  ● ElementType.LOCAL_VARIABLE:用於描述局部變量
  ● ElementType.METHOD:用於描述方法
  ● ElementType.PACKAGE:用於描述包
  ● ElementType.PARAMETER:用於描述參數
  ● ElementType.TYPE:用於描述類、接口(包括註解類型) 或enum聲明

 3.)@Documented–一個簡單的Annotations標記註解，表示是否將註解信息添加在java文檔中。

 4.)@Inherited – 定義該註釋和子類的關係
     @Inherited 元註解是一個標記註解，@Inherited闡述了某個被標註的類型是被繼承的。若是一個使用了@Inherited修飾的annotation類型被用於一個class，則這個annotation將被用於該class的子類。

 

常見標準的Annotation：

  1.）Override
      java.lang.Override是一個標記類型註解，它被用做標註方法。它說明了被標註的方法重載了父類的方法，起到了斷言的做用。若是咱們使用了這種註解在一個沒有覆蓋父類方法的方法時，java編譯器將以一個編譯錯誤來警示。
  2.）Deprecated
     Deprecated也是一種標記類型註解。當一個類型或者類型成員使用@Deprecated修飾的話，編譯器將不鼓勵使用這個被標註的程序元素。因此使用這種修飾具備必定的「延續性」：若是咱們在代碼中經過繼承或者覆蓋的方式使用了這個過期的類型或者成員，雖然繼承或者覆蓋後的類型或者成員並非被聲明爲@Deprecated，但編譯器仍然要報警。
 3.）SuppressWarnings
     SuppressWarning不是一個標記類型註解。它有一個類型爲String[]的成員，這個成員的值爲被禁止的警告名。對於javac編譯器來說，被-Xlint選項有效的警告名也一樣對@SuppressWarings有效，同時編譯器忽略掉沒法識別的警告名。
　　@SuppressWarnings("unchecked")

 

自定義註解：

自定義註解類編寫的一些規則:
  1. Annotation型定義爲@interface, 全部的Annotation會自動繼承java.lang.Annotation這一接口,而且不能再去繼承別的類或是接口.
  2. 參數成員只能用public或默認(default)這兩個訪問權修飾
  3. 參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和String、Enum、Class、annotations等數據類型,以及這一些類型的數組.
  4. 要獲取類方法和字段的註解信息，必須經過Java的反射技術來獲取 Annotation對象,由於你除此以外沒有別的獲取註解對象的方法
  5. 註解也能夠沒有定義成員, 不過這樣註解就沒啥用了
PS:自定義註解須要使用到元註解

 

自定義註解實例：

FruitName.java

1 import java.lang.annotation.Documented;
 2 import java.lang.annotation.Retention;
 3 import java.lang.annotation.Target;
 4 import static java.lang.annotation.ElementType.FIELD;
 5 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 6 
 7 /**
 8  * 水果名稱註解
 9  */
10 @Target(FIELD)
11 @Retention(RUNTIME)
12 @Documented
13 public @interface FruitName {
14     String value() default "";
15 }

  

FruitColor.java

1 import java.lang.annotation.Documented;
 2 import java.lang.annotation.Retention;
 3 import java.lang.annotation.Target;
 4 import static java.lang.annotation.ElementType.FIELD;
 5 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 6 
 7 /**
 8  * 水果顏色註解
 9  */
10 @Target(FIELD)
11 @Retention(RUNTIME)
12 @Documented
13 public @interface FruitColor {
14     /**
15      * 顏色枚舉
16      */
17     public enum Color{ BLUE,RED,GREEN};
18     
19     /**
20      * 顏色屬性
21      */
22     Color fruitColor() default Color.GREEN;
23 
24 }

 

FruitProvider.java

1 import java.lang.annotation.Documented;
 2 import java.lang.annotation.Retention;
 3 import java.lang.annotation.Target;
 4 import static java.lang.annotation.ElementType.FIELD;
 5 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 6 
 7 
 8 /**
 9  * 水果供應者註解
10  */
11 @Target(FIELD)
12 @Retention(RUNTIME)
13 @Documented
14 public @interface FruitProvider {
15     /**
16      * 供應商編號
17      */
18     public int id() default -1;
19     
20     /**
21      * 供應商名稱
22      */
23     public String name() default "";
24     
25     /**
26      * 供應商地址
27      */
28     public String address() default "";
29 }

 

FruitInfoUtil.java

1 import java.lang.reflect.Field;
 2 
 3 /**
 4  * 註解處理器
 5  */
 6 public class FruitInfoUtil {
 7     public static void getFruitInfo(Class<?> clazz){
 8         
 9         String strFruitName=" 水果名稱：";
10         String strFruitColor=" 水果顏色：";
11         String strFruitProvicer="供應商信息：";
12         
13         Field[] fields = clazz.getDeclaredFields();
14         
15         for(Field field :fields){
16             if(field.isAnnotationPresent(FruitName.class)){
17                 FruitName fruitName = (FruitName) field.getAnnotation(FruitName.class);
18                 strFruitName=strFruitName+fruitName.value();
19                 System.out.println(strFruitName);
20             }
21             else if(field.isAnnotationPresent(FruitColor.class)){
22                 FruitColor fruitColor= (FruitColor) field.getAnnotation(FruitColor.class);
23                 strFruitColor=strFruitColor+fruitColor.fruitColor().toString();
24                 System.out.println(strFruitColor);
25             }
26             else if(field.isAnnotationPresent(FruitProvider.class)){
27                 FruitProvider fruitProvider= (FruitProvider) field.getAnnotation(FruitProvider.class);
28                 strFruitProvicer=" 供應商編號："+fruitProvider.id()+" 供應商名稱："+fruitProvider.name()+" 供應商地址："+fruitProvider.address();
29                 System.out.println(strFruitProvicer);
30             }
31         }
32     }
33 }

 

Apple.java

1 import test.FruitColor.Color;
 2 
 3 /**
 4  * 註解使用
 5  */
 6 public class Apple {
 7     
 8     @FruitName("Apple")
 9     private String appleName;
10     
11     @FruitColor(fruitColor=Color.RED)
12     private String appleColor;
13     
14     @FruitProvider(id=1,name="陝西紅富士集團",address="陝西省西安市延安路89號紅富士大廈")
15     private String appleProvider;
16     
17     public void setAppleColor(String appleColor) {
18         this.appleColor = appleColor;
19     }
20     public String getAppleColor() {
21         return appleColor;
22     }
23     
24     public void setAppleName(String appleName) {
25         this.appleName = appleName;
26     }
27     public String getAppleName() {
28         return appleName;
29     }
30     
31     public void setAppleProvider(String appleProvider) {
32         this.appleProvider = appleProvider;
33     }
34     public String getAppleProvider() {
35         return appleProvider;
36     }
37     
38     public void displayName(){
39         System.out.println("水果的名字是：蘋果");
40     }
41 }

 

FruitRun.java

1 /**
2  * 輸出結果
3  */
4 public class FruitRun {
5     public static void main(String[] args) {
6         FruitInfoUtil.getFruitInfo(Apple.class);
7     }
8 }

 

運行結果是：

 水果名稱：Apple
 水果顏色：RED
 供應商編號：1 供應商名稱：陝西紅富士集團 供應商地址：陝西省西安市延安路89號紅富士大廈

 

參考連接：
[1]http://www.cnblogs.com/peida/archive/2013/04/26/3038503.html
[2]http://www.cnblogs.com/whoislcj/p/5671622.html
[3]http://blog.csdn.net/lylwo317/article/details/52163304

 

把每一件簡單的事情作好，就是不簡單；把每一件平凡的事情作好，就是不平凡！相信本身，創造奇蹟~~

分類: 0一、JAVA,0四、Spring

好文要頂 關注我 收藏該文  

賈樹丙
關注 - 5
粉絲 - 62

+加關注

14

0

« 上一篇：import static和import的區別（轉）
» 下一篇：pom.xml文件中，添加自定義參數Properties

posted @ 2017-05-03 14:36 賈樹丙 閱讀(51341) 評論(8) 編輯 收藏

 

 

如何判斷一個Class是不是Collection類型？

return Collection.class.isAssignableFrom(c)