java進(jìn)階之自定義注解

一霉撵、簡介

注解是Java 1.5引入的芹助,可以提供代碼的額外信息,目前正在被廣泛應(yīng)用挟纱。除了Java內(nèi)置注解羞酗,我們也可以自定義注解。

以下就是一個(gè)自定義注解的簡單例子:

@Target(ElementType.TYPE) //注解作用于類型(類紊服,接口整慎,注解,枚舉)@Retention(RetentionPolicy.RUNTIME) //運(yùn)行時(shí)保留围苫,運(yùn)行中可以處理@Inherited// 注解將被用于該類的子類@Documented// 生成javadoc文件public @interfaceJsAnnotation { String DEFAULT_VALUE = "JS"; /** * 創(chuàng)建此value方法裤园,則使用注解時(shí)可直接傳參,如 @JsAnnotation("msg") * * @return */ String value default DEFAULT_VALUE;

}

自定義注解關(guān)鍵點(diǎn):

@interface關(guān)鍵字定義注解

注解可以被其它注解修飾剂府,最重要的就是元注解

注解和接口類似拧揽,內(nèi)部可以定義常量和方法

注解定義的方法有一些限制:方法不能有參數(shù);返回值只能是基本類型腺占、字符串淤袜、Class、枚舉衰伯、注解铡羡、及以上類型的數(shù)組;可以包含默認(rèn)值

小編是一個(gè)有著5年工作經(jīng)驗(yàn)的java程序員意鲸,對于java烦周,自己有做資料的整合尽爆,一個(gè)完整學(xué)習(xí)java的路線,學(xué)習(xí)資料和工具读慎,相信這里有很多學(xué)習(xí)java的小伙伴漱贱,我創(chuàng)立了一個(gè)2000人學(xué)習(xí)扣群,479121291夭委。每晚都有java的直播課程幅狮。無論是初級還是進(jìn)階的小伙伴小編我都?xì)g迎!

二株灸、元注解介紹

元注解就是定義注解的注解崇摄。

包含@Target、@Retention慌烧、@Inherited逐抑、@Documented這四種

1、@Target

描述注解的使用目標(biāo)杏死。

其源碼為:

@Documented@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.ANNOTATION_TYPE}) public @interfaceTarget { ElementType[] value;

}

注解方法返回值是ElementType[],ElementType枚舉類型,枚舉值就是@Target注解的可取值捆交。

方法名value淑翼,這樣在使用注解時(shí),可以不需要指定方法名品追。

可取的值有:

取值含義

ElementType.PACKAGE注解作用于包

ElementType.TYPE注解作用于類型(類玄括,接口,注解肉瓦,枚舉)

ElementType.ANNOTATION_TYPE注解作用于注解

ElementType.CONSTRUCTOR注解作用于構(gòu)造方法

ElementType.METHOD注解作用于方法

ElementType.PARAMETER注解作用于方法參數(shù)

ElementType.FIELD注解作用于屬性

ElementType.LOCAL_VARIABLE注解作用于局部變量

注意:默認(rèn)可以作用于以上任何目標(biāo)遭京。

2、@Retention

描述注解的生命周期泞莉。

其源碼為:

@Documented@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.ANNOTATION_TYPE}) public @interfaceRetention { RetentionPolicy value;

}

注解方法返回值是枚舉類型RetentionPolicy哪雕,枚舉值就是@Retention注解的可取值。

可取的值有:

取值含義

RetentionPolicy.SOURCE源碼中保留鲫趁,編譯期可以處理

RetentionPolicy.CLASSClass文件中保留斯嚎,Class加載時(shí)可以處理

RetentionPolicy.RUNTIME運(yùn)行時(shí)保留,運(yùn)行中可以處理

默認(rèn)RetentionPolicy.CLASS 值挨厚。

3堡僻、@Documented

描述注解可以文檔化,是一個(gè)標(biāo)記注解疫剃。

在生成javadoc的時(shí)候钉疫,是不包含注釋的,但是如果注解被@Documented修飾巢价,則生成的文檔就包含該注解牲阁。

其源碼為:

@Documented@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.ANNOTATION_TYPE}) public @interfaceDocumented { }

4固阁、@Inherited

標(biāo)記注解,使用@Inherited修飾的注解作用于一個(gè)類咨油,則該注解將被用于該類的子類您炉。

其源碼為:

@Documented@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.ANNOTATION_TYPE}) public @interfaceInherited { }

三、自定義注解示例

1役电、定義注解

@Target(ElementType.TYPE) //注解作用于類型(類赚爵,接口,注解法瑟,枚舉)@Retention(RetentionPolicy.RUNTIME) //運(yùn)行時(shí)保留冀膝,運(yùn)行中可以處理@Inherited// 注解將被用于該類的子類@Documented// 生成javadoc文件public @interfaceJsAnnotation { String DEFAULT_VALUE = "JS"; /** * 顏色枚舉 * * @author peida */enum Color {

