全面解析Java注解
1. 了解注解
我們有必要對JDK 5.0新增的注解(Annotation)技術進行簡單的學習,因為Spring 支持@AspectJ,而@AspectJ本身就是基于JDK 5.0的注解技術。所以學習JDK 5.0的注解知識有助于我們更好地理解和掌握Spring的AOP技術。
對于Java開發人員來說,在編寫代碼時,除了源程序以外,我們還會使用 Javadoc標簽對類、方法或成員變量進行注釋,以便使用Javadoc工具生成和源代碼配套的Javadoc文檔。這些@param、@return 等Javadoc標簽就是注解標簽,它們為第三方工具提供了描述程序代碼的注釋信息。使用過Xdoclet的朋友,對此將更有感觸,像Struts、 Hibernate都提供了Xdoclet標簽,使用它們可以快速地生成對應程序代碼的配置文件。
JDK5.0注解可以看成是Javadoc標簽和Xdoclet標簽的延伸和發展。在JDK5.0中,我們可以自定義這些標簽,并通過Java語言的反射機制中獲取類中標注的注解,完成特定的功能。
注解是代碼的附屬信息,它遵循一個基本原則:注解不能直接干擾程序代碼的運行,無論增加或刪除注解,代碼都能夠正常運行。Java語言解釋器會忽略這些注解,而由第三方工具負責對注解進行處理。第三方工具可以利用代碼中的注解間接控制程序代碼的運行,它們通過Java反射機制讀取注解的信息,并根據這些信息更改目標程序的邏輯,而這正是Spring AOP對@AspectJ提供支持所采取的方法。
注解的語法比較簡單,除了@符號的使用以外,它基本上與java的固有語法一致,java內置了三種注解,定義在java.lang包中。
@Override:只能用在方法之上的,用來告訴別人這一個方法是改寫父類的。
@Deprecated:建議別人不要使用舊的API的時候用的,編譯的時候會用產生警告信息,可以設定在程序里的所有的元素上。
@SuppressWarnings:表示關閉一些不當的編譯器警告信息。
2. 定義注解
下面是一個定義注解的實例。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface Description {
String value();
}
其中的@interface是一個關鍵字,在設計annotations的時候必須把一個類型定義為@interface,而不能用class或interface關鍵字。所有的注解類都隱式繼承于 java.lang.annotation.Annotation,注解不允許顯式繼承于其他的接口。
一個注解可以擁有多個成員,成員聲明和接口方法聲明類似,這里,我們僅定義了一個成員,成員的聲明有以下幾點限制:
a) 成員以無入參無拋出異常的方式聲明,如boolean value(String str)、boolean value() throws Exception等方式是非法的;
b) 可以通過default為成員指定一個默認值,如String level() default "LOW_LEVEL"、int high() default 2是合法的,當然也可以不指定默認值;
c) 成員類型是受限的,合法的類型包括原始類型及其封裝類、String、Class、enums、注解類型,以及上述類型的數組類型。如ForumService value()、List foo()是非法的。
d) 如果注解只有一個成員,則成員名必須取名為value(),在使用時可以忽略成員名和賦值號(=),如@Description("使用注解的實例")。注解類擁有多個成員時,如果僅對value成員進行賦值則也可不使用賦值號,如果同時對多個成員進行賦值,則必須使用賦值號,如@DeclareParents (value = "NaiveWaiter", defaultImpl = SmartSeller.class)。
e) 注解類可以沒有成員,沒有成員的注解稱為標識注解,解釋程序以標識注解存在與否進行相應的處理;
注解定義包含四個元注解,分別為@Target,@Retention,@Documented,@Inherited。各元注解的作用如下:
1) @Target
表示該注解用于什么地方,可能的 ElemenetType 參數包括:
? ElemenetType.CONSTRUCTOR 構造器聲明。
? ElemenetType.FIELD 域聲明(包括 enum 實例)。
? ElemenetType.LOCAL_VARIABLE 局部變量聲明。
? ElemenetType.METHOD 方法聲明。
? ElemenetType.PACKAGE 包聲明。
? ElemenetType.PARAMETER 參數聲明。
? ElemenetType.TYPE 類,接口(包括注解類型)或enum聲明。
2) @Retention
表示在什么級別保存該注解信息。可選的 RetentionPolicy 參數包括:
? RetentionPolicy.SOURCE 注解將被編譯器丟棄。
? RetentionPolicy.CLASS 注解在class文件中可用,但會被VM丟棄。
? RetentionPolicy.RUNTIME VM將在運行期也保留注釋,因此可以通過反射機制讀取注解的信息。
舉一個例子,如@Override里面的Retention設為SOURCE,編譯成功了就不要這一些檢查的信息,相反,@Deprecated里面的Retention設為RUNTIME,表示除了在編譯時會警告我們使用了哪個被 Deprecated的方法,在執行的時候也可以查出該方法是否被Deprecated。
3) @Documented
將此注解包含在 javadoc 中
4) @Inherited
允許子類繼承父類中的注解
3. 使用注解
下面是一個使用注解注解的實例。
@Description(value="使用注解的實例")
public class TestAnnotation {
}
使用注解的語法:@<注解名>(<成員名1>=<成員值1>,<成員名1>=<成員值1>,...)
如果成員是數組類型,可以通過{}進行賦值,如boolean數組的成員可以設置為{true,false,true}。下面是幾個注解標注的例子:
1) 多成員的注解
@AnnoExample(id= 2868724, synopsis = "Enable time-travel", engineer = "Mr. Peabody")
2) 一個成員的注解,成員名為value
可以省略成員名和賦值符號:@Copyright("Right Reserved")
@Copyright("2011 bookegou.com All Right Reserved")
3) 無成員的注解
@Override
@Override
4) 成員為字符串數組的注解
@SuppressWarnings(value={"unchecked","fallthrough"})
@SuppressWarnings(value={"unchecked","fallthrough"})
5) 成員為注解數組類型的注解
@Reviews({@Review(grade=Review.Grade.EXCELLENT,reviewer="df"),
@Review(grade=Review.Grade.UNSATISFACTORY,reviewer="eg",
comment="This method needs an @Override annotation")})
@Reviews({@Review(grade=Review.Grade.EXCELLENT,reviewer="df"),
@Review(grade=Review.Grade.UNSATISFACTORY,reviewer="eg",
comment="This method needs an @Override annotation")})
@Reviews注解擁有一個@Review注解數組類型的成員,@Review注解類型有三個成員,其中reviewer、comment都是String類型,但comment有默認值,grade是枚舉類型的成員。
4. 解析注解
下面是一個解析注解的實例。
public class ParseAnnotation {
public static void main(String[] args) throws Exception{
final Class cls = Class.forName("com.annotation.TestAnnotation");
final Method[] method = cls.getMethods();
// 判斷是否有指定注解類型的注解
if(cls.isAnnotationPresent(Description.class)) {
// 根據注解類型返回指定類型的注解
Description des = (Description)cls.getAnnotation(Description.class);
System.out.println("注解描述:" + des.value());
}
}
}
輸出結果如下:
注解描述:使用注解的實例
前面提到過,注解不會直接影響程序的運行,但是第三方程序或工具可以利用代碼中的注解完成特殊的任務,間接控制程序的運行。對于RetentionPolicy.RUNTIME保留期限的注解,我們可以通過反射機制訪問類中的注解。
在JDK5.0里,Package、Class、Constructor、 Method以及Field等反射對象都新增了訪問注解信息的方法:<T extends Annotation>T getAnnotation(Class<T> annotationClass),該方法支持通過泛型直接返回注解對象。