一篇文章掌握Java注解

什么是注解弱恒?


用一個詞就可以描述注解,那就是元數(shù)據(jù)烘跺,即一種描述數(shù)據(jù)的數(shù)據(jù)湘纵。所以,可以說注解就是源代碼的元數(shù)據(jù)滤淳。比如梧喷,下面這段代碼:


@OverridepublicStringtoString(){return"This is String Representation of current object.";}


上面的代碼中,我重寫了toString()方法并使用了@Override注解。但是铺敌,即使我不使用@Override注解標(biāo)記代碼汇歹,程序也能夠正常執(zhí)行。那么偿凭,該注解表示什么产弹?這么寫有什么好處嗎?事實上弯囊,@Override告訴編譯器這個方法是一個重寫方法(描述方法的元數(shù)據(jù))痰哨,如果父類中不存在該方法,編譯器便會報錯匾嘱,提示該方法沒有重寫父類中的方法斤斧。如果我不小心拼寫錯誤,例如將toString()寫成了toStrring(){double r}霎烙,而且我也沒有使用@Override注解撬讽,那程序依然能編譯運行。但運行結(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的維護越來越糟糕了序矩。他們希望使用一些和代碼緊耦合的東西鸯绿,而不是像XML那樣和代碼是松耦合的(在某些情況下甚至是完全分離的)代碼描述。如果你在Google中搜索“XML vs. annotations”簸淀,會看到許多關(guān)于這個問題的辯論瓶蝴。最有趣的是XML配置其實就是為了分離代碼和配置而引入的。上述兩種觀點可能會讓你很疑惑租幕,兩者觀點似乎構(gòu)成了一種循環(huán)舷手,但各有利弊。下面我們通過一個例子來理解這兩者的區(qū)別劲绪。


假如你想為應(yīng)用設(shè)置很多的常量或參數(shù)男窟,這種情況下盆赤,XML是一個很好的選擇,因為它不會同特定的代碼相連歉眷。如果你想把某個方法聲明為服務(wù)牺六,那么使用Annotation會更好一些,因為這種情況下需要注解和方法緊密耦合起來汗捡,開發(fā)人員也必須認識到這點淑际。


另一個很重要的因素是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機制雕薪。


編寫Annotation非常簡單,可以將Annotation的定義同接口的定義進行比較晓淀。我們來看兩個例子:一個是標(biāo)準(zhǔn)的注解@Override所袁,另一個是用戶自定義注解@Todo。


@Target(ElementType.METHOD)@Retention(RetentionPolicy.SOURCE)public@interfaceOverride {}


對于@Override注釋你可能有些疑問凶掰,它什么都沒做燥爷,那它是如何檢查在父類中有一個同名的函數(shù)呢。當(dāng)然懦窘,不要驚訝前翎,我是逗你玩的。@Override注解的定義不僅僅只有這么一點代碼畅涂。這部分內(nèi)容很重要鱼填,我不得不再次重復(fù):Annotations僅僅是元數(shù)據(jù),和業(yè)務(wù)邏輯無關(guān)毅戈。理解起來有點困難苹丸,但就是這樣。如果Annotations不包含業(yè)務(wù)邏輯苇经,那么必須有人來實現(xiàn)這些邏輯赘理。元數(shù)據(jù)的用戶來做這個事情。Annotations僅僅提供它定義的屬性(類/方法/包/域)的信息扇单。Annotations的用戶(同樣是一些代碼)來讀取這些信息并實現(xiàn)必要的邏輯商模。


當(dāng)我們使用Java的標(biāo)注Annotations(例如@Override)時,JVM就是一個用戶蜘澜,它在字節(jié)碼層面工作施流。到這里,應(yīng)用開發(fā)人員還不能控制也不能使用自定義的注解鄙信。因此瞪醋,我們講解一下如何編寫自定義的Annotations。


我們來逐個講述編寫自定義Annotations的要點装诡。上面的例子中银受,你看到一些注解應(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é)碼文件的處理中有用吐限。注解默認使用這種方式鲜侥。

RetentionPolicy.RUNTIME– 始終不會丟棄,運行期也保留該注解诸典,因此可以使用反射機制讀取該注解的信息描函。我們自定義的注解通常使用這種方式。

@Target – 表示該注解用于什么地方狐粱。如果不明確指出舀寓,該注解可以放在任何地方。以下是一些可用的參數(shù)肌蜻。需要說明的是:屬性的注解是兼容的互墓,如果你想給7個屬性都添加注解,僅僅排除一個屬性蒋搜,那么你需要在定義target包含所有的屬性篡撵。

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

ElementType.FIELD:用于描述實例變量

ElementType.METHOD

ElementType.PARAMETER

ElementType.CONSTRUCTOR

ElementType.LOCAL_VARIABLE

ElementType.ANNOTATION_TYPE 另一個注釋

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

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


那么,注解的內(nèi)部到底是如何定義的呢育谬?Annotations只支持基本類型券盅、String及枚舉類型。注釋中所有的屬性被定義成方法膛檀,并允許提供默認值锰镀。


@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@interfaceTodo {publicenumPriority {LOW, MEDIUM, HIGH}publicenumStatus {STARTED, NOT_STARTED}Stringauthor()default"Yash";Prioritypriority()defaultPriority.LOW;Statusstatus()defaultStatus.NOT_STARTED;}


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


@Todo(priority = Todo.Priority.MEDIUM, author ="Yashwant", status = Todo.Status.STARTED)publicvoidincompleteMethod1(){}


如果注解中只有一個屬性咖刃,可以直接命名為“value”泳炉,使用時無需再標(biāo)明屬性名。


@interfaceAuthor{Stringvalue();}@Author("Yashwant")publicvoidsomeMethod(){}


但目前為止一切看起來都還不錯嚎杨。我們定義了自己的注解并將其應(yīng)用在業(yè)務(wù)邏輯的方法上』ǘ欤現(xiàn)在我們需要寫一個用戶程序調(diào)用我們的注解。這里我們需要使用反射機制磕潮。如果你熟悉反射代碼翠胰,就會知道反射可以提供類名、方法和實例變量對象自脯。所有這些對象都有g(shù)etAnnotation()這個方法用來返回注解信息之景。我們需要把這個對象轉(zhuǎn)換為我們自定義的注釋(使用 instanceOf()檢查之后),同時也可以調(diào)用自定義注釋里面的方法膏潮《凸罚看看以下的實例代碼,使用了上面的注解:


Class businessLogicClass = BusinessLogic.class;for(Method method : businessLogicClass.getMethods()) {?Todo todoAnnotation = (Todo)method.getAnnotation(Todo.class);if(todoAnnotation !=null) {? System.out.println(" Method Name : "+ method.getName());? System.out.println(" Author : "+ todoAnnotation.author());? System.out.println(" Priority : "+ todoAnnotation.priority());? System.out.println(" Status : "+ todoAnnotation.status());?}}


注解用例


注解的功能很強大焕参,Spring和Hebernate這些框架在日志和有效性中大量使用了注解功能轻纪。注解可以應(yīng)用在使用標(biāo)記接口的地方。不同的是標(biāo)記接口用來定義完整的類叠纷,但你可以為單個的方法定義注釋刻帚,例如是否將一個方法暴露為服務(wù)。


在最新的servlet3.0中引入了很多新的注解涩嚣,尤其是和servlet安全相關(guān)的注解崇众。

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

HttpConstraint – 該注解代表所有HTTP方法的應(yīng)用請求的安全約束航厚,和ServletSecurity注釋中定義的HttpMethodConstraint安全約束不同顷歌。

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

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

ServletSecurity該注解標(biāo)注在Servlet繼承類上面麻顶,強制該HTTP協(xié)議請求遵循安全約束赦抖。

WebFilter – 該注解用來聲明一個Server過濾器舱卡;

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

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

WebServlet –該注解用來聲明一個Servlet的配置之宿。

聲明:本文轉(zhuǎn)載自蛙課網(wǎng)官網(wǎng)

想獲取更多資訊、更多視頻尺借、面試題答案份汗,還有各種資源+源碼+工具

就關(guān)注“蛙課網(wǎng)杏纾”公眾號吧!

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末杯活,一起剝皮案震驚了整個濱河市匆帚,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌旁钧,老刑警劉巖吸重,帶你破解...
    沈念sama閱讀 218,036評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異歪今,居然都是意外死亡嚎幸,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,046評論 3 395
  • 文/潘曉璐 我一進店門寄猩,熙熙樓的掌柜王于貴愁眉苦臉地迎上來嫉晶,“玉大人,你說我怎么就攤上這事田篇√娣希” “怎么了?”我有些...
    開封第一講書人閱讀 164,411評論 0 354
  • 文/不壞的土叔 我叫張陵泊柬,是天一觀的道長椎镣。 經(jīng)常有香客問我,道長兽赁,這世上最難降的妖魔是什么状答? 我笑而不...
    開封第一講書人閱讀 58,622評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮闸氮,結(jié)果婚禮上剪况,老公的妹妹穿的比我還像新娘。我一直安慰自己蒲跨,他們只是感情好译断,可當(dāng)我...
    茶點故事閱讀 67,661評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著或悲,像睡著了一般孙咪。 火紅的嫁衣襯著肌膚如雪堪唐。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,521評論 1 304
  • 那天翎蹈,我揣著相機與錄音淮菠,去河邊找鬼。 笑死荤堪,一個胖子當(dāng)著我的面吹牛合陵,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播澄阳,決...
    沈念sama閱讀 40,288評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼拥知,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了碎赢?” 一聲冷哼從身側(cè)響起低剔,我...
    開封第一講書人閱讀 39,200評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎肮塞,沒想到半個月后襟齿,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,644評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡枕赵,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,837評論 3 336
  • 正文 我和宋清朗相戀三年猜欺,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片烁设。...
    茶點故事閱讀 39,953評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡替梨,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出装黑,到底是詐尸還是另有隱情副瀑,我是刑警寧澤,帶...
    沈念sama閱讀 35,673評論 5 346
  • 正文 年R本政府宣布恋谭,位于F島的核電站糠睡,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏疚颊。R本人自食惡果不足惜狈孔,卻給世界環(huán)境...
    茶點故事閱讀 41,281評論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望材义。 院中可真熱鬧均抽,春花似錦、人聲如沸其掂。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,889評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至深寥,卻和暖如春攘乒,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背惋鹅。 一陣腳步聲響...
    開封第一講書人閱讀 33,011評論 1 269
  • 我被黑心中介騙來泰國打工则酝, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人闰集。 一個月前我還...
    沈念sama閱讀 48,119評論 3 370
  • 正文 我出身青樓沽讹,卻偏偏與公主長得像,于是被迫代替她去往敵國和親返十。 傳聞我的和親對象是個殘疾皇子妥泉,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,901評論 2 355