Java註解入門

標籤：

第一部分:瞭解一下java1.5起預設的三個annotation類型
一個是@Override:只能用在方法之上的，用來告訴別人這一個方法是改寫父類的。
一個是@Deprecated:建議別人不要使用舊的API的時候用的,編譯的時候會產生警告資訊,可以設定在程式裡的所有的元素上.
一個是@SuppressWarnings:這一個類型可以用來暫時把一些警告資訊訊息關閉.

第二部分:講一下annotation的概念先，再來講一下怎樣設計自己的annotation
首先在jdk內建的java.lang.annotation包裡,開啟如下幾個源檔案:

1、源檔案Target.java

@Documented  @Retention(RetentionPolicy.RUNTIME)   @Target(ElementType.ANNOTATION_TYPE)   public @interface Target {      ElementType[] value();   }

其中@interface是一個關鍵字，在設計annotations的時候必須把一個類型定義為@interface，而不能用class或interface關鍵字(會不會覺得sun有點吝嗇,偏偏搞得與interface這麼像).

2、源檔案Retention.java

@Documented  @Retention(RetentionPolicy.RUNTIME)   @Target(ElementType.ANNOTATION_TYPE)   public @interface Retention {      RetentionPolicy value();   } 

看到這裡，大家可能都模糊了,都不知道在說什麼，別急，往下看一下。
在上面的檔案都用到了RetentionPolicy，ElementType這兩個欄位,你可能就會猜到這是兩個java檔案.的確，這兩個檔案的原始碼如下：

3、源檔案RetentionPolicy.java

public enum RetentionPolicy {    SOURCE,    CLASS,    RUNTIME   } 

這是一個enum類型，共有三個值，分別是SOURCE, CLASS 和 RUNTIME。
SOURCE代表的是這個Annotation類型的資訊只會保留在程式源碼裡，源碼如果經過了編譯之後，Annotation的資料就會消失,並不會保留在編譯好的.class檔案裡面。
ClASS的意思是這個Annotation類型的資訊保留在程式源碼裡,同時也會保留在編譯好的.class檔案裡面,在執行的時候，並不會把這一些資訊載入到虛擬機器(JVM)中去.注意一下，當你沒有設定一個Annotation類型的Retention值時，系統預設值是CLASS.
RUNTIME表示在源碼、編譯好的.class檔案中保留資訊，在執行的時候會把這一些資訊載入到JVM中去的．

舉一個例子，如@Override裡面的Retention設為SOURCE,編譯成功了就不要這一些檢查的資訊;相反,@Deprecated裡面的Retention設為RUNTIME,表示除了在編譯時間會警告我們使用了哪個被Deprecated的方法,在執行的時候也可以查出該方法是否被Deprecated.

4、源檔案ElementType.java

public enum ElementType {    TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,    LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE   } 

＠Target裡面的ElementType是用來指定Annotation類型可以用在哪一些元素上的.說明一下：TYPE(類型), FIELD(屬性), METHOD(方法), PARAMETER(參數), CONSTRUCTOR(建構函式),LOCAL_VARIABLE(局部變數), ANNOTATION_TYPE,PACKAGE(包),其中的TYPE(類型)是指可以用在Class,Interface,Enum和Annotation類型上.

另外,從1的原始碼可以看出,@Target自己也用了自己來聲明自己,只能用在ANNOTATION_TYPE之上.
如果一個Annotation類型沒有指明@Target使用在哪些元素上,那麼它可以使用在任何元素之上,這裡的元素指的是上面的八種類型.
舉幾個正確的例子:
@Target(ElementType.METHOD)
@Target(value=ElementType.METHOD)
@Target(ElementType.METHOD,ElementType.CONSTRUCTOR)

上面一下1和2的源檔案，它們都使用了@Documented,@Documented的目的就是讓這一個Annotation類型的資訊能夠顯示在javaAPI說明文檔上;沒有添加的話，使用javadoc產生API文檔的時候就會找不到這一個類型產生的資訊.

另外一點，如果需要把Annotation的資料繼承給子類，那麼就會用到@Inherited這一個Annotation類型.

第三部分:Annotation例子
1、Description.java

package com.ljq.test;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;@Documented@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)public @interface Description {    String value();}

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

2、Name.java

package com.ljq.test;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;//注意這裡的@Target與@Description裡的不同,參數成員也不同  @Documented  @Target(ElementType.METHOD)   @Retention(RetentionPolicy.RUNTIME)   public @interface Name {       String originate();       String community();   }  

3、JavaEyer.java

package com.ljq.test;@Description("javaeye,做最棒的軟體開發交流社區")public class JavaEyer {    @Name(originate = "創始人:robbin", community = "javaEye")    public String getName() {        return null;    }    @Name(originate = "創始人:江南白衣", community = "springside")    public String getName2() {        return "借用兩位的id一用,寫這一個例子,請見諒!";    }}

 

4、最後，寫一個可以運行提取JavaEyer資訊的類TestAnnotation

package com.ljq.test;import java.lang.reflect.Method;import java.util.HashSet;import java.util.Set;public class TestAnnotation { public static void main(String[] args) throws Exception {String CLASS_NAME = "com.ljq.test.JavaEyer";Class test = Class.forName(CLASS_NAME);Method[] method = test.getMethods();boolean flag = test.isAnnotationPresent(Description.class);if (flag) {Description des = (Description) test.getAnnotation(Description.class);System.out.println("描述:" + des.value());System.out.println("-----------------");}// 把JavaEyer這一類有利用到@Name的全部方法儲存到Set中去Set<Method> set = new HashSet<Method>();for (int i = 0; i < method.length; i++) {boolean otherFlag = method[i].isAnnotationPresent(Name.class);if (otherFlag)set.add(method[i]);}for (Method m : set) {Name name = m.getAnnotation(Name.class);System.out.println(name.originate());System.out.println("建立的社區:" + name.community());}}}

　　

5、運行結果：
描述:javaeye,做最棒的軟體開發交流社區
-----------------
創始人:robbin
建立的社區:javaEye
創始人:江南白衣
建立的社區:springside

本文章摘抄自網路。

Java註解入門