Java 注解(Annotation)

Java 注解 Dependency injection


前言

Linus Benedict Torvalds : RTFSC – Read The Fucking Source Code

現(xiàn)有的開源庫

  • RoboGuice
  • Android Annotations
  • Dragger
  • ButterKnife
  • Transfuse

注解(Annotation)

從三個(gè)方向了解注解:

  1. 注解是什么?
  2. 注解有什么用瞧甩?
  3. 注解怎么用喧务?

注解是什么

注解(Annotation)蚤蔓,也叫元數(shù)據(jù)所森。一種代碼級別的說明待榔,是一種將程序中的元素與任何信息關(guān)聯(lián)一起的途徑和方法统锤。它是JDK1.5及以后版本引入的一個(gè)特性陆淀,與類尤辱、接口砂豌、枚舉是在同一個(gè)層次。

注解有什么用

  1. 創(chuàng)建文檔光督。
  2. 跟蹤代碼中的依賴性阳距。
  3. 甚至執(zhí)行基本編譯時(shí)檢查。

在Java 5.0 中java.lang包有三個(gè)標(biāo)準(zhǔn)Annotation類型结借。

  1. 標(biāo)準(zhǔn) Annotation (JDK內(nèi)置系統(tǒng)注解)

標(biāo)準(zhǔn) Annotation 是指 Java 自帶的幾個(gè) Annotation筐摘,例如: @Override, @Deprecated, @SuppressWarnings。

  1. 元 Annotation (元注解)

元 Annotation 是指用來定義 Annotation 的 Annotation映跟,例如:@Retention, @Target, @Inherited, @Documented蓄拣。

  1. 自定義 Annotation (自定義注解)

自定義 Annotation 表示自己根據(jù)需要定義的 Annotation,定義時(shí)需要用到元 Annotation努隙。

注解怎么用

注解的語法比較簡單球恤,就是在前面添加@符號,后面的語法就更Java語法一致荸镊。

標(biāo)準(zhǔn) Annotation

我們列出三個(gè)例子:

  1. @Override
  2. @Deprecated
  3. @SuppressWarnnings
@Override

用于修飾此方法覆蓋了父類的方法咽斧。

@Override 是一個(gè)標(biāo)記注解類型,它被用作標(biāo)注方法躬存。它說明了被標(biāo)注的方法重載了父類的方法张惹,起到了斷言的作用。如果重載的方法寫錯(cuò)了在編譯期會(huì)有警告出現(xiàn)岭洲。

@Deprecated

用于修飾已經(jīng)過時(shí)的方法宛逗。

@Deprecated是一個(gè)標(biāo)記注解。當(dāng)一個(gè)類型或者類型成員使用@Deprecated修飾的話盾剩,編譯器將不鼓勵(lì)使用這個(gè)被標(biāo)注的程序元素雷激。這個(gè)標(biāo)記注解具有繼承性,可被子類繼承告私。

@SuppressWarnnings

用于通知java編譯器禁止特定的編譯警告屎暇。

@SuppressWarnings 被用于有選擇的關(guān)閉編譯器對類、方法驻粟、成員變量根悼、變量初始化的警告。@SuppressWarnings使用格式有這幾種:

  1. @SuppressWarnings(value={"deprecation", "unchecked"})
  2. @SuppressWarnings({"deprecation", "unchecked"})
  3. @SuppressWarnings("unchecked")

常見的@SuppressWarnings參數(shù)值:

  • all to suppress all warnings
  • boxing to suppress warnings relative to boxing/unboxing operations
  • cast to suppress warnings relative to cast operations
  • dep-ann to suppress warnings relative to deprecated annotation
  • deprecation to suppress warnings relative to deprecation
  • fallthrough to suppress warnings relative to missing breaks in switch statements
  • finally to suppress warnings relative to finally block that don’t return
  • hiding to suppress warnings relative to locals that hide variable
  • incomplete-switch to suppress warnings relative to missing entries in a switch statement (enum case)
  • nls to suppress warnings relative to non-nls string literals
  • null to suppress warnings relative to null analysis
  • rawtypes to suppress warnings relative to un-specific types when using generics on class params
  • restriction to suppress warnings relative to usage of discouraged or forbidden references
  • serial to suppress warnings relative to missing serialVersionUID field for a serializable class
  • static-access to suppress warnings relative to incorrect static access
  • synthetic-access to suppress warnings relative to unoptimized access from inner classes
  • unchecked to suppress warnings relative to unchecked operations
  • unqualified-field-access to suppress warnings relative to field access unqualified
  • unused to suppress warnings relative to unused code

元 Annotation

元注解的作用就是負(fù)責(zé)注解其他注解。在Java 5.0 中有四個(gè)標(biāo)準(zhǔn)元注解:

  1. @Target
  2. @Retention
  3. @Documented
  4. @Inherited
@Target

