Java 注解(Annotation)

前言


注解是 Java 5 的一個(gè)新特性板乙。注解是插入你代碼中的一種注釋或者說(shuō)是一種元數(shù)據(jù)(meta data)。這些注解信息可以在編譯期使用預(yù)編譯工具進(jìn)行處理(pre-compiler tools)感挥,也可以在運(yùn)行期使用 Java 反射機(jī)制進(jìn)行處理。

現(xiàn)在注解在越來(lái)越多的地方用到越败,在Android中非常著名的網(wǎng)絡(luò)請(qǐng)求框架 Retrofit 就是利用注解和動(dòng)態(tài)代理很大程度上簡(jiǎn)化了網(wǎng)絡(luò)請(qǐng)求的代碼触幼。

元注解


元注解的作用就是負(fù)責(zé)注解其他注解。Java5.0定義了4個(gè)標(biāo)準(zhǔn)的meta-annotation類型究飞,它們被用來(lái)提供對(duì)其它 annotation類型作說(shuō)明置谦。Java5.0定義的元注解:

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

這些類型和它們所支持的類在java.lang.annotation包中可以找到。下面我們看一下每個(gè)元注解的作用和相應(yīng)分參數(shù)的使用說(shuō)明亿傅。

@Target

@Target說(shuō)明了Annotation所修飾的對(duì)象范圍:Annotation可被用于 packages媒峡、types(類、接口葵擎、枚舉谅阿、Annotation類型)、類型成員(方法、構(gòu)造方法签餐、成員變量寓涨、枚舉值)、方法參數(shù)和本地變量(如循環(huán)變量氯檐、catch參數(shù))缅茉。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標(biāo)。

作用:用于描述注解的使用范圍(即:被描述的注解可以用在什么地方)

取值(ElementType)有:

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

@Retention:

@Retention定義了該Annotation被保留的時(shí)間長(zhǎng)短:某些Annotation僅出現(xiàn)在源代碼中,而被編譯器丟棄译打;而另一些卻被編譯在class文件中耗拓;編譯在class文件中的Annotation可能會(huì)被虛擬機(jī)忽略,而另一些在class被裝載時(shí)將被讀茸嗨尽(請(qǐng)注意并不影響class的執(zhí)行乔询,因?yàn)锳nnotation與class在使用上是被分離的)。使用這個(gè)meta-Annotation可以對(duì) Annotation的“生命周期”限制韵洋。

作用:表示需要在什么級(jí)別保存該注釋信息竿刁,用于描述注解的生命周期(即:被描述的注解在什么范圍內(nèi)有效)

取值(RetentionPoicy)有:

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

@Documented:

@Documented用于描述其它類型的annotation應(yīng)該被作為被標(biāo)注的程序成員的公共API,因此可以被例如javadoc此類的工具文檔化搪缨。Documented是一個(gè)標(biāo)記注解食拜,沒(méi)有成員。

@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晰筛。

當(dāng)@Inherited annotation類型標(biāo)注的annotation的Retention是RetentionPolicy.RUNTIME庵芭,則反射API增強(qiáng)了這種繼承性唁情。如果我們使用java.lang.reflect去查詢一個(gè)@Inherited annotation類型的annotation時(shí)欲间,反射代碼檢查將展開工作:檢查class和其父類晃择,直到發(fā)現(xiàn)指定的annotation類型被發(fā)現(xiàn)炭菌,或者到達(dá)類繼承結(jié)構(gòu)的頂層铺浇。

自定義注解


使用@interface自定義注解時(shí)悠就,自動(dòng)繼承了java.lang.annotation.Annotation接口千绪,由編譯程序自動(dòng)完成其他細(xì)節(jié)。在定義注解時(shí)梗脾,不能繼承其他的注解或接口荸型。@interface用來(lái)聲明一個(gè)注解,其中的每一個(gè)方法實(shí)際上是聲明了一個(gè)配置參數(shù)。方法的名稱就是參數(shù)的名稱瑞妇,返回值類型就是參數(shù)的類型(返回值類型只能是基本類型稿静、Class、String辕狰、enum)改备。可以通過(guò)default來(lái)聲明參數(shù)的默認(rèn)值蔓倍。

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

注解參數(shù)的可支持?jǐn)?shù)據(jù)類型:

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

Annotation類型里面的參數(shù)該怎么設(shè)定:
  第一,只能用public或默認(rèn)(default)這兩個(gè)訪問(wèn)權(quán)修飾.例如,String value();這里把方法設(shè)為defaul默認(rèn)類型悬钳;   
  第二,參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和 String,Enum,Class,annotations等數(shù)據(jù)類型,以及這一些類型的數(shù)組.例如,String value();這里的參數(shù)成員就為String;  
  第三,如果只有一個(gè)參數(shù)成員,最好把參數(shù)名稱設(shè)為"value",后加小括號(hào).例:下面的例子FruitName注解就只有一個(gè)參數(shù)成員。

注解元素的默認(rèn)值:

