深入理解Java:注解(Annotation)基本概念、自定义注解、注解解析器
深入理解Java:注解(Annotation)基本概念
什么是注解(Annotation):
Annotation(注解)就是Java提供了一種元程序中的元素關(guān)聯(lián)任何信息和著任何元數(shù)據(jù)(metadata)的途徑和方法。Annotion(注解)是一個(gè)接口,程序可以通過反射來獲取指定程序元素的Annotion對(duì)象,然后通過Annotion對(duì)象來獲取注解里面的元數(shù)據(jù)。
Annotation(注解)是JDK5.0及以后版本引入的。它可以用于創(chuàng)建文檔,跟蹤代碼中的依賴性,甚至執(zhí)行基本編譯時(shí)檢查。從某些方面看,annotation就像修飾符一樣被使用,并應(yīng)用于包、類 型、構(gòu)造方法、方法、成員變量、參數(shù)、本地變量的聲明中。這些信息被存儲(chǔ)在Annotation的“name=value”結(jié)構(gòu)對(duì)中。
Annotation的成員在Annotation類型中以無參數(shù)的方法的形式被聲明。其方法名和返回值定義了該成員的名字和類型。在此有一個(gè)特定的默認(rèn)語法:允許聲明任何Annotation成員的默認(rèn)值:一個(gè)Annotation可以將name=value對(duì)作為沒有定義默認(rèn)值的Annotation成員的值,當(dāng)然也可以使用name=value對(duì)來覆蓋其它成員默認(rèn)值。這一點(diǎn)有些近似類的繼承特性,父類的構(gòu)造函數(shù)可以作為子類的默認(rèn)構(gòu)造函數(shù),但是也可以被子類覆蓋。
Annotation能被用來為某個(gè)程序元素(類、方法、成員變量等)關(guān)聯(lián)任何的信息。需要注意的是,這里存在著一個(gè)基本的規(guī)則:Annotation不能影響程序代碼的執(zhí)行,無論增加、刪除 Annotation,代碼都始終如一的執(zhí)行。另外,盡管一些annotation通過java的反射api方法在運(yùn)行時(shí)被訪問,而java語言解釋器在工作時(shí)忽略了這些annotation。正是由于java虛擬機(jī)忽略了Annotation,導(dǎo)致了annotation類型在代碼中是“不起作用”的; 只有通過某種配套的工具才會(huì)對(duì)annotation類型中的信息進(jìn)行訪問和處理。本文中將涵蓋標(biāo)準(zhǔn)的Annotation和meta-annotation類型,陪伴這些annotation類型的工具是java編譯器(當(dāng)然要以某種特殊的方式處理它們)。
什么是metadata(元數(shù)據(jù)):
元數(shù)據(jù)從metadata一詞譯來,就是“關(guān)于數(shù)據(jù)的數(shù)據(jù)”的意思。
元數(shù)據(jù)的功能作用有很多,比如:你可能用過Javadoc的注釋自動(dòng)生成文檔。這就是元數(shù)據(jù)功能的一種。總的來說,元數(shù)據(jù)可以用來創(chuàng)建文檔,跟蹤代碼的依賴性,執(zhí)行編譯時(shí)格式檢查,代替已有的配置文件。如果要對(duì)于元數(shù)據(jù)的作用進(jìn)行分類,目前還沒有明確的定義,不過我們可以根據(jù)它所起的作用,大致可分為三類:?
1. 編寫文檔:通過代碼里標(biāo)識(shí)的元數(shù)據(jù)生成文檔
2. 代碼分析:通過代碼里標(biāo)識(shí)的元數(shù)據(jù)對(duì)代碼進(jìn)行分析
3. 編譯檢查:通過代碼里標(biāo)識(shí)的元數(shù)據(jù)讓編譯器能實(shí)現(xiàn)基本的編譯檢查
在Java中元數(shù)據(jù)以標(biāo)簽的形式存在于Java代碼中,元數(shù)據(jù)標(biāo)簽的存在并不影響程序代碼的編譯和執(zhí)行,它只是被用來生成其它的文件或針在運(yùn)行時(shí)知道被運(yùn)行代碼的描述信息。
綜上所述:
第一,元數(shù)據(jù)以標(biāo)簽的形式存在于Java代碼中。
第二,元數(shù)據(jù)描述的信息是類型安全的,即元數(shù)據(jù)內(nèi)部的字段都是有明確類型的。
第三,元數(shù)據(jù)需要編譯器之外的工具額外的處理用來生成其它的程序部件。
第四,元數(shù)據(jù)可以只存在于Java源代碼級(jí)別,也可以存在于編譯之后的Class文件內(nèi)部。
?Annotation和Annotation類型:
Annotation:
Annotation使用了在java5.0所帶來的新語法,它的行為十分類似public、final這樣的修飾符。每個(gè)Annotation具有一個(gè)名字和成員個(gè)數(shù)>=0。每個(gè)Annotation的成員具有被稱為name=value對(duì)的名字和值(就像javabean一樣),name=value裝載了Annotation的信息。
Annotation類型:
Annotation類型定義了Annotation的名字、類型、成員默認(rèn)值。一個(gè)Annotation類型可以說是一個(gè)特殊的java接口,它的成員變量是受限制的,而聲明Annotation類型時(shí)需要使用新語法。當(dāng)我們通過java反射api訪問Annotation時(shí),返回值將是一個(gè)實(shí)現(xiàn)了該 annotation類型接口的對(duì)象,通過訪問這個(gè)對(duì)象我們能方便的訪問到其Annotation成員。后面的章節(jié)將提到在java5.0的 java.lang包里包含的3個(gè)標(biāo)準(zhǔn)Annotation類型。
注解的分類:
根據(jù)注解參數(shù)的個(gè)數(shù),我們可以將注解分為三類:
1.標(biāo)記注解:一個(gè)沒有成員定義的Annotation類型被稱為標(biāo)記注解。這種Annotation類型僅使用自身的存在與否來為我們提供信息。比如后面的系統(tǒng)注解@Override;
2.單值注解
3.完整注解
根據(jù)注解使用方法和用途,我們可以將Annotation分為三類:
1.JDK內(nèi)置系統(tǒng)注解
2.元注解
3.自定義注解
?系統(tǒng)內(nèi)置標(biāo)準(zhǔn)注解:
注解的語法比較簡(jiǎn)單,除了@符號(hào)的使用外,他基本與Java固有的語法一致,JavaSE中內(nèi)置三個(gè)標(biāo)準(zhǔn)注解,定義在java.lang中:
@Override:用于修飾此方法覆蓋了父類的方法;
@Deprecated:用于修飾已經(jīng)過時(shí)的方法;
@SuppressWarnnings:用于通知java編譯器禁止特定的編譯警告。
下面我們依次看看三個(gè)內(nèi)置標(biāo)準(zhǔn)注解的作用和使用場(chǎng)景。
? @Override,限定重寫父類方法:
@Override 是一個(gè)標(biāo)記注解類型,它被用作標(biāo)注方法。它說明了被標(biāo)注的方法重載了父類的方法,起到了斷言的作用。如果我們使用了這種Annotation在一個(gè)沒有覆蓋父類方法的方法時(shí),java編譯器將以一個(gè)編譯錯(cuò)誤來警示。這個(gè)annotaton常常在我們?cè)噲D覆蓋父類方法而確又寫錯(cuò)了方法名時(shí)發(fā)揮威力。使用方法極其簡(jiǎn)單:在使用此annotation時(shí)只要在被修飾的方法前面加上@Override即可。下面的代碼是一個(gè)使用@Override修飾一個(gè)企圖重載父類的displayName()方法,而又存在拼寫錯(cuò)誤的實(shí)例:
public class Fruit {public void displayName(){System.out.println("水果的名字是:*****");} }class Orange extends Fruit {@Overridepublic void displayName(){System.out.println("水果的名字是:桔子");} }class Apple extends Fruit {@Overridepublic void displayname(){System.out.println("水果的名字是:蘋果");} } Orange 類編譯不會(huì)有任何問題,Apple 類在編譯的時(shí)候會(huì)提示相應(yīng)的錯(cuò)誤。@Override注解只能用于方法,不能用于其他程序元素。@Deprecated,標(biāo)記已過時(shí):
同 樣Deprecated也是一個(gè)標(biāo)記注解。當(dāng)一個(gè)類型或者類型成員使用@Deprecated修飾的話,編譯器將不鼓勵(lì)使用這個(gè)被標(biāo)注的程序元素。而且這種修飾具有一定的 “延續(xù)性”:如果我們?cè)诖a中通過繼承或者覆蓋的方式使用了這個(gè)過時(shí)的類型或者成員,雖然繼承或者覆蓋后的類型或者成員并不是被聲明為 @Deprecated,但編譯器仍然要報(bào)警。
值得注意,@Deprecated這個(gè)annotation類型和javadoc中的 @deprecated這個(gè)tag是有區(qū)別的:前者是java編譯器識(shí)別的,而后者是被javadoc工具所識(shí)別用來生成文檔(包含程序成員為什么已經(jīng)過 時(shí)、它應(yīng)當(dāng)如何被禁止或者替代的描述)。
在java5.0,java編譯器仍然象其從前版本那樣尋找@deprecated這個(gè)javadoc tag,并使用它們產(chǎn)生警告信息。但是這種狀況將在后續(xù)版本中改變,我們應(yīng)在現(xiàn)在就開始使用@Deprecated來修飾過時(shí)的方法而不是 @deprecated javadoc tag。
下面一段程序中使用了@Deprecated注解標(biāo)示方法過期,同時(shí)在方法注釋中用@deprecated tag 標(biāo)示該方法已經(jīng)過時(shí),代碼如下:
class AppleService {public void displayName(){System.out.println("水果的名字是:蘋果");}/*** @deprecated 該方法已經(jīng)過期,不推薦使用*/@Deprecatedpublic void showTaste(){System.out.println("水果的蘋果的口感是:脆甜");}public void showTaste(int typeId){if(typeId==1){System.out.println("水果的蘋果的口感是:酸澀");}else if(typeId==2){System.out.println("水果的蘋果的口感是:綿甜");}else{System.out.println("水果的蘋果的口感是:脆甜");}} }public class FruitRun {/*** @param args*/public static void main(String[] args) {Apple apple=new Apple();apple.displayName(); AppleService appleService=new AppleService();appleService.showTaste();appleService.showTaste(0);appleService.showTaste(2);}}AppleService類的showTaste() 方法被@Deprecated標(biāo)注為過時(shí)方法,在FruitRun類中使用的時(shí)候,編譯器會(huì)給出該方法已過期,不推薦使用的提示。
SuppressWarnnings,抑制編譯器警告:
@SuppressWarnings 被用于有選擇的關(guān)閉編譯器對(duì)類、方法、成員變量、變量初始化的警告。在java5.0,sun提供的javac編譯器為我們提供了-Xlint選項(xiàng)來使編譯器對(duì)合法的程序代碼提出警告,此種警告從某種程度上代表了程序錯(cuò)誤。例如當(dāng)我們使用一個(gè)generic collection類而又沒有提供它的類型時(shí),編譯器將提示出"unchecked warning"的警告。通常當(dāng)這種情況發(fā)生時(shí),我們就需要查找引起警告的代碼。如果它真的表示錯(cuò)誤,我們就需要糾正它。例如如果警告信息表明我們代碼中的switch語句沒有覆蓋所有可能的case,那么我們就應(yīng)增加一個(gè)默認(rèn)的case來避免這種警告。
有時(shí)我們無法避免這種警告,例如,我們使用必須和非generic的舊代碼交互的generic collection類時(shí),我們不能避免這個(gè)unchecked warning。此時(shí)@SuppressWarning就要派上用場(chǎng)了,在調(diào)用的方法前增加@SuppressWarnings修飾,告訴編譯器停止對(duì)此方法的警告。
SuppressWarning不是一個(gè)標(biāo)記注解。它有一個(gè)類型為String[]的成員,這個(gè)成員的值為被禁止的警告名。對(duì)于javac編譯器來講,被-Xlint選項(xiàng)有效的警告 名也同樣對(duì)@SuppressWarings有效,同時(shí)編譯器忽略掉無法識(shí)別的警告名。
annotation語法允許在annotation名后跟括號(hào),括號(hào)中是使用逗號(hào)分割的name=value對(duì)用于為annotation的成員賦值。實(shí)例如下:
在這個(gè)例子中SuppressWarnings annotation類型只定義了一個(gè)單一的成員,所以只有一個(gè)簡(jiǎn)單的value={...}作為name=value對(duì)。又由于成員值是一個(gè)數(shù)組,故使用大括號(hào)來聲明數(shù)組值。注意:我們可以在下面的情況中縮寫annotation:當(dāng)annotation只有單一成員,并成員命名為"value="。這時(shí)可以省去"value="。比如將上面方法getFruit()的SuppressWarnings annotation就是縮寫的。
? ?SuppressWarnings注解的常見參數(shù)值的簡(jiǎn)單說明:
1.deprecation:使用了不贊成使用的類或方法時(shí)的警告;
2.unchecked:執(zhí)行了未檢查的轉(zhuǎn)換時(shí)的警告,例如當(dāng)使用集合時(shí)沒有用泛型 (Generics) 來指定集合保存的類型;?
3.fallthrough:當(dāng) Switch 程序塊直接通往下一種情況而沒有 Break 時(shí)的警告;
4.path:在類路徑、源文件路徑等中有不存在的路徑時(shí)的警告;?
5.serial:當(dāng)在可序列化的類上缺少 serialVersionUID 定義時(shí)的警告;?
6.finally:任何 finally 子句不能正常完成時(shí)的警告;?
7.all:關(guān)于以上所有情況的警告。
深入理解Java:注解(Annotation)自定義注解入門
要深入學(xué)習(xí)注解,我們就必須能定義自己的注解,并使用注解,在定義自己的注解之前,我們就必須要了解Java為我們提供的元注解和相關(guān)定義注解的語法。
元注解:
元注解的作用就是負(fù)責(zé)注解其他注解。Java5.0定義了4個(gè)標(biāo)準(zhǔn)的meta-annotation類型,它們被用來提供對(duì)其它 annotation類型作說明。Java5.0定義的元注解:
1.@Target,
2.@Retention,
3.@Documented,
4.@Inherited
這些類型和它們所支持的類在java.lang.annotation包中可以找到。下面我們看一下每個(gè)元注解的作用和相應(yīng)分參數(shù)的使用說明。
@Target:
@Target說明了Annotation所修飾的對(duì)象范圍:Annotation可被用于 packages、types(類、接口、枚舉、Annotation類型)、類型成員(方法、構(gòu)造方法、成員變量、枚舉值)、方法參數(shù)和本地變量(如循環(huán)變量、catch參數(shù))。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標(biāo)。
作用:用于描述注解的使用范圍(即:被描述的注解可以用在什么地方)
取值(ElementType)有:
1.CONSTRUCTOR:用于描述構(gòu)造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部變量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述參數(shù)
7.TYPE:用于描述類、接口(包括注解類型) 或enum聲明
使用實(shí)例:
@Target(ElementType.TYPE) public @interface Table {/*** 數(shù)據(jù)表名稱注解,默認(rèn)值為類名稱* @return*/public String tableName() default "className"; }@Target(ElementType.FIELD) public @interface NoDBColumn {}注解Table 可以用于注解類、接口(包括注解類型) 或enum聲明,而注解NoDBColumn僅可用于注解類的成員變量。
@Retention:
@Retention定義了該Annotation被保留的時(shí)間長(zhǎng)短:某些Annotation僅出現(xiàn)在源代碼中,而被編譯器丟棄;而另一些卻被編譯在class文件中;編譯在class文件中的Annotation可能會(huì)被虛擬機(jī)忽略,而另一些在class被裝載時(shí)將被讀取(請(qǐng)注意并不影響class的執(zhí)行,因?yàn)锳nnotation與class在使用上是被分離的)。使用這個(gè)meta-Annotation可以對(duì) Annotation的“生命周期”限制。
作用:表示需要在什么級(jí)別保存該注釋信息,用于描述注解的生命周期(即:被描述的注解在什么范圍內(nèi)有效)
取值(RetentionPoicy)有:
1.SOURCE:在源文件中有效(即源文件保留)
2.CLASS:在class文件中有效(即class保留)
3.RUNTIME:在運(yùn)行時(shí)有效(即運(yùn)行時(shí)保留)
Retention meta-annotation類型有唯一的value作為成員,它的取值來自java.lang.annotation.RetentionPolicy的枚舉類型值。具體實(shí)例如下:
@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) public @interface Column {public String name() default "fieldName";public String setFuncName() default "setField";public String getFuncName() default "getField"; public boolean defaultDBValue() default false; }? Column注解的的RetentionPolicy的屬性值是RUTIME,這樣注解處理器可以通過反射,獲取到該注解的屬性值,從而去做一些運(yùn)行時(shí)的邏輯處理
@Documented:
@Documented用于描述其它類型的annotation應(yīng)該被作為被標(biāo)注的程序成員的公共API,因此可以被例如javadoc此類的工具文檔化。Documented是一個(gè)標(biāo)記注解,沒有成員。
@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Column {public String name() default "fieldName";public String setFuncName() default "setField";public String getFuncName() default "getField"; public boolean defaultDBValue() default false; }@Inherited:
@Inherited 元注解是一個(gè)標(biāo)記注解,@Inherited闡述了某個(gè)被標(biāo)注的類型是被繼承的。如果一個(gè)使用了@Inherited修飾的annotation類型被用于一個(gè)class,則這個(gè)annotation將被用于該class的子類。
注意:@Inherited annotation類型是被標(biāo)注過的class的子類所繼承。類并不從它所實(shí)現(xiàn)的接口繼承annotation,方法并不從它所重載的方法繼承annotation。
當(dāng)@Inherited annotation類型標(biāo)注的annotation的Retention是RetentionPolicy.RUNTIME,則反射API增強(qiáng)了這種繼承性。如果我們使用java.lang.reflect去查詢一個(gè)@Inherited annotation類型的annotation時(shí),反射代碼檢查將展開工作:檢查class和其父類,直到發(fā)現(xiàn)指定的annotation類型被發(fā)現(xiàn),或者到達(dá)類繼承結(jié)構(gòu)的頂層。
實(shí)例代碼:
/*** * @author peida**/ @Inherited public @interface Greeting {public enum FontColor{ BULE,RED,GREEN};String name();FontColor fontColor() default FontColor.GREEN; }自定義注解:
使用@interface自定義注解時(shí),自動(dòng)繼承了java.lang.annotation.Annotation接口,由編譯程序自動(dòng)完成其他細(xì)節(jié)。在定義注解時(shí),不能繼承其他的注解或接口。@interface用來聲明一個(gè)注解,其中的每一個(gè)方法實(shí)際上是聲明了一個(gè)配置參數(shù)。方法的名稱就是參數(shù)的名稱,返回值類型就是參數(shù)的類型(返回值類型只能是基本類型、Class、String、enum)。可以通過default來聲明參數(shù)的默認(rèn)值。
定義注解格式:
public?@interface 注解名 {定義體}
注解參數(shù)的可支持?jǐn)?shù)據(jù)類型:
1.所有基本數(shù)據(jù)類型(int,float,boolean,byte,double,char,long,short)
2.String類型
3.Class類型
4.enum類型
5.Annotation類型
6.以上所有類型的數(shù)組
Annotation類型里面的參數(shù)該怎么設(shè)定:?
第一,只能用public或默認(rèn)(default)這兩個(gè)訪問權(quán)修飾.例如,String value();這里把方法設(shè)為defaul默認(rèn)類型;
第二,參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和 String,Enum,Class,annotations等數(shù)據(jù)類型,以及這一些類型的數(shù)組.例如,String value();這里的參數(shù)成員就為String;
第三,如果只有一個(gè)參數(shù)成員,最好把參數(shù)名稱設(shè)為"value",后加小括號(hào).例:下面的例子FruitName注解就只有一個(gè)參數(shù)成員。
簡(jiǎn)單的自定義注解和使用注解實(shí)例:
package annotation;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;/*** 水果名稱注解* @author peida**/ @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface FruitName {String value() default ""; } package annotation;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;/*** 水果顏色注解* @author peida**/ @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface FruitColor {/*** 顏色枚舉* @author peida**/public enum Color{ BULE,RED,GREEN};/*** 顏色屬性* @return*/Color fruitColor() default Color.GREEN;} package annotation;import annotation.FruitColor.Color;public class Apple {@FruitName("Apple")private String appleName;@FruitColor(fruitColor=Color.RED)private String appleColor;public void setAppleColor(String appleColor) {this.appleColor = appleColor;}public String getAppleColor() {return appleColor;}public void setAppleName(String appleName) {this.appleName = appleName;}public String getAppleName() {return appleName;}public void displayName(){System.out.println("水果的名字是:蘋果");} }注解元素的默認(rèn)值:
注解元素必須有確定的值,要么在定義注解的默認(rèn)值中指定,要么在使用注解時(shí)指定,非基本類型的注解元素的值不可為null。因此, 使用空字符串或0作為默認(rèn)值是一種常用的做法。這個(gè)約束使得處理器很難表現(xiàn)一個(gè)元素的存在或缺失的狀態(tài),因?yàn)槊總€(gè)注解的聲明中,所有元素都存在,并且都具有相應(yīng)的值,為了繞開這個(gè)約束,我們只能定義一些特殊的值,例如空字符串或者負(fù)數(shù),一次表示某個(gè)元素不存在,在定義注解時(shí),這已經(jīng)成為一個(gè)習(xí)慣用法。例如:
1 package annotation; 2 3 import java.lang.annotation.Documented; 4 import java.lang.annotation.ElementType; 5 import java.lang.annotation.Retention; 6 import java.lang.annotation.RetentionPolicy; 7 import java.lang.annotation.Target; 8 9 /** 10 * 水果供應(yīng)者注解 11 * @author peida 12 * 13 */ 14 @Target(ElementType.FIELD) 15 @Retention(RetentionPolicy.RUNTIME) 16 @Documented 17 public @interface FruitProvider { 18 /** 19 * 供應(yīng)商編號(hào) 20 * @return 21 */ 22 public int id() default -1; 23 24 /** 25 * 供應(yīng)商名稱 26 * @return 27 */ 28 public String name() default ""; 29 30 /** 31 * 供應(yīng)商地址 32 * @return 33 */ 34 public String address() default ""; 35 }?
定義了注解,并在需要的時(shí)候給相關(guān)類,類屬性加上注解信息,如果沒有響應(yīng)的注解信息處理流程,注解可以說是沒有實(shí)用價(jià)值。如何讓注解真真的發(fā)揮作用,主要就在于注解處理方法,下一步我們將學(xué)習(xí)注解信息的獲取和處理!
深入理解Java:注解(Annotation)--注解處理器
如果沒有用來讀取注解的方法和工作,那么注解也就不會(huì)比注釋更有用處了。使用注解的過程中,很重要的一部分就是創(chuàng)建于使用注解處理器。Java SE5擴(kuò)展了反射機(jī)制的API,以幫助程序員快速的構(gòu)造自定義注解處理器。
注解處理器類庫(kù)(java.lang.reflect.AnnotatedElement):
Java使用Annotation接口來代表程序元素前面的注解,該接口是所有Annotation類型的父接口。除此之外,Java在java.lang.reflect 包下新增了AnnotatedElement接口,該接口代表程序中可以接受注解的程序元素,該接口主要有如下幾個(gè)實(shí)現(xiàn)類:
Class:類定義
Constructor:構(gòu)造器定義
Field:累的成員變量定義
Method:類的方法定義
Package:類的包定義
java.lang.reflect 包下主要包含一些實(shí)現(xiàn)反射功能的工具類,實(shí)際上,java.lang.reflect 包所有提供的反射API擴(kuò)充了讀取運(yùn)行時(shí)Annotation信息的能力。當(dāng)一個(gè)Annotation類型被定義為運(yùn)行時(shí)的Annotation后,該注解才能是運(yùn)行時(shí)可見,當(dāng)class文件被裝載時(shí)被保存在class文件中的Annotation才會(huì)被虛擬機(jī)讀取。
AnnotatedElement 接口是所有程序元素(Class、Method和Constructor)的父接口,所以程序通過反射獲取了某個(gè)類的AnnotatedElement對(duì)象之后,程序就可以調(diào)用該對(duì)象的如下四個(gè)個(gè)方法來訪問Annotation信息:
方法1:<T extends Annotation> T getAnnotation(Class<T> annotationClass): 返回改程序元素上存在的、指定類型的注解,如果該類型注解不存在,則返回null。
方法2:Annotation[] getAnnotations():返回該程序元素上存在的所有注解。
方法3:boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判斷該程序元素上是否包含指定類型的注解,存在則返回true,否則返回false.
方法4:Annotation[] getDeclaredAnnotations():返回直接存在于此元素上的所有注釋。與此接口中的其他方法不同,該方法將忽略繼承的注釋。(如果沒有注釋直接存在于此元素上,則返回長(zhǎng)度為零的一個(gè)數(shù)組。)該方法的調(diào)用者可以隨意修改返回的數(shù)組;這不會(huì)對(duì)其他調(diào)用者返回的數(shù)組產(chǎn)生任何影響。
一個(gè)簡(jiǎn)單的注解處理器:
/***********注解聲明***************//*** 水果名稱注解* @author peida**/ @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface FruitName {String value() default ""; }/*** 水果顏色注解* @author peida**/ @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface FruitColor {/*** 顏色枚舉* @author peida**/public enum Color{ BULE,RED,GREEN};/*** 顏色屬性* @return*/Color fruitColor() default Color.GREEN;}/*** 水果供應(yīng)者注解* @author peida**/ @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface FruitProvider {/*** 供應(yīng)商編號(hào)* @return*/public int id() default -1;/*** 供應(yīng)商名稱* @return*/public String name() default "";/*** 供應(yīng)商地址* @return*/public String address() default ""; }/***********注解使用***************/public class Apple {@FruitName("Apple")private String appleName;@FruitColor(fruitColor=Color.RED)private String appleColor;@FruitProvider(id=1,name="陜西紅富士集團(tuán)",address="陜西省西安市延安路89號(hào)紅富士大廈")private String appleProvider;public void setAppleColor(String appleColor) {this.appleColor = appleColor;}public String getAppleColor() {return appleColor;}public void setAppleName(String appleName) {this.appleName = appleName;}public String getAppleName() {return appleName;}public void setAppleProvider(String appleProvider) {this.appleProvider = appleProvider;}public String getAppleProvider() {return appleProvider;}public void displayName(){System.out.println("水果的名字是:蘋果");} }/***********注解處理器***************/public class FruitInfoUtil {public static void getFruitInfo(Class<?> clazz){String strFruitName=" 水果名稱:";String strFruitColor=" 水果顏色:";String strFruitProvicer="供應(yīng)商信息:";Field[] fields = clazz.getDeclaredFields();for(Field field :fields){if(field.isAnnotationPresent(FruitName.class)){FruitName fruitName = (FruitName) field.getAnnotation(FruitName.class);strFruitName=strFruitName+fruitName.value();System.out.println(strFruitName);}else if(field.isAnnotationPresent(FruitColor.class)){FruitColor fruitColor= (FruitColor) field.getAnnotation(FruitColor.class);strFruitColor=strFruitColor+fruitColor.fruitColor().toString();System.out.println(strFruitColor);}else if(field.isAnnotationPresent(FruitProvider.class)){FruitProvider fruitProvider= (FruitProvider) field.getAnnotation(FruitProvider.class);strFruitProvicer=" 供應(yīng)商編號(hào):"+fruitProvider.id()+" 供應(yīng)商名稱:"+fruitProvider.name()+" 供應(yīng)商地址:"+fruitProvider.address();System.out.println(strFruitProvicer);}}} }/***********輸出結(jié)果***************/ public class FruitRun {/*** @param args*/public static void main(String[] args) {FruitInfoUtil.getFruitInfo(Apple.class);}}====================================水果名稱:Apple水果顏色:RED供應(yīng)商編號(hào):1 供應(yīng)商名稱:陜西紅富士集團(tuán) 供應(yīng)商地址:陜西省西安市延安路89號(hào)紅富士大廈? Java注解的基礎(chǔ)知識(shí)點(diǎn)(見下面導(dǎo)圖)基本都過了一遍,下一篇我們通過設(shè)計(jì)一個(gè)基于注解的簡(jiǎn)單的ORM框架,來綜合應(yīng)用和進(jìn)一步加深對(duì)注解的各個(gè)知識(shí)點(diǎn)的理解和運(yùn)用。
引用博客:peida?- 博客園? 地址:http://www.cnblogs.com/peida/archive/2013/04/26/3038503.html總結(jié)
以上是生活随笔為你收集整理的深入理解Java:注解(Annotation)基本概念、自定义注解、注解解析器的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: JQuery预加载的四种种方式
- 下一篇: java美元兑换,(Java实现) 美元