定義了Annotation所修飾的對象范圍:可被用于 packages挤巡、types(類剩彬、接口、枚舉矿卑、Annotation類型)襟衰、類型成員(方法、構(gòu)造方法粪摘、成員變量瀑晒、枚舉值)、方法參數(shù)和本地變量(如循環(huán)變量徘意、catch參數(shù))苔悦。
取值類型有這么幾個(gè):

  1. CONSTRUCTOR:用于描述構(gòu)造器
  2. FIELD:用于描述域
  3. LOCAL_VARIABLE:用于描述局部變量
  4. METHOD:用于描述方法
  5. PACKAGE:用于描述包
  6. PARAMETER:用于描述參數(shù)
  7. TYPE:用于描述類、接口(包括注解類型) 或enum聲明
@Retention

定義了該Annotation被保留的時(shí)間長短椎咧。
取值類型有這么幾個(gè):

  1. SOURCE:在源文件中有效(即源文件保留)
  2. CLASS:在class文件中有效(即class保留)
  3. RUNTIME:在運(yùn)行時(shí)有效(即運(yùn)行時(shí)保留)
@Documented

用于描述其它類型的annotation應(yīng)該被作為被標(biāo)注的程序成員的公共API玖详,因此可以被如javadoc此類的工具文檔化。

@Inherited

這是一個(gè)標(biāo)記注解勤讽,闡述了某個(gè)被標(biāo)注的類型是被繼承的蟋座。

自定義 Annotation

通過使用@interface符號來完成自定義注解,自定義注解不能繼承其它注解或接口脚牍∠蛲危可以通過default來聲明參數(shù)的默認(rèn)值。

注解格式:
public @interface 注解名 {定義體}

支持的數(shù)據(jù)類型:

  1. 所有基本數(shù)據(jù)類型(int,float,boolean,byte,double,char,long,short)
  2. String類型
  3. Class類型
  4. enum類型
  5. Annotation類型
  6. 以上所有類型的數(shù)組

備注:

  1. 如果只有一個(gè)參數(shù)成員,最好把參數(shù)名稱設(shè)為"value"诸狭,后加小括號券膀。
  2. 只能用public或默認(rèn)(default)這兩個(gè)訪問權(quán)修飾。

例子:

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FileType {
    public enum Color{BULE,RED,GREEN};
    Color fruitColor() default Color.GREEN;
}

// 使用
@FileName("Safe")
private String FileName;

注解處理器類庫

最后這里介紹下注解處理類庫:
java.lang.reflect.AnnotatedElement
可以通過它處理很多復(fù)雜的注解工作驯遇。

注解學(xué)習(xí)圖
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末芹彬,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子叉庐,更是在濱河造成了極大的恐慌舒帮,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,406評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件陡叠,死亡現(xiàn)場離奇詭異玩郊,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)匾竿,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,395評論 3 398
  • 文/潘曉璐 我一進(jìn)店門瓦宜,熙熙樓的掌柜王于貴愁眉苦臉地迎上來蔚万,“玉大人岭妖,你說我怎么就攤上這事。” “怎么了昵慌?”我有些...
    開封第一講書人閱讀 167,815評論 0 360
  • 文/不壞的土叔 我叫張陵假夺,是天一觀的道長。 經(jīng)常有香客問我斋攀,道長已卷,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 59,537評論 1 296
  • 正文 為了忘掉前任淳蔼,我火速辦了婚禮侧蘸,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘鹉梨。我一直安慰自己讳癌,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,536評論 6 397
  • 文/花漫 我一把揭開白布存皂。 她就那樣靜靜地躺著晌坤,像睡著了一般。 火紅的嫁衣襯著肌膚如雪旦袋。 梳的紋絲不亂的頭發(fā)上骤菠,一...
    開封第一講書人閱讀 52,184評論 1 308
  • 那天,我揣著相機(jī)與錄音疤孕,去河邊找鬼商乎。 笑死,一個(gè)胖子當(dāng)著我的面吹牛祭阀,可吹牛的內(nèi)容都是我干的截亦。 我是一名探鬼主播,決...
    沈念sama閱讀 40,776評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼柬讨,長吁一口氣:“原來是場噩夢啊……” “哼崩瓤!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起踩官,我...
    開封第一講書人閱讀 39,668評論 0 276
  • 序言:老撾萬榮一對情侶失蹤却桶,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后蔗牡,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體颖系,經(jīng)...
    沈念sama閱讀 46,212評論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,299評論 3 340
  • 正文 我和宋清朗相戀三年辩越,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了嘁扼。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,438評論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡黔攒,死狀恐怖趁啸,靈堂內(nèi)的尸體忽然破棺而出强缘,到底是詐尸還是另有隱情,我是刑警寧澤不傅,帶...
    沈念sama閱讀 36,128評論 5 349
  • 正文 年R本政府宣布旅掂,位于F島的核電站,受9級特大地震影響访娶,放射性物質(zhì)發(fā)生泄漏商虐。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,807評論 3 333
  • 文/蒙蒙 一崖疤、第九天 我趴在偏房一處隱蔽的房頂上張望秘车。 院中可真熱鬧,春花似錦劫哼、人聲如沸鲫尊。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,279評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽疫向。三九已至,卻和暖如春豪嚎,著一層夾襖步出監(jiān)牢的瞬間搔驼,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,395評論 1 272
  • 我被黑心中介騙來泰國打工侈询, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留舌涨,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,827評論 3 376
  • 正文 我出身青樓扔字,卻偏偏與公主長得像囊嘉,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子革为,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,446評論 2 359

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