Java注解

注解是什么

對于很多初次接觸的開發(fā)者來說應(yīng)該都有這個疑問缰儿?Annontation是Java5開始引入的新特征,中文名稱叫注解散址。它提供了一種安全的類似注釋的機(jī)制乖阵,用來將任何的信息或元數(shù)據(jù)(metadata)與程序元素(類宣赔、方法、成員變量等)進(jìn)行關(guān)聯(lián)瞪浸。為程序的元素(類儒将、方法、成員變量)加上更直觀更明了的說明对蒲,這些說明信息是與程序的業(yè)務(wù)邏輯無關(guān)钩蚊,并且供指定的工具或框架使用。Annontation像一種修飾符一樣蹈矮,應(yīng)用于包砰逻、類型、構(gòu)造方法泛鸟、方法蝠咆、成員變量、參數(shù)及本地變量的聲明語句中北滥。
  Java注解是附加在代碼中的一些元信息刚操,用于一些工具在編譯、運(yùn)行時進(jìn)行解析和使用再芋,起到說明菊霜、配置的功能。注解不會也不能影響代碼的實(shí)際邏輯祝闻,僅僅起到輔助性的作用占卧。包含在 java.lang.annotation 包中。

注解的用處

1联喘、生成文檔华蜒。這是最常見的,也是java 最早提供的注解豁遭。常用的有@param @return 等
2叭喜、跟蹤代碼依賴性,實(shí)現(xiàn)替代配置文件功能蓖谢。比如Dagger 2依賴注入捂蕴,未來java開發(fā),將大量注解配置闪幽,具有很大用處;
3啥辨、在編譯時進(jìn)行格式檢查。如@override 放在方法前盯腌,如果你這個方法并不是覆蓋了超類方法溉知,則編譯時就能檢查出。

注解的原理

注解本質(zhì)是一個繼承了Annotation的特殊接口,其具體實(shí)現(xiàn)類是Java運(yùn)行時生成的動態(tài)代理類级乍。而我們通過反射獲取注解時舌劳,返回的是Java運(yùn)行時生成的動態(tài)代理對象$Proxy1。通過代理對象調(diào)用自定義注解(接口)的方法玫荣,會最終調(diào)用AnnotationInvocationHandler的invoke方法甚淡。該方法會從memberValues這個Map中索引出對應(yīng)的值。而memberValues的來源是Java常量池捅厂。

元注解

java.lang.annotation提供了四種元注解贯卦,專門注解其他的注解(在自定義注解的時候,需要使用到元注解):
@Documented –注解是否將包含在JavaDoc中
@Retention –什么時候使用該注解
@Target –注解用于什么地方
@Inherited – 是否允許子類繼承該注解

1.@Retention– 定義該注解的生命周期
● RetentionPolicy.SOURCE : 在編譯階段丟棄恒傻。這些注解在編譯結(jié)束之后就不再有任何意義脸侥,所以它們不會寫入字節(jié)碼。@Override, @SuppressWarnings都屬于這類注解盈厘。
● RetentionPolicy.CLASS : 在類加載的時候丟棄睁枕。在字節(jié)碼文件的處理中有用。注解默認(rèn)使用這種方式
● RetentionPolicy.RUNTIME : 始終不會丟棄沸手,運(yùn)行期也保留該注解外遇,因此可以使用反射機(jī)制讀取該注解的信息。我們自定義的注解通常使用這種方式契吉。

2.Target – 表示該注解用于什么地方跳仿。默認(rèn)值為任何元素,表示該注解用于什么地方捐晶》朴铮可用的ElementType參數(shù)包括
● ElementType.CONSTRUCTOR:用于描述構(gòu)造器
● ElementType.FIELD:成員變量、對象惑灵、屬性(包括enum實(shí)例)
● ElementType.LOCAL_VARIABLE:用于描述局部變量
● ElementType.METHOD:用于描述方法
● ElementType.PACKAGE:用于描述包
● ElementType.PARAMETER:用于描述參數(shù)
● ElementType.TYPE:用于描述類山上、接口(包括注解類型) 或enum聲明

3.@Documented–一個簡單的Annotations標(biāo)記注解,表示是否將注解信息添加在java文檔中英支。

4.@Inherited – 定義該注釋和子類的關(guān)系
@Inherited 元注解是一個標(biāo)記注解佩憾,@Inherited闡述了某個被標(biāo)注的類型是被繼承的。如果一個使用了@Inherited修飾的annotation類型被用于一個class干花,則這個annotation將被用于該class的子類妄帘。

