深入理解Java:注解(Annotation)自定義注解入門

要深入學(xué)習(xí)注解俭令,我們就必須能定義自己的注解,并使用注解根悼,在定義自己的注解之前批糟,我們就必須要了解Java為我們提供的元注解和相關(guān)定義注解的語法格了。

元注解:

元注解的作用就是負(fù)責(zé)注解其他注解。Java5.0定義了4個(gè)標(biāo)準(zhǔn)的meta-annotation類型徽鼎,它們被用來提供對(duì)其它 annotation類型作說明盛末。Java5.0定義的元注解:
    1.@Target,
    2.@Retention,
    3.@Documented,
    4.@Inherited
  這些類型和它們所支持的類在java.lang.annotation包中可以找到。下面我們看一下每個(gè)元注解的作用和相應(yīng)分參數(shù)的使用說明否淤。

@Target:

@Target說明了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聲明

使用實(shí)例:

@Target(ElementType.TYPE)
public @interface Table {
    /*
     * 數(shù)據(jù)表名稱注解,默認(rèn)值為類名稱
     * @return
     */
    public String tableName() default "className";
}
@Target(ElementType.FIELD)
public @interface NoDBColumn {
}

注解Table 可以用于注解類续徽、接口(包括注解類型) 或enum聲明,而注解NoDBColumn僅可用于注解類的成員變量蚓曼。

@Retention:

@Retention定義了該Annotation被保留的時(shí)間長短:某些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í)保留)

Retention meta-annotation類型有唯一的value作為成員,它的取值來自java.lang.annotation.RetentionPolicy的枚舉類型值概页。具體實(shí)例如下:

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField"; 
    public boolean defaultDBValue() default false;
}

Column注解的的RetentionPolicy的屬性值是RUTIME,這樣注解處理器可以通過反射籽御,獲取到該注解的屬性值,從而去做一些運(yùn)行時(shí)的邏輯處理

@Documented:

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField"; 
    public boolean defaultDBValue() default false;
}

@Inherited:

@Inherited 元注解是一個(gè)標(biāo)記注解哑梳,@Inherited闡述了某個(gè)被標(biāo)注的類型是被繼承的。如果一個(gè)使用了@Inherited修飾的annotation類型被用于一個(gè)class绘盟,則這個(gè)annotation將被用于該class的子類鸠真。

注意:@Inherited annotation類型是被標(biāo)注過的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)的頂層序攘。

實(shí)例代碼:

/**
 * 
 * @author peida
 *
 */
@Inherited
public @interface Greeting {
    public enum FontColor{ BULE,RED,GREEN};
    String name();
    FontColor fontColor() default FontColor.GREEN;
}

自定義注解:

使用@interface自定義注解時(shí),自動(dòng)繼承了java.lang.annotation.Annotation接口寻拂,由編譯程序自動(dòng)完成其他細(xì)節(jié)程奠。在定義注解時(shí),不能繼承其他的注解或接口祭钉。@interface用來聲明一個(gè)注解瞄沙,其中的每一個(gè)方法實(shí)際上是聲明了一個(gè)配置參數(shù)。方法的名稱就是參數(shù)的名稱慌核,返回值類型就是參數(shù)的類型(返回值類型只能是基本類型距境、Class、String垮卓、enum)垫桂。可以通過default來聲明參數(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è)訪問權(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ù)成員霹粥。

簡單的自定義注解和使用注解實(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("水果的名字是:蘋果");
    }
}

注解元素的默認(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í)慣用法泽台。例如:

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;

/**
 * 水果供應(yīng)者注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {
    /**
     * 供應(yīng)商編號(hào)
     * @return
     */
    public int id() default -1;
    
    /**
     * 供應(yīng)商名稱
     * @return
     */
    public String name() default "";
    
    /**
     * 供應(yīng)商地址
     * @return
     */
    public String address() default "";
}

定義了注解,并在需要的時(shí)候給相關(guān)類矾缓,類屬性加上注解信息怀酷,如果沒有響應(yīng)的注解信息處理流程,注解可以說是沒有實(shí)用價(jià)值嗜闻。如何讓注解真真的發(fā)揮作用蜕依,主要就在于注解處理方法,下一步我們將學(xué)習(xí)注解信息的獲取和處理琉雳!

轉(zhuǎn)自: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閱讀 218,858評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件束倍,死亡現(xiàn)場離奇詭異被丧,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)绪妹,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,372評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門甥桂,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人邮旷,你說我怎么就攤上這事黄选。” “怎么了婶肩?”我有些...
    開封第一講書人閱讀 165,282評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵办陷,是天一觀的道長貌夕。 經(jīng)常有香客問我,道長懂诗,這世上最難降的妖魔是什么蜂嗽? 我笑而不...
    開封第一講書人閱讀 58,842評(píng)論 1 295
  • 正文 為了忘掉前任苗膝,我火速辦了婚禮殃恒,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘辱揭。我一直安慰自己离唐,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,857評(píng)論 6 392
  • 文/花漫 我一把揭開白布问窃。 她就那樣靜靜地躺著亥鬓,像睡著了一般。 火紅的嫁衣襯著肌膚如雪域庇。 梳的紋絲不亂的頭發(fā)上嵌戈,一...
    開封第一講書人閱讀 51,679評(píng)論 1 305
  • 那天,我揣著相機(jī)與錄音听皿,去河邊找鬼熟呛。 笑死,一個(gè)胖子當(dāng)著我的面吹牛尉姨,可吹牛的內(nèi)容都是我干的庵朝。 我是一名探鬼主播,決...
    沈念sama閱讀 40,406評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼又厉,長吁一口氣:“原來是場噩夢啊……” “哼九府!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起覆致,我...
    開封第一講書人閱讀 39,311評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤侄旬,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后煌妈,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體勾怒,經(jīng)...
    沈念sama閱讀 45,767評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評(píng)論 3 336
  • 正文 我和宋清朗相戀三年声旺,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了笔链。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,090評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡腮猖,死狀恐怖鉴扫,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情澈缺,我是刑警寧澤坪创,帶...
    沈念sama閱讀 35,785評(píng)論 5 346
  • 正文 年R本政府宣布炕婶,位于F島的核電站,受9級(jí)特大地震影響莱预,放射性物質(zhì)發(fā)生泄漏柠掂。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,420評(píng)論 3 331
  • 文/蒙蒙 一依沮、第九天 我趴在偏房一處隱蔽的房頂上張望涯贞。 院中可真熱鬧,春花似錦危喉、人聲如沸宋渔。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,988評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽皇拣。三九已至,卻和暖如春薄嫡,著一層夾襖步出監(jiān)牢的瞬間氧急,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,101評(píng)論 1 271
  • 我被黑心中介騙來泰國打工毫深, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留吩坝,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,298評(píng)論 3 372
  • 正文 我出身青樓费什,卻偏偏與公主長得像钾恢,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子鸳址,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,033評(píng)論 2 355

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