java中的自定義注解

今天準(zhǔn)備把Java中的自定義注解分享一下子朗兵,因?yàn)楹枚嘈』锇椋菜贫疾恢雷⒔膺@個(gè)東西到底是什么柿隙,只知道怎么用叶洞,卻不知道注解的底層原理。這一篇就和大家分享一下禀崖,文章結(jié)構(gòu):

Java中的注解概述

四種元注解

自定義注解


1. Java中的注解概述

首先要說(shuō)明一個(gè)東西衩辟,注解這個(gè)東西絕對(duì)不是Spring為我們提供的,而是JDK帶的波附,JDK自己也是有很多內(nèi)置注解的艺晴,比如@override. 注解的功能其實(shí)就是為一些加了注解的類,方法等賦予特殊的含義,具體如何產(chǎn)生自定義的含義掸屡,其實(shí)就是注解處理器了,這是下一篇和大家講的.

2. 四種元注解

元注解封寞,說(shuō)白了,就是JDK自帶的注解仅财,這些注解是干嘛的呢狈究?其實(shí)就是在我們自定義注解時(shí),注解到我們自定義的注解上的盏求,舉個(gè)例子:

@Target(ElementType.TYPE) public @interface Table { public String tableName() default "className"; }

大家先不要管語(yǔ)法抖锥,Table其實(shí)就是我自定義的一個(gè)注解,可以@Table這樣使用了碎罚,那么這個(gè)@Target其實(shí)就是元注解了磅废。JDK自帶的元注解如下:

@Target

@Retention

@Documented

@Inherited

@Target

用于描述注解的使用范圍,有一個(gè)枚舉ElementType來(lái)指定,具體如下:

CONSTRUCTOR:用于描述構(gòu)造器

FIELD:用于描述域

LOCAL_VARIABLE:用于描述局部變量

METHOD:用于描述方法

PACKAGE:用于描述包

PARAMETER:用于描述參數(shù)

TYPE:用于描述類、接口(包括注解類型) 或enum聲明

eg:

@Target(ElementType.METHOD) public @interface Dog { }

大家可以看到荆烈,這個(gè)Dog注解还蹲,只能用到方法上面 。

1). @Retention

表示需要在什么級(jí)別保存該注釋信息,用于描述注解的生命周期,也是一個(gè)枚舉RetentionPoicy來(lái)決定的谜喊,這個(gè)枚舉我不列出來(lái)了,包括這個(gè)注解的具體怎么決定注解的生命周期我也不多講倦始,因?yàn)楦鶕?jù)小弟這么多年使用的經(jīng)驗(yàn)斗遏,都是填的RetentionPoicy.RUNTIME,填這個(gè)值注解處理器才能通過(guò)反色拿到注解信息,實(shí)現(xiàn)自己的語(yǔ)義,所以大家都填RetentionPoicy.RUNTIME就可以了鞋邑,想擴(kuò)展了解的自行g(shù)oogle..

2). @Documented

如果用javadoc生成文檔時(shí)诵次,想把注解也生成文檔,就帶這個(gè)枚碗。(話說(shuō)老鐵們都是怎么寫(xiě)文檔的逾一,小弟表示從不寫(xiě)文檔... ^_^)

3). @Inherited

@Inherited 元注解是一個(gè)標(biāo)記注解,@Inherited闡述了某個(gè)被標(biāo)注的類型是被繼承的肮雨。如果一個(gè)使用了@Inherited修飾的annotation類型被用于一個(gè)class遵堵,則這個(gè)annotation將被用于該class的子類。注意,@Inherited annotation類型是被標(biāo)注過(guò)的class的子類所繼承怨规。類并不從它所實(shí)現(xiàn)的接口繼承annotation陌宿,方法并不從它所重載的方法繼承annotation。

其實(shí)這幾個(gè)注解只有一個(gè)有點(diǎn)用波丰,就是@Target,大家稍微注意下就行了壳坪。注解不是你想加哪就加哪的。

3. 自定義注解

上面把元注解說(shuō)了掰烟,來(lái)講下如何自定義注解爽蝴,順帶提一下,自定義的注解又叫組合注解.然后說(shuō)下自定義注解格式:

1)固定格式纫骑,不要搞事.

2)只能用public或默認(rèn)(default)這兩個(gè)訪問(wèn)權(quán)修飾.例如,String value();這里把方法設(shè)為defaul默認(rèn)類型蝎亚;

3)定義注解參數(shù)的類型,只能為:

所有基本數(shù)據(jù)類型(int,float,boolean,byte,double,char,long,short)

String類型

Class類型

enum類型

Annotation類型

以上所有類型的數(shù)組

方法名惧磺,就是這個(gè)注解的支持的屬性名颖对,像常見(jiàn)的value.

表示該屬性名在不指定時(shí)的默認(rèn)值,可以不要磨隘。

好了缤底,舉個(gè)例子:

@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Dog { public String dog() default ""; }

好了,大家可以看到番捂,這樣就定義了一個(gè)注解了个唧。

自定義注解有兩種用法:

自定義注解處理器專門(mén)為你自定義的注解實(shí)現(xiàn)語(yǔ)義(比如加了@Dog注解的方法,在調(diào)用的時(shí)候设预,全部都打印出調(diào)用信息到日志系統(tǒng)) ,后一篇博客講自定義注解處理器徙歼。