注解元素必須有確定的值偶翅,要么在定義注解的默認(rèn)值中指定默勾,要么在使用注解時(shí)指定,非基本類型的注解元素的值不可為null聚谁。因此, 使用空字符串或0作為默認(rèn)值是一種常用的做法母剥。這個(gè)約束使得處理器很難表現(xiàn)一個(gè)元素的存在或缺失的狀態(tài),因?yàn)槊總€(gè)注解的聲明中形导,所有元素都存在环疼,并且都具有相應(yīng)的值,為了繞開這個(gè)約束朵耕,我們只能定義一些特殊的值炫隶,例如空字符串或者負(fù)數(shù),一次表示某個(gè)元素不存在阎曹,在定義注解時(shí)等限,這已經(jīng)成為一個(gè)習(xí)慣用法。

簡(jiǎn)單的自定義注解和使用注解實(shí)例:

package annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 水果名稱注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
    String value() default "";
}
package annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 水果顏色注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitColor {
    /**
     * 顏色枚舉
     * @author peida
     *
     */
    public enum Color{ BULE,RED,GREEN};
    
    /**
     * 顏色屬性
     * @return
     */
    Color fruitColor() default Color.GREEN;

}
package annotation;

import annotation.FruitColor.Color;

public class Apple {
    
    @FruitName("Apple")
    private String appleName;
    
    @FruitColor(fruitColor=Color.RED)
    private String appleColor;
    
    
    
    
    public void setAppleColor(String appleColor) {
        this.appleColor = appleColor;
    }
    public String getAppleColor() {
        return appleColor;
    }
    
    
    public void setAppleName(String appleName) {
        this.appleName = appleName;
    }
    public String getAppleName() {
        return appleName;
    }
    
    public void displayName(){
        System.out.println("水果的名字是:蘋果");
    }
}

Android內(nèi)置注解


作為android程序員芬膝,我們還是了解一下android中自帶的注解望门,以及用法含義。

@SuppressLint: 指示lint檢查時(shí)忽略注解元素的警告信息锰霜。
  @TargetApi:指示lint把當(dāng)前這個(gè)注解元素的target api為指定值筹误,而不是項(xiàng)目設(shè)置的target api。
  @NonNull:表示一個(gè)成員變量癣缅,或者參數(shù)厨剪,或者方法返回值永遠(yuǎn)不能為NULL。
  @Nullable:標(biāo)識(shí)一個(gè)成員變量友存,或者參數(shù)祷膳,方法返回值,可以為NULL屡立。

參考


[深入理解Java:注解(Annotation)自定義注解入門] (http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末直晨,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌勇皇,老刑警劉巖罩句,帶你破解...
    沈念sama閱讀 216,402評(píng)論 6 499
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異敛摘,居然都是意外死亡门烂,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,377評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門兄淫,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)屯远,“玉大人,你說(shuō)我怎么就攤上這事捕虽∶ト螅” “怎么了?”我有些...
    開封第一講書人閱讀 162,483評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵薯鳍,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我挨措,道長(zhǎng)挖滤,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,165評(píng)論 1 292
  • 正文 為了忘掉前任浅役,我火速辦了婚禮斩松,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘觉既。我一直安慰自己惧盹,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,176評(píng)論 6 388
  • 文/花漫 我一把揭開白布瞪讼。 她就那樣靜靜地躺著钧椰,像睡著了一般。 火紅的嫁衣襯著肌膚如雪符欠。 梳的紋絲不亂的頭發(fā)上嫡霞,一...
    開封第一講書人閱讀 51,146評(píng)論 1 297
  • 那天,我揣著相機(jī)與錄音希柿,去河邊找鬼诊沪。 笑死,一個(gè)胖子當(dāng)著我的面吹牛曾撤,可吹牛的內(nèi)容都是我干的端姚。 我是一名探鬼主播,決...
    沈念sama閱讀 40,032評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開眼挤悉,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼渐裸!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,896評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤橄仆,失蹤者是張志新(化名)和其女友劉穎剩膘,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體盆顾,經(jīng)...
    沈念sama閱讀 45,311評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡怠褐,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,536評(píng)論 2 332
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了您宪。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片奈懒。...
    茶點(diǎn)故事閱讀 39,696評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖宪巨,靈堂內(nèi)的尸體忽然破棺而出磷杏,到底是詐尸還是另有隱情,我是刑警寧澤捏卓,帶...
    沈念sama閱讀 35,413評(píng)論 5 343
  • 正文 年R本政府宣布极祸,位于F島的核電站,受9級(jí)特大地震影響怠晴,放射性物質(zhì)發(fā)生泄漏遥金。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,008評(píng)論 3 325
  • 文/蒙蒙 一蒜田、第九天 我趴在偏房一處隱蔽的房頂上張望稿械。 院中可真熱鬧,春花似錦冲粤、人聲如沸美莫。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,659評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)厢呵。三九已至,卻和暖如春傀顾,著一層夾襖步出監(jiān)牢的瞬間述吸,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,815評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工锣笨, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留蝌矛,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,698評(píng)論 2 368
  • 正文 我出身青樓错英,卻偏偏與公主長(zhǎng)得像入撒,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子椭岩,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,592評(píng)論 2 353

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