自定義注解

自定義注解類編寫的一些規(guī)則:

  1. Annotation型定義為@interface, 所有的Annotation會自動繼承java.lang.Annotation這一接口,并且不能再去繼承別的類或是接口.
  2. 參數(shù)成員只能用public或默認(rèn)(default)這兩個訪問權(quán)修飾
  3. 參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和String、Enum池凄、Class抡驼、annotations等數(shù)據(jù)類型,以及這一些類型的數(shù)組.
  4. 要獲取類方法和字段的注解信息,必須通過Java的反射技術(shù)來獲取 Annotation對象,因?yàn)槟愠酥鉀]有別的獲取注解對象的方法
  5. 注解也可以沒有定義成員, 不過這樣注解就沒啥用了

自定義注解示例

@Target(value = ElementType.FIELD)
@Retention(value = RetentionPolicy.RUNTIME)
@Documented
public @interface Column {

    String name();
}

@Target(value = ElementType.TYPE)
@Inherited
@Retention(value = RetentionPolicy.RUNTIME)
@Documented
public @interface Table {

    String tableName();
}

@Table(tableName = "d_xiaow_entity")
public class TableEntity {

    @Column(name = "ID")
    private Long id;

    @Column(name = "NAME")
    private String name;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

public static void main(String [] args) throws Exception{
        Class entityClass = Class.forName("com.xiaow.learn.Annotion.TableEntity");
        if (entityClass.isAnnotationPresent(Table.class)) {
            Table T = (Table) entityClass.getAnnotation(Table.class);
            String tableName = T.tableName();
            System.out.print(tableName);
        }
        Field[] fields = entityClass.getFields();
        for (Field field: fields) {
            if (field.isAnnotationPresent(Column.class)) {
                String columnName = ((Column)field.getAnnotation(Column.class)).name();
                System.out.print(columnName);
            }
        }
    }
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末肿仑,一起剝皮案震驚了整個濱河市婶恼,隨后出現(xiàn)的幾起案子桑阶,更是在濱河造成了極大的恐慌柏副,老刑警劉巖勾邦,帶你破解...
    沈念sama閱讀 218,546評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異割择,居然都是意外死亡眷篇,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,224評論 3 395
  • 文/潘曉璐 我一進(jìn)店門荔泳,熙熙樓的掌柜王于貴愁眉苦臉地迎上來蕉饼,“玉大人,你說我怎么就攤上這事玛歌∶粮郏” “怎么了?”我有些...
    開封第一講書人閱讀 164,911評論 0 354
  • 文/不壞的土叔 我叫張陵支子,是天一觀的道長创肥。 經(jīng)常有香客問我,道長值朋,這世上最難降的妖魔是什么叹侄? 我笑而不...
    開封第一講書人閱讀 58,737評論 1 294
  • 正文 為了忘掉前任,我火速辦了婚禮昨登,結(jié)果婚禮上趾代,老公的妹妹穿的比我還像新娘。我一直安慰自己丰辣,他們只是感情好撒强,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,753評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著笙什,像睡著了一般飘哨。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上得湘,一...
    開封第一講書人閱讀 51,598評論 1 305
  • 那天杖玲,我揣著相機(jī)與錄音,去河邊找鬼淘正。 笑死摆马,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的鸿吆。 我是一名探鬼主播囤采,決...
    沈念sama閱讀 40,338評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼惩淳!你這毒婦竟也來了蕉毯?” 一聲冷哼從身側(cè)響起乓搬,我...
    開封第一講書人閱讀 39,249評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎代虾,沒想到半個月后进肯,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,696評論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡棉磨,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,888評論 3 336
  • 正文 我和宋清朗相戀三年江掩,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片乘瓤。...
    茶點(diǎn)故事閱讀 40,013評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡环形,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出衙傀,到底是詐尸還是另有隱情抬吟,我是刑警寧澤,帶...
    沈念sama閱讀 35,731評論 5 346
  • 正文 年R本政府宣布统抬,位于F島的核電站火本,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏蓄喇。R本人自食惡果不足惜发侵,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,348評論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望妆偏。 院中可真熱鬧刃鳄,春花似錦、人聲如沸钱骂。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,929評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽见秽。三九已至愉烙,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間解取,已是汗流浹背步责。 一陣腳步聲響...
    開封第一講書人閱讀 33,048評論 1 270
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留禀苦,地道東北人蔓肯。 一個月前我還...
    沈念sama閱讀 48,203評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像振乏,于是被迫代替她去往敵國和親蔗包。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,960評論 2 355

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