JAVA 註解的幾大做用及使用方法詳解【轉】

java 註解，從名字上看是註釋，解釋。但功能卻不只僅是註釋那麼簡單。註解（Annotation） 爲咱們在代碼中添加信息提供了一種形式化的方法，是咱們能夠在稍後 某個時刻方便地使用這些數據（經過 解析註解 來使用這些數據），常見的做用有如下幾種：

1.生成文檔。這是最多見的，也是java 最先提供的註解。經常使用的有@see @param @return 等；

2.跟蹤代碼依賴性，實現替代配置文件功能。比較常見的是spring 2.5 開始的基於註解配置。做用就是減小配置。如今的框架基本都使用了這種配置來減小配置文件的數量；

3.在編譯時進行格式檢查。如@Override放在方法前，若是你這個方法並非覆蓋了超類方法，則編譯時就能檢查出；

 

包 java.lang.annotation 中包含全部定義自定義註解所需用到的原註解和接口。如接口 java.lang.annotation.Annotation 是全部註解繼承的接口,而且是自動繼承，不須要定義時指定，相似於全部類都自動繼承Object。

 

該包同時定義了四個元註解，Documented,Inherited,Target(做用範圍，方法，屬性，構造方法等),Retention(生命範圍，源代碼，class,runtime)。下面將在實例中逐個講解他們的做用，及使用方法。

 

Inherited : 在您定義註解後並使用於程序代碼上時，預設上父類別中的註解並不會被繼承至子類別中，您能夠在定義註解時加上java.lang.annotation.Inherited 限定的Annotation，這讓您定義的Annotation型別被繼承下來。注意註解繼承只針對class 級別註解有效（這段建議看徹底文後在來回顧）。 多說無益，下面就一步步從零開始建一個咱們本身的註解。

 

創建第一個註解

package com.tmser.annotation;

public @interface TestA {

//這裏定義了一個空的註解，它能幹什麼呢。我也不知道，但他能用。

}

 

在下面這個程序中使用它：

 

package com.tmser.annotation;

 

import java.util.HashMap;

import java.util.Map;

 

@TestA    //使用了類註解

public class UserAnnotation {

    

    @TestA //使用了類成員註解

    private Integer age;

    

    @TestA //使用了構造方法註解

    public UserAnnotation(){

        

    }

    @TestA //使用了類方法註解

    public void a(){

        @TestA //使用了局部變量註解

        Map m = new HashMap(0);

    }

    

    public void b(@TestA Integer a){ //使用了方法參數註解

        

    }

}

編譯沒有報錯，ok，一個註解實驗完成。這個註解也太簡單了吧，好像什麼信息也不能傳遞。別急下面就來一步步完善它，也該四位元註解依次開始上場了。

四個元註解分別是：@Target,@Retention,@Documented,@Inherited ，再次強調下元註解是java API提供，是專門用來定義註解的註解，其做用分別以下：

      @Target 表示該註解用於什麼地方，可能的值在枚舉類 ElemenetType 中，包括： 

          ElemenetType.CONSTRUCTOR----------------------------構造器聲明 

          ElemenetType.FIELD --------------------------------------域聲明（包括 enum 實例） 

          ElemenetType.LOCAL_VARIABLE------------------------- 局部變量聲明 

          ElemenetType.METHOD ----------------------------------方法聲明 

          ElemenetType.PACKAGE --------------------------------- 包聲明 

          ElemenetType.PARAMETER ------------------------------參數聲明 

          ElemenetType.TYPE--------------------------------------- 類，接口（包括註解類型）或enum聲明 

           

     @Retention 表示在什麼級別保存該註解信息。可選的參數值在枚舉類型 RetentionPolicy 中，包括： 

          RetentionPolicy.SOURCE ---------------------------------註解將被編譯器丟棄 

          RetentionPolicy.CLASS -----------------------------------註解在class文件中可用，但會被VM丟棄 

          RetentionPolicy.RUNTIME VM-------將在運行期也保留註釋，所以能夠經過反射機制讀取註解的信息。 

           

      @Documented 將此註解包含在 javadoc 中 ，它表明着此註解會被javadoc工具提取成文檔。在doc文檔中的內容會由於此註解的信息內容不一樣而不一樣。至關與@see,@param 等。

       

      @Inherited 容許子類繼承父類中的註解。

 

學習最忌好高騖遠，最重要的仍是動手實踐，咱們就一個一個來實驗。

 

第一個：@Target，動手在前面咱們編寫的註解上加上元註解。

package com.tmser.annotation;

 

import java.lang.annotation.ElementType;

import java.lang.annotation.Target;

 

@Target(ElementType.PACKAGE)  //與前面定義的註解不一樣的地方，這裏使用了元註解Target

public @interface TestA {

 

}

ctrl+ s 保存，今天電腦比較給力，咱們的測試類那邊立馬出現了一堆錯誤，除了類註解。我想到這，聰明的你馬上明白了這個元註解的意義了。是否是想固然的偷起懶來了。？難道還有意外？細心的朋友應該發現了，咱們的測試類少了一個屬性沒用，就是ElemenetType.PACKAGE。在咱們的註解加上這個屬性的元註解後，咱們測試程序的元註解所有陣亡，不對，還有一個沒加呢，好加上。package 包，想固然是加載 package 前面。即

@TestA package com.tmser.annotation;

 

什麼也報錯。這就搞不明白了，不加在這加哪去呢。我也不知道了，不過這是編譯錯誤，咱們的eclipse 將錯誤給咱們指出了，就是 Package annotations must be in file package-info.java ，e 文雖然很差，但這個簡單的仍是難不倒幾我的的，package 註解必須定義在 package-info.java 中。package-info 又是什麼東西，好了爲節省大家的時間幫你百度好了（在另外一篇個人另外一篇博文裏面，本身找吧，咔咔）。ok,到此 target 元註解就所有完成了。

 

