Java中的注解是如何工作的土至?

01 ?04 ?17 ?12 ?19 ?31 32 37 ?(52期幸運(yùn)參考數(shù)字)

自Java5.0版本引入注解之后酒来,它就成為了Java平臺(tái)中非常重要的一部分。開(kāi)發(fā)過(guò)程中岂座,我們也時(shí)常在應(yīng)用代碼中會(huì)看到諸如@Override态蒂,@Deprecated這樣的注解。這篇文章中费什,我將向大家講述到底什么是注解钾恢,為什么要引入注解,注解是如何工作的鸳址,如何編寫自定義的注解(通過(guò)例子)瘩蚪,什么情況下可以使用注解以及最新注解和ADF(應(yīng)用開(kāi)發(fā)框架)。這會(huì)花點(diǎn)兒時(shí)間稿黍,所以為自己準(zhǔn)備一杯咖啡疹瘦,讓我們來(lái)進(jìn)入注解的世界吧。

什么是注解巡球?

用一個(gè)詞就可以描述注解言沐,那就是元數(shù)據(jù),即一種描述數(shù)據(jù)的數(shù)據(jù)酣栈。所以险胰,可以說(shuō)注解就是源代碼的元數(shù)據(jù)。比如矿筝,下面這段代碼:

上面的代碼中起便,我重寫了toString()方法并使用了@Override注解。但是,即使我不使用@Override注解標(biāo)記代碼榆综,程序也能夠正常執(zhí)行妙痹。那么,該注解表示什么?這么寫有什么好處嗎?事實(shí)上绿贞,@Override告訴編譯器這個(gè)方法是一個(gè)重寫方法(描述方法的元數(shù)據(jù))废登,如果父類中不存在該方法,編譯器便會(huì)報(bào)錯(cuò)利赋,提示該方法沒(méi)有重寫父類中的方法水评。如果我不小心拼寫錯(cuò)誤,例如將toString()寫成了toStrring(){double r}媚送,而且我也沒(méi)有使用@Override注解中燥,那程序依然能編譯運(yùn)行。但運(yùn)行結(jié)果會(huì)和我期望的大不相同√临耍現(xiàn)在我們了解了什么是注解疗涉,并且使用注解有助于閱讀程序。

Annotation是一種應(yīng)用于類吟秩、方法咱扣、參數(shù)、變量涵防、構(gòu)造器及包聲明中的特殊修飾符闹伪。它是一種由JSR-175標(biāo)準(zhǔn)選擇用來(lái)描述元數(shù)據(jù)的一種工具。

為什么要引入注解壮池?

使用Annotation之前(甚至在使用之后)偏瓤,XML被廣泛的應(yīng)用于描述元數(shù)據(jù)。不知何時(shí)開(kāi)始一些應(yīng)用開(kāi)發(fā)人員和架構(gòu)師發(fā)現(xiàn)XML的維護(hù)越來(lái)越糟糕了椰憋。他們希望使用一些和代碼緊耦合的東西厅克,而不是像XML那樣和代碼是松耦合的(在某些情況下甚至是完全分離的)代碼描述。

如果你在Google中搜索“XML vs. annotations”橙依,會(huì)看到許多關(guān)于這個(gè)問(wèn)題的辯論证舟。最有趣的是XML配置其實(shí)就是為了分離代碼和配置而引入的。上述兩種觀點(diǎn)可能會(huì)讓你很疑惑票编,兩者觀點(diǎn)似乎構(gòu)成了一種循環(huán)褪储,但各有利弊。下面我們通過(guò)一個(gè)例子來(lái)理解這兩者的區(qū)別慧域。

假如你想為應(yīng)用設(shè)置很多的常量或參數(shù)鲤竹,這種情況下,XML是一個(gè)很好的選擇,因?yàn)樗粫?huì)同特定的代碼相連辛藻。如果你想把某個(gè)方法聲明為服務(wù)碘橘,那么使用Annotation會(huì)更好一些,因?yàn)檫@種情況下需要注解和方法緊密耦合起來(lái)吱肌,開(kāi)發(fā)人員也必須認(rèn)識(shí)到這點(diǎn)痘拆。