BULE, RED, GREEN

} /** * 創(chuàng)建此value方法,則使用注解時(shí)可直接傳參霎挟,如 @JsAnnotation("msg") * * @return */ String value default DEFAULT_VALUE; /** * 此方法返回為枚舉類型窝剖,使用注解時(shí),如 @JsAnnotation(color=Color.BLUE) * * @return */ Color color default Color.BULE; int num default -1;

}

其中:定義了三個(gè)方法酥夭,三個(gè)方法都有默認(rèn)返回值赐纱。定義了Color枚舉(因?yàn)樽⒔獾姆椒梢苑祷孛杜e類型)

這里注意:

- value方法:使用注解時(shí)可直接傳參,如 @JsAnnotation(“msg”)

- 普通方法:使用注解時(shí)熬北,如 @JsAnnotation(color=Color.BLUE)

2疙描、使用注解

@JsAnnotation("jia shuai") publicclass AnnotationTest {

}

@JsAnnotation(num = 100) publicclass AnnotationTest {

}

@JsAnnotation(color = Color.BLUE) publicclass AnnotationTest {

}

3、獲取注解

public static void main(String[] args) {

AnnotationTest test = new AnnotationTest; Class tClass = test.getClass; JsAnnotation jsAnnotation = (JsAnnotation) tClass.getAnnotation(JsAnnotation.class); System.out.println(jsAnnotation.value); System.out.println(jsAnnotation.color); System.out.println(jsAnnotation.num); }

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末讶隐,一起剝皮案震驚了整個(gè)濱河市起胰,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌巫延,老刑警劉巖效五,帶你破解...
    沈念sama閱讀 218,941評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異炉峰,居然都是意外死亡畏妖,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,397評論 3 395
  • 文/潘曉璐 我一進(jìn)店門疼阔,熙熙樓的掌柜王于貴愁眉苦臉地迎上來瓜客,“玉大人,你說我怎么就攤上這事竿开∑滓牵” “怎么了?”我有些...
    開封第一講書人閱讀 165,345評論 0 356
  • 文/不壞的土叔 我叫張陵否彩,是天一觀的道長疯攒。 經(jīng)常有香客問我,道長列荔,這世上最難降的妖魔是什么敬尺? 我笑而不...
    開封第一講書人閱讀 58,851評論 1 295
  • 正文 為了忘掉前任枚尼,我火速辦了婚禮,結(jié)果婚禮上砂吞,老公的妹妹穿的比我還像新娘署恍。我一直安慰自己,他們只是感情好蜻直,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,868評論 6 392
  • 文/花漫 我一把揭開白布盯质。 她就那樣靜靜地躺著,像睡著了一般概而。 火紅的嫁衣襯著肌膚如雪呼巷。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,688評論 1 305
  • 那天赎瑰,我揣著相機(jī)與錄音王悍,去河邊找鬼。 笑死餐曼,一個(gè)胖子當(dāng)著我的面吹牛压储,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播源譬,決...
    沈念sama閱讀 40,414評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼集惋,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了瓶佳?” 一聲冷哼從身側(cè)響起芋膘,我...
    開封第一講書人閱讀 39,319評論 0 276
  • 序言:老撾萬榮一對情侶失蹤鳞青,失蹤者是張志新(化名)和其女友劉穎霸饲,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體臂拓,經(jīng)...
    沈念sama閱讀 45,775評論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡厚脉,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了胶惰。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片傻工。...
    茶點(diǎn)故事閱讀 40,096評論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖孵滞,靈堂內(nèi)的尸體忽然破棺而出中捆,到底是詐尸還是另有隱情,我是刑警寧澤坊饶,帶...
    沈念sama閱讀 35,789評論 5 346
  • 正文 年R本政府宣布泄伪,位于F島的核電站,受9級特大地震影響匿级,放射性物質(zhì)發(fā)生泄漏蟋滴。R本人自食惡果不足惜染厅,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,437評論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望津函。 院中可真熱鬧肖粮,春花似錦、人聲如沸尔苦。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,993評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽蕉堰。三九已至凌净,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間屋讶,已是汗流浹背冰寻。 一陣腳步聲響...
    開封第一講書人閱讀 33,107評論 1 271
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留皿渗,地道東北人斩芭。 一個(gè)月前我還...
    沈念sama閱讀 48,308評論 3 372
  • 正文 我出身青樓,卻偏偏與公主長得像乐疆,于是被迫代替她去往敵國和親划乖。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,037評論 2 355

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