自Java5.0版本引入注解之后鹏漆,它就成為了Java平臺中非常重要的一部分犹菇。開發(fā)過程中涯曲,我們也時常在應(yīng)用代碼中會看到諸如@Override,@Deprecated這樣的注解双吆。這篇文章中眨唬,我將向大家講述到底什么是注解,為什么要引入注解好乐,注解是如何工作的匾竿,如何編寫自定義的注解(通過例子),什么情況下可以使用注解以及最新注解和ADF(應(yīng)用開發(fā)框架)蔚万。這會花點(diǎn)兒時間岭妖,所以為自己準(zhǔn)備一杯咖啡,讓我們來進(jìn)入注解的世界吧。
什么是注解昵慌?
用一個詞就可以描述注解假夺,那就是元數(shù)據(jù),即一種描述數(shù)據(jù)的數(shù)據(jù)斋攀。所以已卷,可以說注解就是源代碼的元數(shù)據(jù)。比如淳蔼,下面這段代碼:
@Override public String toString() { return "This is String Representation of current object."; }
上面的代碼中侧蘸,我重寫了toString()方法并使用了@Override注解。但是鹉梨,即使我不使用@Override注解標(biāo)記代碼讳癌,程序也能夠正常執(zhí)行。那么俯画,該注解表示什么析桥?這么寫有什么好處嗎?事實(shí)上艰垂,@Override告訴編譯器這個方法是一個重寫方法(描述方法的元數(shù)據(jù))泡仗,如果父類中不存在該方法,編譯器便會報錯猜憎,提示該方法沒有重寫父類中的方法娩怎。如果我不小心拼寫錯誤,例如將toString()寫成了toStrring(){double r}胰柑,而且我也沒有使用@Override注解截亦,那程序依然能編譯運(yùn)行。但運(yùn)行結(jié)果會和我期望的大不相同〖硖郑現(xiàn)在我們了解了什么是注解崩瓤,并且使用注解有助于閱讀程序。
Annotation是一種應(yīng)用于類踩官、方法却桶、參數(shù)、變量蔗牡、構(gòu)造器及包聲明中的特殊修飾符颖系。它是一種由JSR-175標(biāo)準(zhǔn)選擇用來描述元數(shù)據(jù)的一種工具。
為什么要引入注解辩越?
使用Annotation之前(甚至在使用之后)嘁扼,XML被廣泛的應(yīng)用于描述元數(shù)據(jù)。不知何時開始一些應(yīng)用開發(fā)人員和架構(gòu)師發(fā)現(xiàn)XML的維護(hù)越來越糟糕了黔攒。他們希望使用一些和代碼緊耦合的東西趁啸,而不是像XML那樣和代碼是松耦合的(在某些情況下甚至是完全分離的)代碼描述强缘。如果你在Google中搜索“XML vs. annotations”,會看到許多關(guān)于這個問題的辯論莲绰。最有趣的是XML配置其實(shí)就是為了分離代碼和配置而引入的欺旧。上述兩種觀點(diǎn)可能會讓你很疑惑,兩者觀點(diǎn)似乎構(gòu)成了一種循環(huán)蛤签,但各有利弊辞友。下面我們通過一個例子來理解這兩者的區(qū)別。
假如你想為應(yīng)用設(shè)置很多的常量或參數(shù)震肮,這種情況下称龙,XML是一個很好的選擇,因?yàn)樗粫囟ǖ拇a相連戳晌。如果你想把某個方法聲明為服務(wù)鲫尊,那么使用Annotation會更好一些,因?yàn)檫@種情況下需要注解和方法緊密耦合起來沦偎,開發(fā)人員也必須認(rèn)識到這點(diǎn)疫向。
另一個很重要的因素是Annotation定義了一種標(biāo)準(zhǔn)的描述元數(shù)據(jù)的方式。在這之前豪嚎,開發(fā)人員通常使用他們自己的方式定義元數(shù)據(jù)搔驼。例如,使用標(biāo)記interfaces侈询,注釋舌涨,transient關(guān)鍵字等等。每個程序員按照自己的方式定義元數(shù)據(jù)扔字,而不像Annotation這種標(biāo)準(zhǔn)的方式囊嘉。
目前,許多框架將XML和Annotation兩種方式結(jié)合使用革为,平衡兩者之間的利弊扭粱。
Annotation是如何工作的?怎么編寫自定義的Annotation震檩?
在講述這部分之前琢蛤,建議你首先下載Annotation的示例代碼AnnotationsSample.zip 。下載之后放在你習(xí)慣使用的IDE中恳蹲,這些代碼會幫助你更好的理解Annotation機(jī)制。
編寫Annotation非常簡單俩滥,可以將Annotation的定義同接口的定義進(jìn)行比較嘉蕾。我們來看兩個例子:一個是標(biāo)準(zhǔn)的注解@Override,另一個是用戶自定義注解@Todo霜旧。
@Target(ElementType.METHOD) @Retention(RetentionPolicy.SOURCE) public @interface Override { }
對于@Override注釋你可能有些疑問错忱,它什么都沒做儡率,那它是如何檢查在父類中有一個同名的函數(shù)呢。當(dāng)然以清,不要驚訝儿普,我是逗你玩的。@Override注解的定義不僅僅只有這么一點(diǎn)代碼掷倔。這部分內(nèi)容很重要眉孩,我不得不再次重復(fù):Annotations僅僅是元數(shù)據(jù),和業(yè)務(wù)邏輯無關(guān)勒葱。理解起來有點(diǎn)困難浪汪,但就是這樣。如果Annotations不包含業(yè)務(wù)邏輯凛虽,那么必須有人來實(shí)現(xiàn)這些邏輯死遭。元數(shù)據(jù)的用戶來做這個事情。Annotations僅僅提供它定義的屬性(類/方法/包/域)的信息凯旋。Annotations的用戶(同樣是一些代碼)來讀取這些信息并實(shí)現(xiàn)必要的邏輯呀潭。
當(dāng)我們使用Java的標(biāo)注Annotations(例如@Override)時,JVM就是一個用戶至非,它在字節(jié)碼層面工作钠署。到這里,應(yīng)用開發(fā)人員還不能控制也不能使用自定義的注解睡蟋。因此踏幻,我們講解一下如何編寫自定義的Annotations。
我們來逐個講述編寫自定義Annotations的要點(diǎn)戳杀。上面的例子中该面,你看到一些注解應(yīng)用在注解上。
J2SE5.0版本在 java.lang.annotation提供了四種元注解信卡,專門注解其他的注解:
@Documented –注解是否將包含在JavaDoc中
@Retention –什么時候使用該注解
@Target? –注解用于什么地方
@Inherited – 是否允許子類繼承該注解
@Documented–一個簡單的Annotations標(biāo)記注解隔缀,表示是否將注解信息添加在java文檔中。
@Retention– 定義該注解的生命周期傍菇。
RetentionPolicy.SOURCE – 在編譯階段丟棄猾瘸。這些注解在編譯結(jié)束之后就不再有任何意義,所以它們不會寫入字節(jié)碼丢习。@Override, @SuppressWarnings都屬于這類注解牵触。
RetentionPolicy.CLASS – 在類加載的時候丟棄。在字節(jié)碼文件的處理中有用咐低。注解默認(rèn)使用這種方式揽思。
RetentionPolicy.RUNTIME– 始終不會丟棄,運(yùn)行期也保留該注解见擦,因此可以使用反射機(jī)制讀取該注解的信息钉汗。我們自定義的注解通常使用這種方式羹令。
@Target – 表示該注解用于什么地方。如果不明確指出损痰,該注解可以放在任何地方福侈。以下是一些可用的參數(shù)。需要說明的是:屬性的注解是兼容的卢未,如果你想給7個屬性都添加注解肪凛,僅僅排除一個屬性,那么你需要在定義target包含所有的屬性尝丐。
ElementType.TYPE:用于描述類显拜、接口或enum聲明
ElementType.FIELD:用于描述實(shí)例變量
ElementType.METHOD
ElementType.PARAMETER
ElementType.CONSTRUCTOR
ElementType.LOCAL_VARIABLE
ElementType.ANNOTATION_TYPE 另一個注釋
ElementType.PACKAGE 用于記錄java文件的package信息
@Inherited – 定義該注釋和子類的關(guān)系
那么,注解的內(nèi)部到底是如何定義的呢爹袁?Annotations只支持基本類型远荠、String及枚舉類型。注釋中所有的屬性被定義成方法失息,并允許提供默認(rèn)值譬淳。
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface Todo {
public enum Priority {LOW, MEDIUM, HIGH}
public enum Status {STARTED, NOT_STARTED}
String author() default "Yash";
Priority priority() default Priority.LOW;
Status status() default Status.NOT_STARTED;
}