另一個(gè)很重要的因素是Annotation定義了一種標(biāo)準(zhǔn)的描述元數(shù)據(jù)的方式。在這之前氮墨,開(kāi)發(fā)人員通常使用他們自己的方式定義元數(shù)據(jù)纺蛆。例如,使用標(biāo)記interfaces规揪,注釋桥氏,transient關(guān)鍵字等等。每個(gè)程序員按照自己的方式定義元數(shù)據(jù)猛铅,而不像Annotation這種標(biāo)準(zhǔn)的方式字支。

目前,許多框架將XML和Annotation兩種方式結(jié)合使用奸忽,平衡兩者之間的利弊堕伪。

Annotation是如何工作的?怎么編寫自定義的Annotation栗菜?

在講述這部分之前欠雌,建議你首先下載Annotation的示例代碼AnnotationsSample.zip 。下載之后放在你習(xí)慣使用的IDE中苛萎,這些代碼會(huì)幫助你更好的理解Annotation機(jī)制桨昙。

編寫Annotation非常簡(jiǎn)單,可以將Annotation的定義同接口的定義進(jìn)行比較腌歉。我們來(lái)看兩個(gè)例子:一個(gè)是標(biāo)準(zhǔn)的注解@Override蛙酪,另一個(gè)是用戶自定義注解@Todo。

對(duì)于@Override注釋你可能有些疑問(wèn)翘盖,它什么都沒(méi)做桂塞,那它是如何檢查在父類中有一個(gè)同名的函數(shù)呢。當(dāng)然馍驯,不要驚訝阁危,我是逗你玩的。

@Override注解的定義不僅僅只有這么一點(diǎn)代碼汰瘫。這部分內(nèi)容很重要狂打,我不得不再次重復(fù):Annotations僅僅是元數(shù)據(jù),和業(yè)務(wù)邏輯無(wú)關(guān)混弥。理解起來(lái)有點(diǎn)困難趴乡,但就是這樣。如果Annotations不包含業(yè)務(wù)邏輯,那么必須有人來(lái)實(shí)現(xiàn)這些邏輯晾捏。元數(shù)據(jù)的用戶來(lái)做這個(gè)事情蒿涎。

Annotations僅僅提供它定義的屬性(類/方法/包/域)的信息。Annotations的用戶(同樣是一些代碼)來(lái)讀取這些信息并實(shí)現(xiàn)必要的邏輯惦辛。

當(dāng)我們使用Java的標(biāo)注Annotations(例如@Override)時(shí)劳秋,JVM就是一個(gè)用戶,它在字節(jié)碼層面工作胖齐。到這里玻淑,應(yīng)用開(kāi)發(fā)人員還不能控制也不能使用自定義的注解。因此呀伙,我們講解一下如何編寫自定義的Annotations岁忘。

我們來(lái)逐個(gè)講述編寫自定義Annotations的要點(diǎn)。上面的例子中区匠,你看到一些注解應(yīng)用在注解上。

J2SE5.0版本在 java.lang.annotation提供了四種元注解帅腌,專門注解其他的注解:

@Documented –注解是否將包含在JavaDoc中

@Retention –什么時(shí)候使用該注解

@Target? –注解用于什么地方

@Inherited – 是否允許子類繼承該注解

@Documented–一個(gè)簡(jiǎn)單的Annotations標(biāo)記注解驰弄,表示是否將注解信息添加在java文檔中。

@Retention– 定義該注解的生命周期速客。

RetentionPolicy.SOURCE – 在編譯階段丟棄戚篙。這些注解在編譯結(jié)束之后就不再有任何意義,所以它們不會(huì)寫入字節(jié)碼溺职。@Override, @SuppressWarnings都屬于這類注解岔擂。

RetentionPolicy.CLASS – 在類加載的時(shí)候丟棄。在字節(jié)碼文件的處理中有用浪耘。注解默認(rèn)使用這種方式乱灵。

RetentionPolicy.RUNTIME– 始終不會(huì)丟棄,運(yùn)行期也保留該注解七冲,因此可以使用反射機(jī)制讀取該注解的信息痛倚。我們自定義的注解通常使用這種方式。