第二個元註解： @Retention 參數 RetentionPolicy。有了前面的經驗這個註解理解起來就簡單多了，而且幸運的是這個註解尚未特殊的屬性值。 簡單演示下如何使用：

package com.tmser.annotation;

 

import java.lang.annotation.ElementType;

import java.lang.annotation.Target;

 

@Target(ElementType.PACKAGE)

@Retention(RetentionPolicy.RUNTIME)

 

public @interface TestA {

 

}

第三和第四個元註解就再也不舉例了。比較簡單，也沒有值，相信看過上面的解釋也就清楚了。下面咱們仍是繼續來深刻的探討下註解的使用。上面的例子都很是簡單，註解連屬性都沒有。ok，下面咱們就來定義一個有屬性的註解，並在例子程序中獲取都註解中定義的值。

 

開始以前將下定義屬性的規則：

        @interface用來聲明一個註解，其中的每個方法其實是聲明瞭一個配置參數。方法的名稱就是參數的名稱，返回值類型就是參數的類型（返回值類型只能是基本類型、Class、String、enum）。能夠經過default來聲明參數的默認值。

 

代碼：

 

@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})

@Retention(RetentionPolicy.RUNTIME)

public @interface TestA {

String name();

int id() default 0;

Class gid();

}

 

下面改下咱們的測試類：

package com.tmser.annotation;

 

import java.util.HashMap;

import java.util.Map;

 

 

@TestA(name="type",gid=Long.class) //類成員註解

public class UserAnnotation {

@TestA(name="param",id=1,gid=Long.class) //類成員註解

private Integer age;

@TestA (name="construct",id=2,gid=Long.class)//構造方法註解

public UserAnnotation(){

}

@TestA(name="public method",id=3,gid=Long.class) //類方法註解

public void a(){

Map m = new HashMap(0);

}

@TestA(name="protected method",id=4,gid=Long.class) //類方法註解

protected void b(){

Map m = new HashMap(0);

}

@TestA(name="private method",id=5,gid=Long.class) //類方法註解

private void c(){

Map m = new HashMap(0);

}

public void b(Integer a){ 

}

}

 

下面到了最重要的一步了，就是如何讀取咱們在類中定義的註解。只要讀取出來了使用的話就簡單了。

package com.tmser.annotation;

 

import java.lang.annotation.Annotation;

import java.lang.reflect.Constructor;

import java.lang.reflect.Method;

 

public class ParseAnnotation {

 

public static void parseTypeAnnotation() throws ClassNotFoundException {  

        Class clazz = Class.forName("com.tmser.annotation.UserAnnotation"); 

        

        Annotation[] annotations = clazz.getAnnotations();  

        for (Annotation annotation : annotations) {  

        TestA testA = (TestA)annotation;

            System.out.println("id= ""+testA.id()+""; name= ""+testA.name()+""; gid = "+testA.gid());  

        }  

    } 

 

public static void parseMethodAnnotation(){

Method[] methods = UserAnnotation.class.getDeclaredMethods();  

        for (Method method : methods) {  

             

            boolean hasAnnotation = method.isAnnotationPresent(TestA.class);  

            if (hasAnnotation) {  

                 

            TestA annotation = method.getAnnotation(TestA.class);  

                System.out.println("method = " + method.getName()  

                        + " ; id = " + annotation.id() + " ; description = "  

                        + annotation.name() + "; gid= "+annotation.gid());  

            }  

        }  

}

 

public static void parseConstructAnnotation(){

Constructor[] constructors = UserAnnotation.class.getConstructors();  

        for (Constructor constructor : constructors) { 

         

            boolean hasAnnotation = constructor.isAnnotationPresent(TestA.class);  

            if (hasAnnotation) {  

                 

            TestA annotation =(TestA) constructor.getAnnotation(TestA.class);  

                System.out.println("constructor = " + constructor.getName()  

                        + " ; id = " + annotation.id() + " ; description = "  

                        + annotation.name() + "; gid= "+annotation.gid());  

            }  

        }  

}

public static void main(String[] args) throws ClassNotFoundException {

parseTypeAnnotation();

parseMethodAnnotation();

parseConstructAnnotation();

}

}

 

先別說話，運行：

 

id= "0"; name= "type"; gid = class java.lang.Long

method = c ; id = 5 ; description = private method; gid= class java.lang.Long

method = a ; id = 3 ; description = public method; gid= class java.lang.Long

method = b ; id = 4 ; description = protected method; gid= class java.lang.Long

constructor = com.tmser.annotation.UserAnnotation ; id = 2 ; description = construct; gid= class java.lang.Long

看到了吧，咱們定義的註解都完整的輸出了，你要使用哪一個，直接拿去用就行了。

爲了避免讓這篇文章打開太慢，我省略了類屬性註解，及參數註解的解析。其實都大同小異。

另外，我也沒有舉使用例子。由於我認爲好的教程是講的詳細的同時，還會留有擴展。若是我所有寫出來，而你只是學習的話，那基本不會本身去動腦了，而是複製粘貼運行一遍完事。

   最後提醒下：

    1. 要用好註解，必須熟悉java 的反射機制，從上面的例子能夠看出，註解的解析徹底依賴於反射。

     2. 不要濫用註解。日常咱們編程過程不多接觸和使用註解，只有作設計，且不想讓設計有過多的配置時

這個網址能夠給你參考一些註解的例子：http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html