註解(也被稱為元數據)為我們在代碼中添加信息提供了一種形式化的方法，使我們可以在稍後某個時刻非常方便地使用這些數據。
1.基本語法
Java SE5內置三種標準註解
@Override:表示當前的方法定義將覆蓋超類中的方法.如果你不小心拼寫錯誤,或者方法簽名對不上被覆蓋的方法,編譯器就會發出錯誤提示
@Deprecated:如果程序員使用了註解為它的元素,那麼編譯器就會發出警告信息
@SupperessWarnings:關閉不當的編譯器警告信息.
Java SE5內置四種元註解
@Target:表示該註解可以用於什麼地方.可能的ElementType參數包括:
1)CONSTRUCTOR:構造器的聲明
2)FIELD:域聲明(包括enum實例)
3)LOCAL_VARIABLE:局部變量聲明
4)METHOD:方法聲明
5)PACKAGE:包聲明
6)PARAMETER:參數聲明
7)TYPE:類、接口(包括註解類型)或enum聲明
@Retention:表示需要在什麼級別保存該註解信息.可選的RetentionPolicy參數包括:
1)SOURCE:註解將被編譯器丟棄
2)CLASS:註解在class文件中可用,但會被VM丟棄
3)RUNTIME:VM將在運行期也保留註解,因此可以通過反射機制讀取註解的信息
@Documented:將此註解包含在Javadoc中
@Inherited:允許子類繼承父類中的註解大多數時候,程序員主要是定義自己的註解，並編寫自己的處理器來處理它們.
UseCase.java
package com; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target(ElementType.METHOD)//用來定義你的註解將應用在什麼地方,本處應用為方法//用來定義該註解在哪一個級別可用,在源代碼中(source)類文件中(class)或者運行時(runtime) @Retention(RetentionPolicy.RUNTIME) public @interface UseCase { public int id(); public String description()default "no description"; } PasswordUtils .java package com; public class PasswordUtils { @UseCase(id=47,description="Passwords must contain at least one numeric") public boolean validatePassword(){ return true; } @UseCase(id=48) public String encryptPassword(String password){ return password; } @UseCase(id=49,description="Jong_Cai") public void showName(){ System.out.println("Jong_Cai"); } }
2.編寫註解處理器
如果沒有用來讀取註解的工具,那註解也不會比註釋更有用.使用註解的過程中.很重要的一個部分就是創建與使用註解處理器.Java SE5擴展了反射機制的API,以幫助程序員構造這類工具.同時,它還提供了一個外部工具apt幫助程序員解析帶有註解的Java源代碼.下面是一個非常簡單的註解處理器,我們將用它來讀取PasswordUtils類,並使用反射機制查找@UseCase標記.我們為其提供了一組id值得,然後它會列出在PasswordUtils中找到的用例,以及缺失的用例.
UseCaseTracker.java package com; import java.lang.reflect.Method; import java.util.ArrayList; import java.util.Collections; import java.util.List; public class UseCaseTracker { public static void trackUseCases(List<Integer> list, Class<?> cl) { for (Method m : cl.getDeclaredMethods()) { UseCase us = m.getAnnotation(UseCase.class); if (us != null) { System.out.println("Found Use Case:" + us.id() + " " + us.description()); list.remove(new Integer(us.id())); } } for (int i : list) { System.out.println("Warning:Missing use case-" + i); } } public static void main(String[] args) { List<Integer> list = new ArrayList<Integer>(); Collections.addAll(list, 47,48,49,50,51); trackUseCases(list, PasswordUtils.class); } }
這個程序用到了兩個反射的方法:getDeclaredMethods()和getAnnotation(),它們都屬於AnnotatedElement接口(class,Method與Field等類都實現了該接口).getAnnotation()方法返回指定類型的註解對象,在這裡就是UseCase,如果被註解的方法上沒有該類型的註解,則返回null值.然後我們通過調用id()和description()方法從返回的UseCase對像中提取元素的值.其中encryptPassword()方法在註解的時候沒有指定description的值,因此處理器在處理它對應的註解時,通過description()方法取得的是默認值no description.
Annotation在java的世界正鋪天蓋地展開,有空寫這一篇簡單的annotations的文章,算是關於Annotation入門的文章吧,希望能各位們能拋磚,共同學習......
不講廢話了,實踐才是硬道理.
3.實例
下面講一下annotation的概念先，再來講一下怎樣設計自己的annotation.
首先在jdk自帶的java.lang.annotation包裡,打開如下幾個源文件:
源文件Target.java
@Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Target { ElementType[] value(); @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Target { ElementType[] value(); }
其中的@interface是一個關鍵字，在設計annotations的時候必須把一個類型定義為@interface，而不能用class或interface關鍵字(會不會覺得sun有點吝嗇,偏偏搞得與interface這麼像).
源文件Retention.java
@Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Retention { RetentionPolicy value(); } @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Retention { RetentionPolicy value(); }
看到這裡，大家可能都模糊了,都不知道在說什麼，別急，往下看一下. 在上面的文件都用到了RetentionPolicy，ElementType這兩個字段,你可能就會猜到這是兩個java文件.的確，這兩個文件的源代碼如下：
源文件RetentionPolicy.java
public enum RetentionPolicy { SOURCE, CLASS, RUNTIME } 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.
源文件ElementType.java
public enum ElementType { TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE } 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文檔
源文件它們都使用了@Documented,@Documented的目的就是讓這一個Annotation類型的信息能夠顯示在javaAPI說明文檔上;沒有添加的話，使用javadoc生成API文檔的時候就會找不到這一個類型生成的信息.
另外一點，如果需要把Annotation的數據繼承給子類，那麼就會用到@Inherited這一個Annotation類型.
下面講的設計一個最簡單的Annotation例子,這一例子共用四個文件;
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(); } 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",後加小括號.例:上面的例子就只有一個參數成員.
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(); } 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(); }
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一用,寫這一個例子,請見諒!"; } } 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一用,寫這一個例子,請見諒!"; } }寫一個可以運行提取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<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()); } } } 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<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()); } } }運行結果：
描述:javaeye,做最棒的軟件開發交流社區創始人:robbin 創建的社區:javaEye 創始人:江南白衣創建的社區:springside