本文轉自Javaeye，文中內容不代表本站觀點，僅提供參考。

Annotation在java的世界正鋪天蓋地展開,有空寫這一篇簡單的annotations的文章,算是關于Annotation入門的文章吧,希望能各位們能拋磚,共同學習......

不講廢話了,實踐才是硬道理.

第一部分:了解一下java1.5起默認的三個annotation類型:

一個是@Override:只能用在方法之上的，用來告訴別人這一個方法是改寫父類的。

一個是@Deprecated:建議別人不要使用舊的API的時候用的,編譯的時候會用產生警告信息,可以設定在程序里的所有的元素上.

一個是@SuppressWarnings:這一個類型可以來暫時把一些警告信息消息關閉.

如果不清楚上面三個類型的具體用法，各位可以baidu或google一下的,很簡單的。

第二部分:講一下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)

具體參考一下javadoc文檔

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

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

第三部分:下面講的設計一個最簡單的Annotation例子,這一例子共用四個文件;

1、Description.java

代碼

package lighter.javaeye.com; 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(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Description { String value(); }

說明:所有的Annotation會自動繼承java.lang.annotation這一個接口,所以不能再去繼承別的類或是接口.

最重要的一點,Annotation類型里面的參數該怎么設定:

第一,只能用public或默認(default)這兩個訪問權修飾.例如,String value();這里把方法設為defaul默認類型.

第二,參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和String,Enum,Class,annotations等數據類型,以及這一些類型的數組.例如,String value();這里的參數成員就為String.

第三,如果只有一個參數成員,最好把參數名稱設為"value",后加小括號.例:上面的例子就只有一個參數成員.

2、Name.java

代碼

package lighter.javaeye.com; 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里的不同,參數成員也不同 @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Name { String originate(); String community(); }

3、JavaEyer.java

代碼

package lighter.javaeye.com; @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 lighter.javaeye.com; import java.lang.reflect.Method; import java.util.HashSet; import java.util.Set; public class TestAnnotation { /** * author lighter * 說明:具體關天Annotation的API的用法請參見javaDoc文檔 */ public static void main(String[] args) throws Exception { String CLASS_NAME = "lighter.javaeye.com.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 set = new HashSet(); for(int i=0;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 的全部文檔