@Target – 表示該注解用于什么地方澜躺。如果不明確指出蝉稳,該注解可以放在任何地方。以下是一些可用的參數(shù)掘鄙。需要說(shuō)明的是:屬性的注解是兼容的耘戚,如果你想給7個(gè)屬性都添加注解,僅僅排除一個(gè)屬性操漠,那么你需要在定義target包含所有的屬性收津。

ElementType.TYPE:用于描述類、接口或enum聲明

ElementType.FIELD:用于描述實(shí)例變量

ElementType.METHOD

ElementType.PARAMETER

ElementType.CONSTRUCTOR

ElementType.LOCAL_VARIABLE

ElementType.ANNOTATION_TYPE 另一個(gè)注釋

ElementType.PACKAGE 用于記錄java文件的package信息

@Inherited?– 定義該注釋和子類的關(guān)系

那么,注解的內(nèi)部到底是如何定義的呢朋截?Annotations只支持基本類型蛹稍、String及枚舉類型。注釋中所有的屬性被定義成方法部服,并允許提供默認(rèn)值唆姐。

下面的例子演示了如何使用上面的注解。

如果注解中只有一個(gè)屬性廓八,可以直接命名為“value”奉芦,使用時(shí)無(wú)需再標(biāo)明屬性名。

但目前為止一切看起來(lái)都還不錯(cuò)剧蹂。我們定義了自己的注解并將其應(yīng)用在業(yè)務(wù)邏輯的方法上∩Γ現(xiàn)在我們需要寫一個(gè)用戶程序調(diào)用我們的注解。

這里我們需要使用反射機(jī)制宠叼。如果你熟悉反射代碼先巴,就會(huì)知道反射可以提供類名、方法和實(shí)例變量對(duì)象冒冬。所有這些對(duì)象都有g(shù)etAnnotation()這個(gè)方法用來(lái)返回注解信息伸蚯。

我們需要把這個(gè)對(duì)象轉(zhuǎn)換為我們自定義的注釋(使用 instanceOf()檢查之后),同時(shí)也可以調(diào)用自定義注釋里面的方法简烤〖劣剩看看以下的實(shí)例代碼,使用了上面的注解:

注解用例

注解的功能很強(qiáng)大横侦,Spring和Hebernate這些框架在日志和有效性中大量使用了注解功能挥萌。注解可以應(yīng)用在使用標(biāo)記接口的地方。不同的是標(biāo)記接口用來(lái)定義完整的類枉侧,但你可以為單個(gè)的方法定義注釋引瀑,例如是否將一個(gè)方法暴露為服務(wù)。

在最新的servlet3.0中引入了很多新的注解棵逊,尤其是和servlet安全相關(guān)的注解伤疙。

HandlesTypes –該注解用來(lái)表示一組傳遞給ServletContainerInitializer的應(yīng)用類。

HttpConstraint – 該注解代表所有HTTP方法的應(yīng)用請(qǐng)求的安全約束辆影,和ServletSecurity注釋中定義的HttpMethodConstraint安全約束不同徒像。

HttpMethodConstraint – 指明不同類型請(qǐng)求的安全約束,和ServletSecurity 注解中描述HTTP協(xié)議方法類型的注釋不同蛙讥。

MultipartConfig –該注解標(biāo)注在Servlet上面锯蛀,表示該Servlet希望處理的請(qǐng)求的 MIME 類型是 multipart/form-data。

ServletSecurity 該注解標(biāo)注在Servlet繼承類上面次慢,強(qiáng)制該HTTP協(xié)議請(qǐng)求遵循安全約束旁涤。

WebFilter – 該注解用來(lái)聲明一個(gè)Server過(guò)濾器翔曲;

WebInitParam – 該注解用來(lái)聲明Servlet或是過(guò)濾器的中的初始化參數(shù),通常配合 @WebServlet 或者 @WebFilter 使用劈愚。

WebListener –該注解為Web應(yīng)用程序上下文中不同類型的事件聲明監(jiān)聽(tīng)器瞳遍。

WebServlet –該注解用來(lái)聲明一個(gè)Servlet的配置。

ADF (應(yīng)用程序框架)和注解