配合Spring使用.

在講如何配合Spring使用前,先說(shuō)一個(gè)知識(shí)點(diǎn),大家可能會(huì)忽略掉魄梯,那就是注解是可以組合的桨螺,如上圖,在自定義注解時(shí)酿秸,不僅可以加元注解灭翔,還可以加其他自定義注解 。這就好玩了辣苏,我舉個(gè)例子:

@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Component public @interface Dog { public String dog() default ""; }

我為剛剛的@Dog注解加了@Component,那么這個(gè)注解就會(huì)有@Component的功能了(被Spring當(dāng)做bean加入到Spring容器里).現(xiàn)在在順帶說(shuō)下屬性修飾符public和默認(rèn)的區(qū)別

public修飾的屬性能被覆蓋肝箱,默認(rèn)的則不能. 舉個(gè)例子:

@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented @Component @Dog public @interface StupidDog { public String dog() default "我是一條StupidDog"; }

我現(xiàn)在又定義了一個(gè)StupidDog注解,這個(gè)注解覆蓋掉了@Dog的dog屬性稀蟋,把默認(rèn)值從""改成了"我是一條StupidDog"..

好了煌张,回到話題上,知道了組合注解可以擁有被注解的注解的功能退客,還拿剛才那個(gè)加了@Component注解的@Dog注解來(lái)說(shuō)骏融,當(dāng)某個(gè)類被加了這個(gè)注解,比如:

@Dog public class TestService { ... }

我們知道這個(gè)TestService在Spring的環(huán)境下會(huì)被加到Spring容器里成為Bean,可是這有什么鳥(niǎo)用了井辜?這個(gè)作用可大了绎谦!這可以把Spring容器里的bean區(qū)分開(kāi)來(lái),比如如下代碼片段:

// ctx 為Spring的ApplicationContext // // 獲取所有帶有 Dog 注解的 Spring Bean Map serviceBeanMap = ctx.getBeansWithAnnotation(Dog.class);

大家可以看到,可以通過(guò)ApplicationContext取到一些帶有特殊標(biāo)記(自定義注解)的Spring bean! 大家不要小看了這一功能粥脚,如果你想在Spring容器初始化完畢后窃肠,對(duì)某一類Spring Bean做一些特殊操作。自定義注解可以幫你區(qū)分開(kāi)來(lái)刷允。

更多java小知識(shí)詢462403503或點(diǎn)擊下方藍(lán)色字體了解冤留。

藍(lán)色字體

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市树灶,隨后出現(xiàn)的幾起案子纤怒,更是在濱河造成了極大的恐慌,老刑警劉巖天通,帶你破解...
    沈念sama閱讀 216,997評(píng)論 6 502
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件泊窘,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡像寒,警方通過(guò)查閱死者的電腦和手機(jī)烘豹,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,603評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)诺祸,“玉大人携悯,你說(shuō)我怎么就攤上這事】瓯浚” “怎么了憔鬼?”我有些...
    開(kāi)封第一講書(shū)人閱讀 163,359評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵龟劲,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我轴或,道長(zhǎng)昌跌,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,309評(píng)論 1 292
  • 正文 為了忘掉前任照雁,我火速辦了婚禮避矢,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘囊榜。我一直安慰自己,他們只是感情好亥宿,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,346評(píng)論 6 390
  • 文/花漫 我一把揭開(kāi)白布卸勺。 她就那樣靜靜地躺著,像睡著了一般烫扼。 火紅的嫁衣襯著肌膚如雪曙求。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 51,258評(píng)論 1 300
  • 那天映企,我揣著相機(jī)與錄音悟狱,去河邊找鬼。 笑死堰氓,一個(gè)胖子當(dāng)著我的面吹牛挤渐,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播双絮,決...
    沈念sama閱讀 40,122評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼浴麻,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了囤攀?” 一聲冷哼從身側(cè)響起软免,我...
    開(kāi)封第一講書(shū)人閱讀 38,970評(píng)論 0 275
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎焚挠,沒(méi)想到半個(gè)月后膏萧,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,403評(píng)論 1 313
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡蝌衔,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,596評(píng)論 3 334
  • 正文 我和宋清朗相戀三年榛泛,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片胚委。...
    茶點(diǎn)故事閱讀 39,769評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡挟鸠,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出亩冬,到底是詐尸還是另有隱情艘希,我是刑警寧澤硼身,帶...
    沈念sama閱讀 35,464評(píng)論 5 344
  • 正文 年R本政府宣布,位于F島的核電站覆享,受9級(jí)特大地震影響佳遂,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜撒顿,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,075評(píng)論 3 327
  • 文/蒙蒙 一丑罪、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧凤壁,春花似錦吩屹、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,705評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至唧席,卻和暖如春擦盾,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背淌哟。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,848評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工迹卢, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人徒仓。 一個(gè)月前我還...
    沈念sama閱讀 47,831評(píng)論 2 370
  • 正文 我出身青樓腐碱,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親蓬衡。 傳聞我的和親對(duì)象是個(gè)殘疾皇子喻杈,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,678評(píng)論 2 354

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