天天看點

注解(Annotation)自定義注解入門

要深入學習注解,我們就必須能定義自己的注解,并使用注解,在定義自己的注解之前,我們就必須要了解Java為我們提供的元注解和相關定義注解的文法。

元注解:

  元注解的作用就是負責注解其他注解。Java5.0定義了4個标準的meta-annotation類型,它們被用來提供對其它 annotation類型作說明。Java5.0定義的元注解:

    1.@Target,

    2.@Retention,

    3.@Documented,

    4.@Inherited

  這些類型和它們所支援的類在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聲明

  使用執行個體:  

注解(Annotation)自定義注解入門
注解(Annotation)自定義注解入門

  注解Table 可以用于注解類、接口(包括注解類型) 或enum聲明,而注解NoDBColumn僅可用于注解類的成員變量。

  @Retention:

  @Retention定義了該Annotation被保留的時間長短:某些Annotation僅出現在源代碼中,而被編譯器丢棄;而另一些卻被編譯在class檔案中;編譯在class檔案中的Annotation可能會被虛拟機忽略,而另一些在class被裝載時将被讀取(請注意并不影響class的執行,因為Annotation與class在使用上是被分離的)。使用這個meta-Annotation可以對 Annotation的“生命周期”限制。

  作用:表示需要在什麼級别儲存該注釋資訊,用于描述注解的生命周期(即:被描述的注解在什麼範圍内有效)

  取值(RetentionPoicy)有:

    1.SOURCE:在源檔案中有效(即源檔案保留)

    2.CLASS:在class檔案中有效(即class保留)

    3.RUNTIME:在運作時有效(即運作時保留)

  Retention meta-annotation類型有唯一的value作為成員,它的取值來自java.lang.annotation.RetentionPolicy的枚舉類型值。具體執行個體如下:

注解(Annotation)自定義注解入門
注解(Annotation)自定義注解入門

   Column注解的的RetentionPolicy的屬性值是RUTIME,這樣注解處理器可以通過反射,擷取到該注解的屬性值,進而去做一些運作時的邏輯處理

  @Documented:

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

注解(Annotation)自定義注解入門
注解(Annotation)自定義注解入門

  @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類型被發現,或者到達類繼承結構的頂層。

  執行個體代碼:

注解(Annotation)自定義注解入門
注解(Annotation)自定義注解入門

自定義注解:

  使用@interface自定義注解時,自動繼承了java.lang.annotation.Annotation接口,由編譯程式自動完成其他細節。在定義注解時,不能繼承其他的注解或接口。@interface用來聲明一個注解,其中的每一個方法實際上是聲明了一個配置參數。方法的名稱就是參數的名稱,傳回值類型就是參數的類型(傳回值類型隻能是基本類型、Class、String、enum)。可以通過default來聲明參數的預設值。

  定義注解格式:

  public @interface 注解名 {定義體}

  注解參數的可支援資料類型:

    1.所有基本資料類型(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八種基本資料類型和 String,Enum,Class,annotations等資料類型,以及這一些類型的數組.例如,String value();這裡的參數成員就為String;  

  第三,如果隻有一個參數成員,最好把參數名稱設為"value",後加小括号.例:下面的例子FruitName注解就隻有一個參數成員。

  簡單的自定義注解和使用注解執行個體:

注解(Annotation)自定義注解入門
注解(Annotation)自定義注解入門
注解(Annotation)自定義注解入門
注解(Annotation)自定義注解入門
注解(Annotation)自定義注解入門
注解(Annotation)自定義注解入門

注解元素的預設值:

  注解元素必須有确定的值,要麼在定義注解的預設值中指定,要麼在使用注解時指定,非基本類型的注解元素的值不可為null。是以, 使用空字元串或0作為預設值是一種常用的做法。這個限制使得處理器很難表現一個元素的存在或缺失的狀态,因為每個注解的聲明中,所有元素都存在,并且都具有相應的值,為了繞開這個限制,我們隻能定義一些特殊的值,例如空字元串或者負數,一次表示某個元素不存在,在定義注解時,這已經成為一個習慣用法。例如:

注解(Annotation)自定義注解入門
注解(Annotation)自定義注解入門

  定義了注解,并在需要的時候給相關類,類屬性加上注解資訊,如果沒有響應的注解資訊處理流程,注解可以說是沒有實用價值。如何讓注解真真的發揮作用,主要就在于注解處理方法,下一步我們将學習注解資訊的擷取和處理!

轉自http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html

QQ:519841366

本頁版權歸作者和部落格園所有,歡迎轉載,但未經作者同意必須保留此段聲明,

且在文章頁面明顯位置給出原文連結,否則保留追究法律責任的權利