注解(也被稱為元數據)為我們在代碼中添加信息提供了一種形式化的方法,使我們可以在稍后某個時刻非常方便地使用這些數據。
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
03 | import java.lang.annotation.ElementType; |
04 | import java.lang.annotation.Retention; |
05 | import java.lang.annotation.RetentionPolicy; |
06 | import java.lang.annotation.Target; |
08 | @Target (ElementType.METHOD) |
10 | @Retention (RetentionPolicy.RUNTIME) |
11 | public @interface UseCase { |
13 | public String description() default "no description" ; |
19 | public class PasswordUtils { |
20 | @UseCase (id= 47 ,description= "Passwords must contain at least one numeric" ) |
21 | public boolean validatePassword(){ |
26 | public String encryptPassword(String password){ |
30 | @UseCase (id= 49 ,description= "Jong_Cai" ) |
31 | public void showName(){ |
32 | System.out.println( "Jong_Cai" ); |
2.編寫注解處理器
如果沒有用來讀取注解的工具,那注解也不會比注釋更有用.使用注解的過程中.很重要的一個部
分就是創建與使用注解處理器.Java SE5擴展了反射機制的API,以幫助程序員構造這類工具.同時,它還提供了一個外部工具apt幫助程序員解析帶有注解的Java源代碼.下面是一個非常簡單的注解處理器,我們將用它來讀取PasswordUtils類,并使用反射機制查找@UseCase標記.我們為其提供了一組id值得,然后它會列出在PasswordUtils中找到的用例,以及缺失的用例.
04 | import java.lang.reflect.Method; |
05 | import java.util.ArrayList; |
06 | import java.util.Collections; |
09 | public class UseCaseTracker { |
10 | public static void trackUseCases(List<Integer> list, Class<?> cl) { |
11 | for (Method m : cl.getDeclaredMethods()) { |
12 | UseCase us = m.getAnnotation(UseCase. class ); |
14 | System.out.println( "Found Use Case:" + us.id() + " " |
16 | list.remove( new Integer(us.id())); |
20 | System.out.println( "Warning:Missing use case-" + i); |
24 | public static void main(String[] args) { |
25 | List<Integer> list = new ArrayList<Integer>(); |
26 | Collections.addAll(list, 47 , 48 , 49 , 50 , 51 ); |
27 | 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
02 | @Retention (RetentionPolicy.RUNTIME) |
03 | @Target (ElementType.ANNOTATION_TYPE) |
04 | public @interface Target { |
05 | ElementType[] value(); |
08 | @Retention (RetentionPolicy.RUNTIME) |
09 | @Target (ElementType.ANNOTATION_TYPE) |
10 | public @interface Target { |
11 | ElementType[] value(); |
其中的@interface是一個關鍵字,在設計annotations的時候必須把一個類型定義為@interface,而不能用class或interface關鍵字(會不會覺得sun有點吝嗇,偏偏搞得與interface這么像).
源文件Retention.java
02 | @Retention (RetentionPolicy.RUNTIME) |
03 | @Target (ElementType.ANNOTATION_TYPE) |
04 | public @interface Retention { |
05 | RetentionPolicy value(); |
09 | @Retention (RetentionPolicy.RUNTIME) |
10 | @Target (ElementType.ANNOTATION_TYPE) |
11 | public @interface Retention { |
12 | RetentionPolicy value(); |
看到這里,大家可能都模糊了,都不知道在說什么,別急,往下看一下. 在上面的文件都用到了RetentionPolicy,ElementType這兩個字段,你可能就會猜到這是兩個java文件.的確,這兩個文件的源代碼如下:
源文件RetentionPolicy.java
01 | public enum RetentionPolicy { |
07 | public enum RetentionPolicy { |
這是一個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
1 | public enum ElementType { |
2 | TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, |
3 | LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE |
6 | public enum ElementType { |
7 | TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, |
8 | 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
01 | package lighter.javaeye.com; |
03 | import java.lang.annotation.Documented; |
04 | import java.lang.annotation.ElementType; |
05 | import java.lang.annotation.Retention; |
06 | import java.lang.annotation.RetentionPolicy; |
07 | import java.lang.annotation.Target; |
09 | @Target (ElementType.TYPE) |
10 | @Retention (RetentionPolicy.RUNTIME) |
12 | public @interface Description { |
16 | package lighter.javaeye.com; |
18 | import java.lang.annotation.Documented; |
19 | import java.lang.annotation.ElementType; |
20 | import java.lang.annotation.Retention; |
21 | import java.lang.annotation.RetentionPolicy; |
22 | import java.lang.annotation.Target; |
24 | @Target (ElementType.TYPE) |
25 | @Retention (RetentionPolicy.RUNTIME) |
27 | public @interface Description { |
說明:所有的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
01 | package lighter.javaeye.com; |
03 | import java.lang.annotation.Documented; |
04 | import java.lang.annotation.ElementType; |
05 | import java.lang.annotation.Retention; |
06 | import java.lang.annotation.RetentionPolicy; |
07 | import java.lang.annotation.Target; |
10 | @Target (ElementType.METHOD) |
11 | @Retention (RetentionPolicy.RUNTIME) |
13 | public @interface Name { |
18 | package lighter.javaeye.com; |
20 | import java.lang.annotation.Documented; |
21 | import java.lang.annotation.ElementType; |
22 | import java.lang.annotation.Retention; |
23 | import java.lang.annotation.RetentionPolicy; |
24 | import java.lang.annotation.Target; |
27 | @Target (ElementType.METHOD) |
28 | @Retention (RetentionPolicy.RUNTIME) |
30 | public @interface Name { |
JavaEyer.java
01 | package lighter.javaeye.com; |
03 | @Description ( "javaeye,做最棒的軟件開發交流社區" ) |
04 | public class JavaEyer { |
05 | @Name (originate= "創始人:robbin" ,community= "javaEye" ) |
06 | public String getName() |
11 | @Name (originate= "創始人:江南白衣" ,community= "springside" ) |
12 | public String getName2() |
14 | return "借用兩位的id一用,寫這一個例子,請見諒!" ; |
19 | package lighter.javaeye.com; |
21 | @Description ( "javaeye,做最棒的軟件開發交流社區" ) |
22 | public class JavaEyer { |
23 | @Name (originate= "創始人:robbin" ,community= "javaEye" ) |
24 | public String getName() |
29 | @Name (originate= "創始人:江南白衣" ,community= "springside" ) |
30 | public String getName2() |
32 | return "借用兩位的id一用,寫這一個例子,請見諒!" ; |
寫一個可以運行提取JavaEyer信息的類TestAnnotation
01 | package lighter.javaeye.com; |
03 | import java.lang.reflect.Method; |
04 | import java.util.HashSet; |
07 | public class TestAnnotation { |
10 | * 說明:具體關天Annotation的API的用法請參見javaDoc文檔 |
12 | public static void main(String[] args) throws Exception { |
13 | String CLASS_NAME = "lighter.javaeye.com.JavaEyer" ; |
14 | Class test = Class.forName(CLASS_NAME); |
15 | Method[] method = test.getMethods(); |
16 | boolean flag = test.isAnnotationPresent(Description. class ); |
19 | Description des = (Description)test.getAnnotation(Description. class ); |
20 | System.out.println( "描述:" +des.value()); |
21 | System.out.println( "-----------------" ); |
25 | Set<Method> set = new HashSet<Method>(); |
26 | for ( int i= 0 ;i<method.length;i++) |
28 | boolean otherFlag = method[i].isAnnotationPresent(Name. class ); |
29 | if (otherFlag) set.add(method[i]); |
33 | Name name = m.getAnnotation(Name. class ); |
34 | System.out.println(name.originate()); |
35 | System.out.println( "創建的社區:" +name.community()); |
40 | package lighter.javaeye.com; |
42 | import java.lang.reflect.Method; |
43 | import java.util.HashSet; |
46 | public class TestAnnotation { |
49 | * 說明:具體關天Annotation的API的用法請參見javaDoc文檔 |
51 | public static void main(String[] args) throws Exception { |
52 | String CLASS_NAME = "lighter.javaeye.com.JavaEyer" ; |
53 | Class test = Class.forName(CLASS_NAME); |
54 | Method[] method = test.getMethods(); |
55 | boolean flag = test.isAnnotationPresent(Description. class ); |
58 | Description des = (Description)test.getAnnotation(Description. class ); |
59 | System.out.println( "描述:" +des.value()); |
60 | System.out.println( "-----------------" ); |
64 | Set<Method> set = new HashSet<Method>(); |
65 | for ( int i= 0 ;i<method.length;i++) |
67 | boolean otherFlag = method[i].isAnnotationPresent(Name. class ); |
68 | if (otherFlag) set.add(method[i]); |
72 | Name name = m.getAnnotation(Name. class ); |
73 | System.out.println(name.originate()); |
74 | System.out.println( "創建的社區:" +name.community()); |
運行結果: