Java中的Annotation解析之一(1)
2006-04-13 09:25 管斌
管斌的博客 我要評論(0) 字號： |
在已發(fā)布的JDK1.5(tiger)中增加新的特色叫 Annotation。Annotation提供一種機制，將程序的元素如:類(lèi)，方法，屬性，參數，本地變量，包和元數據聯(lián)系起來(lái)。
AD：
2013云計算架構師峰會(huì )課程資料下載在創(chuàng )建EJB組件時(shí)，必需提供一些定義，使得EJB組件使用一些服務(wù)例如：安全服務(wù)，持久化服務(wù)，事務(wù)服務(wù)。EJB容器可以提供這些服務(wù)，這樣EJB只要實(shí)現業(yè)務(wù)邏輯就可以了。但是說(shuō)到底EJB容器使用EJB組件的元數據來(lái)提供這些服務(wù)，在以前EJB的元數據是以XML配置文件形式出現的，這些配置文件與EJB源文件是分開(kāi)的。
EJB的部署人員無(wú)法了解EJB本身的信息，如果EJB組件的創(chuàng )建者用注釋(Annotation)的方法將這些配置服務(wù)的信息和代碼放在一起，這樣EJB的部署者就可以了解EJB的信息，EJB的home接口可以使用Annotation自動(dòng)生成，當然到目前為止更好的是在簡(jiǎn)單的Java Object上使用Annotations。
一 什么是Annotation
在已經(jīng)發(fā)布的JDK1.5(tiger)中增加新的特色叫 Annotation。Annotation提供一種機制，將程序的元素如:類(lèi)，方法，屬性，參數，本地變量，包和元數據聯(lián)系起來(lái)。這樣編譯器可以將元數據存儲在Class文件中。這樣虛擬機和其它對象可以根據這些元數據來(lái)決定如何使用這些程序元素或改變它們的行為。
二 定義一個(gè)簡(jiǎn)單的Annotation并使用它
1.定義Annotation
定義一個(gè)Annotation是什么簡(jiǎn)單的，它采取的是類(lèi)似于Interface的定義方式: “@+annotation類(lèi)型名稱(chēng)+(..逗號分割的name-value對...)”
//Example 1
package sz.starbex.bill.annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface SimpleAnnotation {
String value();
}
@Retention這個(gè)meta-annotation表示我們創(chuàng )建的SimpleAnnotation這個(gè)Annotation將會(huì )存儲在Class文件中，并在java
VM運行時(shí)加載它。@Target這個(gè)meta-annotation表示我們創(chuàng )建的SimplwAnnotation將會(huì )為描述方法，而@interface SimpleAnnotation是我們自定義的Annotation，它有一個(gè)成員叫value，返回值是String。
2.使用Annotation
//Example 2
package sz.starbex.bill.annotation;
import sz.starbex.bill.annotation.SimpleAnnotation;
public class UsingSimpleAnnotation {
@SimpleAnnotation(value="Pass:This method will Pass")//注意name=value的用法
public void pass(){
if(10>5) System.out.println("測試通過(guò)");
}
@SimpleAnnotation("Fail:This method will Fail")//注意name=value的用法
public void fail(){
if(10<5) System.out.println("測試失敗");
}
}
一個(gè)Annotation用于程序元素(在本例中是method),在method方法之前用(@Annotation名稱(chēng)(name=value,name=value.....)。在本例中是@SimpleAnnotation(value="Pass:This method will Pass")。每個(gè)annotation具有一個(gè)名字和成員個(gè)數>=0，當只有一個(gè)單一的成員時(shí)，這個(gè)成員就是value。我們也可以這樣寫(xiě) @SimpleAnnotation("Fail:This method will Fail")。至此@SimpleAnnotation將Pass和Fail聯(lián)系起來(lái)了。
3.在運行時(shí)訪(fǎng)問(wèn)Annotation
一旦Annotation與程序元素聯(lián)系起來(lái)，我們可以通過(guò)反射訪(fǎng)問(wèn)它們并可以取得它們的值。我們使用一個(gè)新的interface:java.lang.reflect.AnnotatedElement。java.lang.reflect.AnnotatedElement接口中的方法有：
a. boolean isAnnotationPresent(Class annotationType)
如果指定類(lèi)型的注釋存在于此元素上，則返回 true，否則返回 false。
b. T getAnnotation(Class annotationType)
如果存在該元素的指定類(lèi)型的注釋?zhuān)瑒t返回這些注釋?zhuān)駝t返回 null。
c. Annotation[] getAnnotations()
返回此元素上存在的所有注釋。
d. Annotation[] getDeclaredAnnotations()
返回直接存在于此元素上的所有注釋。
你要注意 isAnnotationPresent和getAnnotation方法，它們使用了Generics，請參考我的Java 范型的Blog。
下面我們列出一些實(shí)現了AnnotatedElement 接口的類(lèi)
1. java.lang.reflect.AccessibleObject
2. java.lang.Class
3. java.lang.reflect.Constructor
4. java.lang.reflect.Field
5. java.lang.reflect.Method
6. java.lang.Package