現(xiàn)在我們開(kāi)始討論文章的最后一部分了菌羽。應(yīng)用程序框架掠械,被稱為ADF,由Oracle開(kāi)發(fā)用來(lái)創(chuàng)建Oracle融合應(yīng)用注祖。

我們已經(jīng)了解了注解的優(yōu)缺點(diǎn)猾蒂,也知道如何編寫自定義的注解,但我們應(yīng)該將注解應(yīng)用在ADF的哪部分呢是晨?ADF是否提供了一些樸素的注解肚菠?

很好的問(wèn)題,確實(shí)在ADF中大量使用注解有一些限制罩缴。之前提到的應(yīng)用框架如Spring和Hibernate使用AOP(面向側(cè)面的程序設(shè)計(jì))蚊逢。在AOP中,框架提供了一種機(jī)制箫章,在事件的預(yù)處理和后續(xù)處理中注入代碼时捌。

例如:你有一個(gè)鉤子用來(lái)在方法執(zhí)行之前和之后添加代碼,所以你可以在這些地方編寫你的用戶代碼炉抒。ADF不使用AOP。如果我們有任何注解的用例可用稚叹,我們可能需要通過(guò)繼承的方式實(shí)現(xiàn)焰薄。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市扒袖,隨后出現(xiàn)的幾起案子塞茅,更是在濱河造成了極大的恐慌,老刑警劉巖季率,帶你破解...
    沈念sama閱讀 216,372評(píng)論 6 498
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件野瘦,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡飒泻,警方通過(guò)查閱死者的電腦和手機(jī)鞭光,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,368評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)泞遗,“玉大人惰许,你說(shuō)我怎么就攤上這事∈氛蓿” “怎么了汹买?”我有些...
    開(kāi)封第一講書人閱讀 162,415評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵佩伤,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我晦毙,道長(zhǎng)生巡,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書人閱讀 58,157評(píng)論 1 292
  • 正文 為了忘掉前任见妒,我火速辦了婚禮孤荣,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘徐鹤。我一直安慰自己垃环,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,171評(píng)論 6 388
  • 文/花漫 我一把揭開(kāi)白布返敬。 她就那樣靜靜地躺著遂庄,像睡著了一般。 火紅的嫁衣襯著肌膚如雪劲赠。 梳的紋絲不亂的頭發(fā)上涛目,一...
    開(kāi)封第一講書人閱讀 51,125評(píng)論 1 297
  • 那天,我揣著相機(jī)與錄音凛澎,去河邊找鬼霹肝。 笑死,一個(gè)胖子當(dāng)著我的面吹牛塑煎,可吹牛的內(nèi)容都是我干的沫换。 我是一名探鬼主播,決...
    沈念sama閱讀 40,028評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼最铁,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼讯赏!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起冷尉,我...
    開(kāi)封第一講書人閱讀 38,887評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤漱挎,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后雀哨,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體磕谅,經(jīng)...
    沈念sama閱讀 45,310評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,533評(píng)論 2 332
  • 正文 我和宋清朗相戀三年雾棺,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了膊夹。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,690評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡捌浩,死狀恐怖割疾,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情嘉栓,我是刑警寧澤宏榕,帶...
    沈念sama閱讀 35,411評(píng)論 5 343
  • 正文 年R本政府宣布拓诸,位于F島的核電站,受9級(jí)特大地震影響麻昼,放射性物質(zhì)發(fā)生泄漏奠支。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,004評(píng)論 3 325
  • 文/蒙蒙 一抚芦、第九天 我趴在偏房一處隱蔽的房頂上張望倍谜。 院中可真熱鬧,春花似錦叉抡、人聲如沸尔崔。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 31,659評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)季春。三九已至,卻和暖如春消返,著一層夾襖步出監(jiān)牢的瞬間载弄,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 32,812評(píng)論 1 268
  • 我被黑心中介騙來(lái)泰國(guó)打工撵颊, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留宇攻,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,693評(píng)論 2 368
  • 正文 我出身青樓倡勇,卻偏偏與公主長(zhǎng)得像逞刷,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子妻熊,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,577評(píng)論 2 353

推薦閱讀更多精彩內(nèi)容