理解Java基礎(chǔ)之注解Annotation
一、概念
Annontation是Java5開(kāi)始引入的新特征。中文名稱一般叫注解。它提供了一種安全的類似注釋的機(jī)制,用來(lái)將任何的信息或元數(shù)據(jù)(metadata)與程序元素(類、方法、成員變量等)進(jìn)行關(guān)聯(lián)。
更通俗的意思是為程序的元素(類、方法、成員變量)加上更直觀更明了的說(shuō)明,這些說(shuō)明信息是與程序的業(yè)務(wù)邏輯無(wú)關(guān),并且是供指定的工具或框架使用的。
Annontation像一種修飾符一樣,應(yīng)用于包、類型、構(gòu)造方法、方法、成員變量、參數(shù)及本地變量的聲明語(yǔ)句中。
二、原理
Annotation其實(shí)是一種接口。通過(guò)Java的反射機(jī)制相關(guān)的API來(lái)訪問(wèn)annotation信息。相關(guān)類(框架或工具中的類)根據(jù)這些信息來(lái)決定如何使用該程序元素或改變它們的行為。
annotation是不會(huì)影響程序代碼的執(zhí)行,無(wú)論annotation怎么變化,代碼都始終如一地執(zhí)行。
Java語(yǔ)言解釋器在工作時(shí)會(huì)忽略這些annotation,因此在JVM 中這些annotation是“不起作用”的,只能通過(guò)配套的工具才能對(duì)這些annontaion類型的信息進(jìn)行訪問(wèn)和處理。
Annotation與interface的異同:
1)、Annotation類型使用關(guān)鍵字@interface而不是interface。
這個(gè)關(guān)鍵字聲明隱含了一個(gè)信息:它是繼承了java.lang.annotation.Annotation接口,并非聲明了一個(gè)interface
2)、Annotation類型、方法定義是獨(dú)特的、受限制的。
Annotation類型的方法必須聲明為無(wú)參數(shù)、無(wú)異常拋出的。這些方法定義了annotation的成員:方法名成為了成員名,而方法返回值成為了成員的類型。而方法返回值類型必須為primitive類型、Class類型、枚舉類型、annotation類型或者由前面類型之一作為元素的一維數(shù)組。方法的后面可以使用default和一個(gè)默認(rèn)數(shù)值來(lái)聲明成員的默認(rèn)值,null不能作為成員默認(rèn)值,這與我們?cè)诜莂nnotation類型中定義方法有很大不同。
Annotation類型和它的方法不能使用annotation類型的參數(shù)、成員不能是generic。只有返回值類型是Class的方法可以在annotation類型中使用generic,因?yàn)榇朔椒軌蛴妙愞D(zhuǎn)換將各種類型轉(zhuǎn)換為Class。
3)、Annotation類型又與接口有著近似之處。
它們可以定義常量、靜態(tài)成員類型(比如枚舉類型定義)。Annotation類型也可以如接口一般被實(shí)現(xiàn)或者繼承。
三、應(yīng)用場(chǎng)合
annotation一般作為一種輔助途徑,應(yīng)用在軟件框架或工具中,在這些工具類中根據(jù)不同的annontation注解信息采取不同的處理過(guò)程或改變相應(yīng)程序元素(類、方法及成員變量等)的行為。
例如:Junit、Struts、Spring等流行工具框架中均廣泛使用了annontion。使代碼的靈活性大提高。
四、常見(jiàn)標(biāo)準(zhǔn)的Annotation
從java5版本開(kāi)始,自帶了三種標(biāo)準(zhǔn)annontation類型,
?。?)、Override
java.lang.Override是一個(gè)marker annotation類型,它被用作標(biāo)注方法。它說(shuō)明了被標(biāo)注的方法重載了父類的方法,起到了斷言的作用。如果我們使用了這種annotation在一個(gè)沒(méi)有覆蓋父類方法的方法時(shí),java編譯器將以一個(gè)編譯錯(cuò)誤來(lái)警示。
這個(gè)annotaton常常在我們?cè)噲D覆蓋父類方法而確又寫錯(cuò)了方法名時(shí)加一個(gè)保障性的校驗(yàn)過(guò)程。
?。?)、Deprecated
Deprecated也是一種marker annotation。當(dāng)一個(gè)類型或者類型成員使用@Deprecated修飾的話,編譯器將不鼓勵(lì)使用這個(gè)被標(biāo)注的程序元素。所以使用這種修飾具有一定的“延續(xù)性”:如果我們?cè)诖a中通過(guò)繼承或者覆蓋的方式使用了這個(gè)過(guò)時(shí)的類型或者成員,雖然繼承或者覆蓋后的類型或者成員并不是被聲明為@Deprecated,但編譯器仍然要報(bào)警。
注意:@Deprecated這個(gè)annotation類型和javadoc中的@deprecated這個(gè)tag是有區(qū)別的:前者是java編譯器識(shí)別的,而后者是被javadoc工具所識(shí)別用來(lái)生成文檔(包含程序成員為什么已經(jīng)過(guò)時(shí)、它應(yīng)當(dāng)如何被禁止或者替代的描述)。
?。?)、SuppressWarnings
此注解能告訴Java編譯器關(guān)閉對(duì)類、方法及成員變量的警告。
有時(shí)編譯時(shí)會(huì)提出一些警告,對(duì)于這些警告有的隱藏著B(niǎo)ug,有的是無(wú)法避免的,對(duì)于某些不想看到的警告信息,可以通過(guò)這個(gè)注解來(lái)屏蔽。
SuppressWarning不是一個(gè)marker annotation。它有一個(gè)類型為String[]的成員,這個(gè)成員的值為被禁止的警告名。對(duì)于javac編譯器來(lái)講,被-Xlint選項(xiàng)有效的警告名也同樣對(duì)@SuppressWarings有效,同時(shí)編譯器忽略掉無(wú)法識(shí)別的警告名。
annotation語(yǔ)法允許在annotation名后跟括號(hào),括號(hào)中是使用逗號(hào)分割的name=value對(duì)用于為annotation的成員賦值:
代碼:
- @SuppressWarnings(value={"unchecked","fallthrough"})
- publicvoidlintTrap() {
- /*sloppy method body omitted */}
在這個(gè)例子中SuppressWarnings annotation類型只定義了一個(gè)單一的成員,所以只有一個(gè)簡(jiǎn)單的value={...}作為name=value對(duì)。又由于成員值是一個(gè)數(shù)組,故使用大括號(hào)來(lái)聲明數(shù)組值。
注意:我們可以在下面的情況中縮寫annotation:當(dāng)annotation只有單一成員,并成員命名為"value="。這時(shí)可以省去"value="。比如將上面的SuppressWarnings annotation進(jìn)行縮寫:
代碼:
- @SuppressWarnings("unchecked")
如果SuppressWarnings所聲明的被禁止警告?zhèn)€數(shù)為一個(gè)時(shí),可以省去大括號(hào):
- @SuppressWarnings("unchecked")
五、自定義annontation示例
示例共涉及四個(gè)類:
清單1:Author.java
- packagecom.magc.annotation;
- importjava.lang.annotation.Documented;
- importjava.lang.annotation.ElementType;
- importjava.lang.annotation.Retention;
- importjava.lang.annotation.RetentionPolicy;
- importjava.lang.annotation.Target;
- /*** 定義作者信息,name和group
- * @authormagc
- **/@Retention(RetentionPolicy.RUNTIME)
- @Target(ElementType.METHOD)
- @Documentedpublic@interfaceAuthor {
- String name();
- String group();
- }
清單2:Description.java
- /*** */
- packagecom.magc.annotation;
- importjava.lang.annotation.Documented;
- importjava.lang.annotation.ElementType;
- importjava.lang.annotation.Retention;
- importjava.lang.annotation.RetentionPolicy;
- importjava.lang.annotation.Target;
- /*** @authormagc
- *
- * 定義描述信息 value*/@Retention(RetentionPolicy.RUNTIME)
- @Target(ElementType.TYPE)
- @Documentedpublic@interfaceDescription {
- String value();
- }
清單3:Utility.java
- packagecom.magc.annotation;
- @Description(value ="這是一個(gè)有用的工具類")publicclassUtility {
- @Author(name ="haoran_202",group="com.magc")publicString work()
- {return"work over!";
- }
- }
注:這是個(gè)普通的Java類,運(yùn)行了@Description和@Author注解。
清單3:AnalysisAnnotation.java
- packagecom.magc.annotation;
- importjava.lang.reflect.Method;
- publicclassAnalysisAnnotation {
- /*** 在運(yùn)行時(shí)分析處理annotation類型的信息
- *
- * */
- publicstaticvoidmain(String[] args)
- {try{//通過(guò)運(yùn)行時(shí)反射API獲得annotation信息
- Class rt_class =Class.forName("com.magc.annotation.Utility");
- Method[] methods =rt_class.getMethods();
- booleanflag =rt_class.isAnnotationPresent(Description.class);
- if(flag)
- {
- Description description =(Description)rt_class.getAnnotation(Description.class);
- System.out.println("Utility's Description--->"+description.value());
- for(Method method : methods) {if(method.isAnnotationPresent(Author.class))
- {
- Author author =(Author)method.getAnnotation(Author.class);
- System.out.println("Utility's Author--->"+author.name()+"from "+author.group());
- }
- }
- }
- } catch(ClassNotFoundException e) {
- e.printStackTrace();
- }
- }
- }
注:這是個(gè)與自定義@Description和@Author配套的基礎(chǔ)框架或工具類,通過(guò)此類來(lái)獲得與普通Java類Utility.java關(guān)聯(lián)的信息,即描述和作者。
運(yùn)行AnalysisAnnotation,輸出結(jié)果為:
Utility's Description--->這是一個(gè)有用的工具類
Utility's Author--->haoran_202 from com.magc
原文鏈接:http://www.cnblogs.com/mandroid/archive/2011/07/18/2109829.html