注解(Annotation)是JDK1.5引入的新特性,包含在java.lang.annotation包中,它是附加在代碼中的一些元信息,將一個(gè)類(lèi)的外部信息與內部成員聯(lián)系起來(lái),在編 譯、運行時(shí)進(jìn)行解析和使用。Java內置了一些注解(如@Override、@Deprecated等),還支持自定義注解,一些知名的框架 Struts、Hibernate、Spring都有自己實(shí)現的自定義注解,也可以自己定義注解供使用。
Annotation十分類(lèi)似public、final這樣的修飾符。每個(gè)Annotation具有一個(gè)名字和成員個(gè)數>=0。每個(gè)Annotation的成員具有被稱(chēng)為name=value對的名字和值(就像javabean一樣),name=value裝載了Annotation的信息。
Annotation類(lèi)(java.lang.reflect.Annotation):
Annotation類(lèi)型定義了Annotation的名字、類(lèi)型、成員默認值。一個(gè)Annotation類(lèi)型可以說(shuō)是一個(gè)特殊的java接口,它的成員變量是受限制的,而聲明Annotation類(lèi)型時(shí)需要使用新語(yǔ)法。當我們通過(guò)java反射api訪(fǎng)問(wèn)Annotation時(shí),返回值將是一個(gè)實(shí)現了該 annotation類(lèi)型接口的對象,通過(guò)訪(fǎng)問(wèn)這個(gè)對象我們能方便的訪(fǎng)問(wèn)到其Annotation成員。后面的章節將提到在java5.0的 java.lang包里包含的3個(gè)標準Annotation類(lèi)型。其子類(lèi)如下圖所示:
注解處理器類(lèi)庫(java.lang.reflect.AnnotatedElement):
Java使用Annotation接口來(lái)代表程序元素前面的注解,該接口是所有Annotation類(lèi)型的父接口。除此之外,Java在java.lang.reflect 包下新增了AnnotatedElement接口,該接口代表程序中可以接受注解的程序元素,該接口主要有如下幾個(gè)實(shí)現類(lèi)(如下圖所示):
Class:類(lèi)定義
Constructor:構造器定義
Field:累的成員變量定義
Method:類(lèi)的方法定義
Package:類(lèi)的包定義
java.lang.reflect 包下主要包含一些實(shí)現反射功能的工具類(lèi),實(shí)際上,java.lang.reflect 包所有提供的反射API擴充了讀取運行時(shí)Annotation信息的能力。當一個(gè)Annotation類(lèi)型被定義為運行時(shí)的Annotation后,該注解才能是運行時(shí)可見(jiàn),當class文件被裝載時(shí)被保存在class文件中的Annotation才會(huì )被虛擬機讀取。
AnnotatedElement 接口是所有程序元素(Class、Method和Constructor)的父接口,所以程序通過(guò)反射獲取了某個(gè)類(lèi)的AnnotatedElement對象之后,程序就可以調用該對象的如下四個(gè)個(gè)方法來(lái)訪(fǎng)問(wèn)Annotation信息:
方法1:<T extends Annotation> T getAnnotation(Class<T> annotationClass): 返回改程序元素上存在的、指定類(lèi)型的注解,如果該類(lèi)型注解不存在,則返回null。
方法2:Annotation[] getAnnotations():返回該程序元素上存在的所有注解。
方法3:boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判斷該程序元素上是否包含指定類(lèi)型的注解,存在則返回true,否則返回false.
方法4:Annotation[] getDeclaredAnnotations():返回直接存在于此元素上的所有注釋。與此接口中的其他方法不同,該方法將忽略繼承的注釋。(如果沒(méi)有注釋直接存在于此元素上,則返回長(cháng)度為零的一個(gè)數組。)該方法的調用者可以隨意修改返回的數組;這不會(huì )對其他調用者返回的數組產(chǎn)生任何影響。
注解的一般格式是[修飾符] @interface [名稱(chēng)]{元素}, 元素是無(wú)方法體的方法聲明,可以有默認值,如@Target的注解如下所示:
元注解的作用就是負責注解其他注解。Java5.0定義了4個(gè)標準的meta-annotation類(lèi)型,它們被用來(lái)提供對其它 annotation類(lèi)型作說(shuō)明。Java5.0定義的元注解:
1.@Target,
2.@Retention,
3.@Documented,
4.@Inherited
這些類(lèi)型和它們所支持的類(lèi)在java.lang.annotation包中可以找到。下面我們看一下每個(gè)元注解的作用和相應分參數的使用說(shuō)明。
@Target:
@Target說(shuō)明了Annotation所修飾的對象范圍:Annotation可被用于 packages、types(類(lèi)、接口、枚舉、Annotation類(lèi)型)、類(lèi)型成員(方法、構造方法、成員變量、枚舉值)、方法參數和本地變量(如循環(huán)變量、catch參數)。在A(yíng)nnotation類(lèi)型的聲明中使用了target可更加明晰其修飾的目標。
作用:用于描述注解的使用范圍(即:被描述的注解可以用在什么地方)
取值(ElementType)是來(lái)源于Java.lang.annotation.ElementType中的枚舉類(lèi)型元素:
1.CONSTRUCTOR:用于描述構造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部變量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述參數
7.TYPE:用于描述類(lèi)、接口(包括注解類(lèi)型) 或enum聲明
@Retention:
@Retention定義了該Annotation被保留的時(shí)間長(cháng)短:某些Annotation僅出現在源代碼中,而被編譯器丟棄;而另一些卻被編譯在class文件中;編譯在class文件中的Annotation可能會(huì )被虛擬機忽略,而另一些在class被裝載時(shí)將被讀?。ㄕ堊⒁獠⒉挥绊慶lass的執行,因為Annotation與class在使用上是被分離的)。使用這個(gè)meta-Annotation可以對 Annotation的“生命周期”限制。
作用:表示需要在什么級別保存該注釋信息,用于描述注解的生命周期(即:被描述的注解在什么范圍內有效)
取值(RetentionPoicy)來(lái)源于java.lang.annotation.RetentionPolicy的枚舉類(lèi)型值:
1.SOURCE:在源文件中有效(即源文件保留)
2.CLASS:在class文件中有效(即class保留)
3.RUNTIME:在運行時(shí)有效(即運行時(shí)保留)
@Documented:
@Documented用于描述其它類(lèi)型的annotation應該被作為被標注的程序成員的公共API,因此可以被例如javadoc此類(lèi)的工具文檔化。Documented是一個(gè)標記注解,沒(méi)有成員。
@Inherited:
@Inherited 元注解是一個(gè)標記注解,@Inherited闡述了某個(gè)被標注的類(lèi)型是被繼承的。如果一個(gè)使用了@Inherited修飾的annotation類(lèi)型被用于一個(gè)class,則這個(gè)annotation將被用于該class的子類(lèi)。
注意:@Inherited annotation類(lèi)型是被標注過(guò)的class的子類(lèi)所繼承。類(lèi)并不從它所實(shí)現的接口繼承annotation,方法并不從它所重載的方法繼承annotation。
當@Inherited annotation類(lèi)型標注的annotation的Retention是RetentionPolicy.RUNTIME,則反射API增強了這種繼承性。如果我們使用java.lang.reflect去查詢(xún)一個(gè)@Inherited annotation類(lèi)型的annotation時(shí),反射代碼檢查將展開(kāi)工作:檢查class和其父類(lèi),直到發(fā)現指定的annotation類(lèi)型被發(fā)現,或者到達類(lèi)繼承結構的頂層。
聯(lián)系客服