文章開(kāi)頭先引入一處圖片。

這處圖片引自老羅的博客。為了避免不必要的麻煩，首先聲明我個(gè)人比較尊敬老羅的。至于為什么放這張圖，自然是為本篇博文服務(wù)，接下來(lái)我自會(huì)說(shuō)明。好了，可以開(kāi)始今天的博文了。

Annotation 中文譯過(guò)來(lái)就是注解、標(biāo)釋的意思，在 Java 中注解是一個(gè)很重要的知識(shí)點(diǎn)，但經(jīng)常還是有點(diǎn)讓新手不容易理解。

我個(gè)人認(rèn)為，比較糟糕的技術(shù)文檔主要特征之一就是：用專業(yè)名詞來(lái)介紹專業(yè)名詞。

比如：

Java 注解用于為 Java 代碼提供元數(shù)據(jù)。作為元數(shù)據(jù)，注解不直接影響你的代碼執(zhí)行，但也有一些類型的注解實(shí)際上可以用于這一目的。Java 注解是從 Java5 開(kāi)始添加到 Java 的。

這是大多數(shù)網(wǎng)站上對(duì)于 Java 注解，解釋確實(shí)正確，但是說(shuō)實(shí)在話，我第一次學(xué)習(xí)的時(shí)候，頭腦一片空白。這什么跟什么??？聽(tīng)了像沒(méi)有聽(tīng)一樣。因?yàn)楦拍钐^(guò)于抽象，所以初學(xué)者實(shí)在是比較吃力才能夠理解，然后隨著自己開(kāi)發(fā)過(guò)程中不斷地強(qiáng)化練習(xí)，才會(huì)慢慢對(duì)它形成正確的認(rèn)識(shí)。

我在寫(xiě)這篇文章的時(shí)候，我就在思考。如何讓自己或者讓讀者能夠比較直觀地認(rèn)識(shí)注解這個(gè)概念？是要去官方文檔上翻譯說(shuō)明嗎？我馬上否定了這個(gè)答案。

后來(lái)，我想到了一樣?xùn)|西————墨水，墨水可以揮發(fā)、可以有不同的顏色，用來(lái)解釋注解正好。

不過(guò)，我繼續(xù)發(fā)散思維后，想到了一樣?xùn)|西能夠更好地代替墨水，那就是印章。印章可以沾上不同的墨水或者印泥，可以定制印章的文字或者圖案，如果愿意它也可以被戳到你任何想戳的物體表面。

但是，我再繼續(xù)發(fā)散思維后，又想到一樣?xùn)|西能夠更好地代替印章，那就是標(biāo)簽。標(biāo)簽是一張便利紙，標(biāo)簽上的內(nèi)容可以自由定義。常見(jiàn)的如貨架上的商品價(jià)格標(biāo)簽、圖書(shū)館中的書(shū)本編碼標(biāo)簽、實(shí)驗(yàn)室中化學(xué)材料的名稱類別標(biāo)簽等等。

并且，往抽象地說(shuō)，標(biāo)簽并不一定是一張紙，它可以是對(duì)人和事物的屬性評(píng)價(jià)。也就是說(shuō)，標(biāo)簽具備對(duì)于抽象事物的解釋。

所以，基于如此，我完成了自我的知識(shí)認(rèn)知升級(jí)，我決定用標(biāo)簽來(lái)解釋注解。

注解如同標(biāo)簽

回到博文開(kāi)始的地方，之前某新聞客戶端的評(píng)論有蓋樓的習(xí)慣，于是 “喬布斯重新定義了手機(jī)、羅永浩重新定義了傻X” 就經(jīng)常極為工整地出現(xiàn)在了評(píng)論樓層中，并且廣大網(wǎng)友在相當(dāng)長(zhǎng)的一段時(shí)間內(nèi)對(duì)于這種行為樂(lè)此不疲。這其實(shí)就是等同于貼標(biāo)簽的行為。

在某些網(wǎng)友眼中，羅永浩就成了傻X的代名詞。

廣大網(wǎng)友給羅永浩貼了一個(gè)名為“傻x”的標(biāo)簽，他們并不真正了解羅永浩，不知道他當(dāng)教師、砸冰箱、辦博客的壯舉，但是因?yàn)椤吧祒”這樣的標(biāo)簽存在，這有助于他們直接快速地對(duì)羅永浩這個(gè)人做出評(píng)價(jià)，然后基于此，羅永浩就可以成為茶余飯后的談資，這就是標(biāo)簽的力量。

而在網(wǎng)絡(luò)的另一邊，老羅靠他的人格魅力自然收獲一大批忠實(shí)的擁泵，他們對(duì)于老羅貼的又是另一種標(biāo)簽。

老羅還是老羅，但是由于人們對(duì)于它貼上的標(biāo)簽不同，所以造成對(duì)于他的看法大相徑庭，不喜歡他的人整天在網(wǎng)絡(luò)上評(píng)論抨擊嘲諷，而崇拜欣賞他的人則會(huì)愿意掙錢購(gòu)買錘子手機(jī)的發(fā)布會(huì)門票。

我無(wú)意于評(píng)價(jià)這兩種行為，我再引個(gè)例子。

《奇葩說(shuō)》是近年網(wǎng)絡(luò)上非?；馃岬霓q論節(jié)目，其中辯手陳銘被另外一個(gè)辯手馬薇薇攻擊說(shuō)是————“站在宇宙中心呼喚愛(ài)”，然后貼上了一個(gè)大大的標(biāo)簽————“雞湯男”，自此以后，觀眾再看到陳銘的時(shí)候，首先映入腦海中便是“雞湯男”三個(gè)大字，其實(shí)本身而言陳銘非常優(yōu)秀，為人師表、作風(fēng)正派、談吐舉止得體，但是在網(wǎng)絡(luò)中，因?yàn)閵蕵?lè)至上的環(huán)境所致，人們更愿意以?shī)蕵?lè)的心態(tài)來(lái)認(rèn)知一切，于是“雞湯男”就如陳銘自己所說(shuō)成了一個(gè)撕不了的標(biāo)簽。

我們可以抽象概括一下，標(biāo)簽是對(duì)事物行為的某些角度的評(píng)價(jià)與解釋。

到這里，終于可以引出本文的主角注解了。

初學(xué)者可以這樣理解注解：想像代碼具有生命，注解就是對(duì)于代碼中某些鮮活個(gè)體的貼上去的一張標(biāo)簽。簡(jiǎn)化來(lái)講，注解如同一張標(biāo)簽。

在未開(kāi)始學(xué)習(xí)任何注解具體語(yǔ)法而言，你可以把注解看成一張標(biāo)簽。這有助于你快速地理解它的大致作用。如果初學(xué)者在學(xué)習(xí)過(guò)程有大腦放空的時(shí)候，請(qǐng)不要慌張，對(duì)自己說(shuō)：

注解，標(biāo)簽。注解，標(biāo)簽。

注解語(yǔ)法

因?yàn)槠匠ｉ_(kāi)發(fā)少見(jiàn)，相信有不少的人員會(huì)認(rèn)為注解的地位不高。其實(shí)同 classs 和 interface 一樣，注解也屬于一種類型。它是在 Java SE 5.0 版本中開(kāi)始引入的概念。

注解的定義

注解通過(guò) @interface 關(guān)鍵字進(jìn)行定義。

public @interface TestAnnotation {
}
1
2

它的形式跟接口很類似，不過(guò)前面多了一個(gè) @ 符號(hào)。上面的代碼就創(chuàng)建了一個(gè)名字為 TestAnnotaion 的注解。

你可以簡(jiǎn)單理解為創(chuàng)建了一張名字為 TestAnnotation 的標(biāo)簽。

注解的應(yīng)用

上面創(chuàng)建了一個(gè)注解，那么注解的的使用方法是什么呢。

@TestAnnotation
public class Test {
}
1
2
3

創(chuàng)建一個(gè)類 Test,然后在類定義的地方加上 @TestAnnotation 就可以用 TestAnnotation 注解這個(gè)類了。

你可以簡(jiǎn)單理解為將 TestAnnotation 這張標(biāo)簽貼到 Test 這個(gè)類上面。

不過(guò)，要想注解能夠正常工作，還需要介紹一下一個(gè)新的概念那就是元注解。

元注解

元注解是什么意思呢？

元注解是可以注解到注解上的注解，或者說(shuō)元注解是一種基本注解，但是它能夠應(yīng)用到其它的注解上面。

如果難于理解的話，你可以這樣理解。元注解也是一張標(biāo)簽，但是它是一張?zhí)厥獾臉?biāo)簽，它的作用和目的就是給其他普通的標(biāo)簽進(jìn)行解釋說(shuō)明的。

元標(biāo)簽有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 種。

@Retention

Retention 的英文意為保留期的意思。當(dāng) @Retention 應(yīng)用到一個(gè)注解上的時(shí)候，它解釋說(shuō)明了這個(gè)注解的的存活時(shí)間。

它的取值如下：
- RetentionPolicy.SOURCE 注解只在源碼階段保留，在編譯器進(jìn)行編譯時(shí)它將被丟棄忽視。
- RetentionPolicy.CLASS 注解只被保留到編譯進(jìn)行的時(shí)候，它并不會(huì)被加載到 JVM 中。
- RetentionPolicy.RUNTIME 注解可以保留到程序運(yùn)行的時(shí)候，它會(huì)被加載進(jìn)入到 JVM 中，所以在程序運(yùn)行時(shí)可以獲取到它們。

我們可以這樣的方式來(lái)加深理解，@Retention 去給一張標(biāo)簽解釋的時(shí)候，它指定了這張標(biāo)簽張貼的時(shí)間。@Retention 相當(dāng)于給一張標(biāo)簽上面蓋了一張時(shí)間戳，時(shí)間戳指明了標(biāo)簽張貼的時(shí)間周期。

@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}
1
2
3

上面的代碼中，我們指定 TestAnnotation 可以在程序運(yùn)行周期被獲取到，因此它的生命周期非常的長(zhǎng)。

@Documented

顧名思義，這個(gè)元注解肯定是和文檔有關(guān)。它的作用是能夠?qū)⒆⒔庵械脑匕?Javadoc 中去。

@Target

Target 是目標(biāo)的意思，@Target 指定了注解運(yùn)用的地方。

你可以這樣理解，當(dāng)一個(gè)注解被 @Target 注解時(shí)，這個(gè)注解就被限定了運(yùn)用的場(chǎng)景。

類比到標(biāo)簽，原本標(biāo)簽是你想張貼到哪個(gè)地方就到哪個(gè)地方，但是因?yàn)?@Target 的存在，它張貼的地方就非常具體了，比如只能張貼到方法上、類上、方法參數(shù)上等等。@Target 有下面的取值

• ElementType.ANNOTATION_TYPE 可以給一個(gè)注解進(jìn)行注解
• ElementType.CONSTRUCTOR 可以給構(gòu)造方法進(jìn)行注解
• ElementType.FIELD 可以給屬性進(jìn)行注解
• ElementType.LOCAL_VARIABLE 可以給局部變量進(jìn)行注解
• ElementType.METHOD 可以給方法進(jìn)行注解
• ElementType.PACKAGE 可以給一個(gè)包進(jìn)行注解
• ElementType.PARAMETER 可以給一個(gè)方法內(nèi)的參數(shù)進(jìn)行注解
• ElementType.TYPE 可以給一個(gè)類型進(jìn)行注解，比如類、接口、枚舉

@Inherited

Inherited 是繼承的意思，但是它并不是說(shuō)注解本身可以繼承，而是說(shuō)如果一個(gè)超類被 @Inherited 注解過(guò)的注解進(jìn)行注解的話，那么如果它的子類沒(méi)有被任何注解應(yīng)用的話，那么這個(gè)子類就繼承了超類的注解。
說(shuō)的比較抽象。代碼來(lái)解釋。

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}


@Test
public class A {}


public class B extends A {}
1
2
3
4
5
6
7
8
9
10
11

注解 Test 被 @Inherited 修飾，之后類 A 被 Test 注解，類 B 繼承 A,類 B 也擁有 Test 這個(gè)注解。

可以這樣理解：

老子非常有錢，所以人們給他貼了一張標(biāo)簽叫做富豪。

老子的兒子長(zhǎng)大后，只要沒(méi)有和老子斷絕父子關(guān)系，雖然別人沒(méi)有給他貼標(biāo)簽，但是他自然也是富豪。

老子的孫子長(zhǎng)大了，自然也是富豪。

這就是人們口中戲稱的富一代，富二代，富三代。雖然叫法不同，好像好多個(gè)標(biāo)簽，但其實(shí)事情的本質(zhì)也就是他們有一張共同的標(biāo)簽，也就是老子身上的那張富豪的標(biāo)簽。

@Repeatable

Repeatable 自然是可重復(fù)的意思。@Repeatable 是 Java 1.8 才加進(jìn)來(lái)的，所以算是一個(gè)新的特性。

什么樣的注解會(huì)多次應(yīng)用呢？通常是注解的值可以同時(shí)取多個(gè)。

舉個(gè)例子，一個(gè)人他既是程序員又是產(chǎn)品經(jīng)理,同時(shí)他還是個(gè)畫(huà)家。

@interface Persons {
    Person[]  value();
}


@Repeatable(Persons.class)
@interface Person{
    String role default "";
}


@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

注意上面的代碼，@Repeatable 注解了 Person。而 @Repeatable 后面括號(hào)中的類相當(dāng)于一個(gè)容器注解。

什么是容器注解呢？就是用來(lái)存放其它注解的地方。它本身也是一個(gè)注解。

我們?cè)倏纯创a中的相關(guān)容器注解。

@interface Persons {
    Person[]  value();
}
1
2
3

按照規(guī)定，它里面必須要有一個(gè) value 的屬性，屬性類型是一個(gè)被 @Repeatable 注解過(guò)的注解數(shù)組，注意它是數(shù)組。

如果不好理解的話，可以這樣理解。Persons 是一張總的標(biāo)簽，上面貼滿了 Person 這種同類型但內(nèi)容不一樣的標(biāo)簽。把 Persons 給一個(gè) SuperMan 貼上，相當(dāng)于同時(shí)給他貼了程序員、產(chǎn)品經(jīng)理、畫(huà)家的標(biāo)簽。

我們可能對(duì)于 @Person(role=”PM”) 括號(hào)里面的內(nèi)容感興趣，它其實(shí)就是給 Person 這個(gè)注解的 role 屬性賦值為 PM ，大家不明白正常，馬上就講到注解的屬性這一塊。

注解的屬性

注解的屬性也叫做成員變量。注解只有成員變量，沒(méi)有方法。注解的成員變量在注解的定義中以“無(wú)形參的方法”形式來(lái)聲明，其方法名定義了該成員變量的名字，其返回值定義了該成員變量的類型。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {

    int id();

    String msg();

}
1
2
3
4
5
6
7
8
9

上面代碼定義了 TestAnnotation 這個(gè)注解中擁有 id 和 msg 兩個(gè)屬性。在使用的時(shí)候，我們應(yīng)該給它們進(jìn)行賦值。

賦值的方式是在注解的括號(hào)內(nèi)以 value=”” 形式，多個(gè)屬性之前用 ，隔開(kāi)。

@TestAnnotation(id=3,msg="hello annotation")
public class Test {

}
1
2
3
4

需要注意的是，在注解中定義屬性時(shí)它的類型必須是 8 種基本數(shù)據(jù)類型外加 類、接口、注解及它們的數(shù)組。

注解中屬性可以有默認(rèn)值，默認(rèn)值需要用 default 關(guān)鍵值指定。比如：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {

    public int id() default -1;

    public String msg() default "Hi";

}
1
2
3
4
5
6
7
8
9
10

TestAnnotation 中 id 屬性默認(rèn)值為 -1，msg 屬性默認(rèn)值為 Hi。
它可以這樣應(yīng)用。

@TestAnnotation()
public class Test {}
1
2

因?yàn)橛心J(rèn)值，所以無(wú)需要再在 @TestAnnotation 后面的括號(hào)里面進(jìn)行賦值了，這一步可以省略。

另外，還有一種情況。如果一個(gè)注解內(nèi)僅僅只有一個(gè)名字為 value 的屬性時(shí)，應(yīng)用這個(gè)注解時(shí)可以直接接屬性值填寫(xiě)到括號(hào)內(nèi)。

public @interface Check {
    String value();
}
1
2
3

上面代碼中，Check 這個(gè)注解只有 value 這個(gè)屬性。所以可以這樣應(yīng)用。

@Check("hi")
int a;
1
2

這和下面的效果是一樣的

@Check(value="hi")
int a;
1
2

最后，還需要注意的一種情況是一個(gè)注解沒(méi)有任何屬性。比如

public @interface Perform {}
1
2

那么在應(yīng)用這個(gè)注解的時(shí)候，括號(hào)都可以省略。

@Perform
public void testMethod(){}
1
2

Java 預(yù)置的注解

學(xué)習(xí)了上面相關(guān)的知識(shí)，我們已經(jīng)可以自己定義一個(gè)注解了。其實(shí) Java 語(yǔ)言本身已經(jīng)提供了幾個(gè)現(xiàn)成的注解。

@Deprecated

這個(gè)元素是用來(lái)標(biāo)記過(guò)時(shí)的元素，想必大家在日常開(kāi)發(fā)中經(jīng)常碰到。編譯器在編譯階段遇到這個(gè)注解時(shí)會(huì)發(fā)出提醒警告，告訴開(kāi)發(fā)者正在調(diào)用一個(gè)過(guò)時(shí)的元素比如過(guò)時(shí)的方法、過(guò)時(shí)的類、過(guò)時(shí)的成員變量。

public class Hero {

    @Deprecated
    public void say(){
        System.out.println("Noting has to say!");
    }


    public void speak(){
        System.out.println("I have a dream!");
    }


}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

定義了一個(gè) Hero 類，它有兩個(gè)方法 say() 和 speak() ，其中 say() 被 @Deprecated 注解。然后我們?cè)?IDE 中分別調(diào)用它們。

可以看到，say() 方法上面被一條直線劃了一條，這其實(shí)就是編譯器識(shí)別后的提醒效果。

@Override

這個(gè)大家應(yīng)該很熟悉了，提示子類要復(fù)寫(xiě)父類中被 @Override 修飾的方法

@SuppressWarnings

阻止警告的意思。之前說(shuō)過(guò)調(diào)用被 @Deprecated 注解的方法后，編譯器會(huì)警告提醒，而有時(shí)候開(kāi)發(fā)者會(huì)忽略這種警告，他們可以在調(diào)用的地方通過(guò) @SuppressWarnings 達(dá)到目的。

@SuppressWarnings("deprecation")
public void test1(){
    Hero hero = new Hero();
    hero.say();
    hero.speak();
}
1
2
3
4
5
6

@SafeVarargs

參數(shù)安全類型注解。它的目的是提醒開(kāi)發(fā)者不要用參數(shù)做一些不安全的操作,它的存在會(huì)阻止編譯器產(chǎn)生 unchecked 這樣的警告。它是在 Java 1.7 的版本中加入的。

@SafeVarargs // Not actually safe!
    static void m(List<String>... stringLists) {
    Object[] array = stringLists;
    List<Integer> tmpList = Arrays.asList(42);
    array[0] = tmpList; // Semantically invalid, but compiles without warnings
    String s = stringLists[0].get(0); // Oh no, ClassCastException at runtime!
}
1
2
3
4
5
6
7

上面的代碼中，編譯階段不會(huì)報(bào)錯(cuò)，但是運(yùn)行時(shí)會(huì)拋出 ClassCastException 這個(gè)異常，所以它雖然告訴開(kāi)發(fā)者要妥善處理，但是開(kāi)發(fā)者自己還是搞砸了。

Java 官方文檔說(shuō)，未來(lái)的版本會(huì)授權(quán)編譯器對(duì)這種不安全的操作產(chǎn)生錯(cuò)誤警告。

@FunctionalInterface

函數(shù)式接口注解，這個(gè)是 Java 1.8 版本引入的新特性。函數(shù)式編程很火，所以 Java 8 也及時(shí)添加了這個(gè)特性。

函數(shù)式接口 (Functional Interface) 就是一個(gè)具有一個(gè)方法的普通接口。

比如

@FunctionalInterface
public interface Runnable {
    /**
     * When an object implementing interface <code>Runnable</code> is used
     * to create a thread, starting the thread causes the object's
     * <code>run</code> method to be called in that separately executing
     * thread.
     * <p>
     * The general contract of the method <code>run</code> is that it may
     * take any action whatsoever.
     *
     * @see     java.lang.Thread#run()
     */
    public abstract void run();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

我們進(jìn)行線程開(kāi)發(fā)中常用的 Runnable 就是一個(gè)典型的函數(shù)式接口，上面源碼可以看到它就被 @FunctionalInterface 注解。

可能有人會(huì)疑惑，函數(shù)式接口標(biāo)記有什么用，這個(gè)原因是函數(shù)式接口可以很容易轉(zhuǎn)換為 Lambda 表達(dá)式。這是另外的主題了，有興趣的同學(xué)請(qǐng)自己搜索相關(guān)知識(shí)點(diǎn)學(xué)習(xí)。

注解的提取

博文前面的部分講了注解的基本語(yǔ)法，現(xiàn)在是時(shí)候檢測(cè)我們所學(xué)的內(nèi)容了。

我通過(guò)用標(biāo)簽來(lái)比作注解，前面的內(nèi)容是講怎么寫(xiě)注解，然后貼到哪個(gè)地方去，而現(xiàn)在我們要做的工作就是檢閱這些標(biāo)簽內(nèi)容。 形象的比喻就是你把這些注解標(biāo)簽在合適的時(shí)候撕下來(lái)，然后檢閱上面的內(nèi)容信息。

要想正確檢閱注解，離不開(kāi)一個(gè)手段，那就是反射。

注解與反射。

注解通過(guò)反射獲取。首先可以通過(guò) Class 對(duì)象的 isAnnotationPresent() 方法判斷它是否應(yīng)用了某個(gè)注解

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}
1
2

然后通過(guò) getAnnotation() 方法來(lái)獲取 Annotation 對(duì)象。

 public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}
1
2

或者是 getAnnotations() 方法。

public Annotation[] getAnnotations() {}
1
2

前一種方法返回指定類型的注解，后一種方法返回注解到這個(gè)元素上的所有注解。

如果獲取到的 Annotation 如果不為 null，則就可以調(diào)用它們的屬性方法了。比如

@TestAnnotation()
public class Test {

    public static void main(String[] args) {

        boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);

        if ( hasAnnotation ) {
            TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);

            System.out.println("id:"+testAnnotation.id());
            System.out.println("msg:"+testAnnotation.msg());
        }

    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

程序的運(yùn)行結(jié)果是：

id:-1
msg:
1
2
3

這個(gè)正是 TestAnnotation 中 id 和 msg 的默認(rèn)值。

上面的例子中，只是檢閱出了注解在類上的注解，其實(shí)屬性、方法上的注解照樣是可以的。同樣還是要假手于反射。

@TestAnnotation(msg="hello")
public class Test {

    @Check(value="hi")
    int a;


    @Perform
    public void testMethod(){}


    @SuppressWarnings("deprecation")
    public void test1(){
        Hero hero = new Hero();
        hero.say();
        hero.speak();
    }


    public static void main(String[] args) {

        boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);

        if ( hasAnnotation ) {
            TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
            //獲取類的注解
            System.out.println("id:"+testAnnotation.id());
            System.out.println("msg:"+testAnnotation.msg());
        }


        try {
            Field a = Test.class.getDeclaredField("a");
            a.setAccessible(true);
            //獲取一個(gè)成員變量上的注解
            Check check = a.getAnnotation(Check.class);

            if ( check != null ) {
                System.out.println("check value:"+check.value());
            }

            Method testMethod = Test.class.getDeclaredMethod("testMethod");

            if ( testMethod != null ) {
                // 獲取方法中的注解
                Annotation[] ans = testMethod.getAnnotations();
                for( int i = 0;i < ans.length;i++) {
                    System.out.println("method testMethod annotation:"+ans[i].annotationType().getSimpleName());
                }
            }
        } catch (NoSuchFieldException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
            System.out.println(e.getMessage());
        } catch (SecurityException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
            System.out.println(e.getMessage());
        } catch (NoSuchMethodException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
            System.out.println(e.getMessage());
        }



    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

它們的結(jié)果如下：

id:-1
msg:hello
check value:hi
method testMethod annotation:Perform
1
2
3
4
5

需要注意的是，如果一個(gè)注解要在運(yùn)行時(shí)被成功提取，那么 @Retention(RetentionPolicy.RUNTIME) 是必須的。

注解的使用場(chǎng)景

我相信博文講到這里大家都很熟悉了注解，但是有不少同學(xué)肯定會(huì)問(wèn)，注解到底有什么用呢？

對(duì)啊注解到底有什么用？

我們不妨將目光放到 Java 官方文檔上來(lái)。

文章開(kāi)始的時(shí)候，我用標(biāo)簽來(lái)類比注解。但標(biāo)簽比喻只是我的手段，而不是目的。為的是讓大家在初次學(xué)習(xí)注解時(shí)能夠不被那些抽象的新概念搞懵。既然現(xiàn)在，我們已經(jīng)對(duì)注解有所了解，我們不妨再仔細(xì)閱讀官方最嚴(yán)謹(jǐn)?shù)奈臋n。

注解是一系列元數(shù)據(jù)，它提供數(shù)據(jù)用來(lái)解釋程序代碼，但是注解并非是所解釋的代碼本身的一部分。注解對(duì)于代碼的運(yùn)行效果沒(méi)有直接影響。

注解有許多用處，主要如下：
- 提供信息給編譯器： 編譯器可以利用注解來(lái)探測(cè)錯(cuò)誤和警告信息
- 編譯階段時(shí)的處理： 軟件工具可以用來(lái)利用注解信息來(lái)生成代碼、Html文檔或者做其它相應(yīng)處理。
- 運(yùn)行時(shí)的處理： 某些注解可以在程序運(yùn)行的時(shí)候接受代碼的提取

值得注意的是，注解不是代碼本身的一部分。

如果難于理解，可以這樣看。羅永浩還是羅永浩，不會(huì)因?yàn)槟承┤藢?duì)于他“傻x”的評(píng)價(jià)而改變，標(biāo)簽只是某些人對(duì)于其他事物的評(píng)價(jià)，但是標(biāo)簽不會(huì)改變事物本身，標(biāo)簽只是特定人群的手段。所以，注解同樣無(wú)法改變代碼本身，注解只是某些工具的的工具。

還是回到官方文檔的解釋上，注解主要針對(duì)的是編譯器和其它工具軟件(SoftWare tool)。

當(dāng)開(kāi)發(fā)者使用了Annotation 修飾了類、方法、Field 等成員之后，這些 Annotation 不會(huì)自己生效，必須由開(kāi)發(fā)者提供相應(yīng)的代碼來(lái)提取并處理 Annotation 信息。這些處理提取和處理 Annotation 的代碼統(tǒng)稱為 APT（Annotation Processing Tool)。

現(xiàn)在，我們可以給自己答案了，注解有什么用？給誰(shuí)用？給 編譯器或者 APT 用的。

如果，你還是沒(méi)有搞清楚的話，我親自寫(xiě)一個(gè)好了。

親手自定義注解完成某個(gè)目的

我要寫(xiě)一個(gè)測(cè)試框架，測(cè)試程序員的代碼有無(wú)明顯的異常。

—— 程序員 A : 我寫(xiě)了一個(gè)類，它的名字叫做 NoBug，因?yàn)樗械姆椒ǘ紱](méi)有錯(cuò)誤。
—— 我：自信是好事，不過(guò)為了防止意外，讓我測(cè)試一下如何？
—— 程序員 A: 怎么測(cè)試？
—— 我：把你寫(xiě)的代碼的方法都加上 @Jiecha 這個(gè)注解就好了。
—— 程序員 A: 好的。

NoBug.java

package ceshi;
import ceshi.Jiecha;


public class NoBug {

    @Jiecha
    public void suanShu(){
        System.out.println("1234567890");
    }
    @Jiecha
    public void jiafa(){
        System.out.println("1+1="+1+1);
    }
    @Jiecha
    public void jiefa(){
        System.out.println("1-1="+(1-1));
    }
    @Jiecha
    public void chengfa(){
        System.out.println("3 x 5="+ 3*5);
    }
    @Jiecha
    public void chufa(){
        System.out.println("6 / 0="+ 6 / 0);
    }

    public void ziwojieshao(){
        System.out.println("我寫(xiě)的程序沒(méi)有 bug!");
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

上面的代碼，有些方法上面運(yùn)用了 @Jiecha 注解。

這個(gè)注解是我寫(xiě)的測(cè)試軟件框架中定義的注解。

package ceshi;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface Jiecha {

}
1
2
3
4
5
6
7
8
9

然后，我再編寫(xiě)一個(gè)測(cè)試類 TestTool 就可以測(cè)試 NoBug 相應(yīng)的方法了。

package ceshi;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;



public class TestTool {

    public static void main(String[] args) {
        // TODO Auto-generated method stub

        NoBug testobj = new NoBug();

        Class clazz = testobj.getClass();

        Method[] method = clazz.getDeclaredMethods();
        //用來(lái)記錄測(cè)試產(chǎn)生的 log 信息
        StringBuilder log = new StringBuilder();
        // 記錄異常的次數(shù)
        int errornum = 0;

        for ( Method m: method ) {
            // 只有被 @Jiecha 標(biāo)注過(guò)的方法才進(jìn)行測(cè)試
            if ( m.isAnnotationPresent( Jiecha.class )) {
                try {
                    m.setAccessible(true);
                    m.invoke(testobj, null);

                } catch (Exception e) {
                    // TODO Auto-generated catch block
                    //e.printStackTrace();
                    errornum++;
                    log.append(m.getName());
                    log.append(" ");
                    log.append("has error:");
                    log.append("\n\r  caused by ");
                    //記錄測(cè)試過(guò)程中，發(fā)生的異常的名稱
                    log.append(e.getCause().getClass().getSimpleName());
                    log.append("\n\r");
                    //記錄測(cè)試過(guò)程中，發(fā)生的異常的具體信息
                    log.append(e.getCause().getMessage());
                    log.append("\n\r");
                } 
            }
        }


        log.append(clazz.getSimpleName());
        log.append(" has  ");
        log.append(errornum);
        log.append(" error.");

        // 生成測(cè)試報(bào)告
        System.out.println(log.toString());

    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

測(cè)試的結(jié)果是：

1234567890
1+1=11
1-1=0
3 x 5=15
chufa has error:

  caused by ArithmeticException

/ by zero

NoBug has  1 error.
1
2
3
4
5
6
7
8
9
10
11
12

提示 NoBug 類中的 chufa() 這個(gè)方法有異常，這個(gè)異常名稱叫做 ArithmeticException，原因是運(yùn)算過(guò)程中進(jìn)行了除 0 的操作。

所以，NoBug 這個(gè)類有 Bug。

這樣，通過(guò)注解我完成了我自己的目的，那就是對(duì)別人的代碼進(jìn)行測(cè)試。

所以，再問(wèn)我注解什么時(shí)候用？我只能告訴你，這取決于你想利用它干什么用。

注解應(yīng)用實(shí)例

注解運(yùn)用的地方太多了，因?yàn)槲沂?Android 開(kāi)發(fā)者，所以我接觸到的具體例子有下：

JUnit

JUnit 這個(gè)是一個(gè)測(cè)試框架，典型使用方法如下：

public class ExampleUnitTest {
    @Test
    public void addition_isCorrect() throws Exception {
        assertEquals(4, 2 + 2);
    }
}
1
2
3
4
5
6

@Test 標(biāo)記了要進(jìn)行測(cè)試的方法 addition_isCorrect().

ButterKnife

ButterKnife 是 Android 開(kāi)發(fā)中大名鼎鼎的 IOC 框架，它減少了大量重復(fù)的代碼。

public class MainActivity extends AppCompatActivity {

    @BindView(R.id.tv_test)
    TextView mTv;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        ButterKnife.bind(this);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

Dagger2

也是一個(gè)很有名的依賴注入框架。

Retrofit

很牛逼的 Http 網(wǎng)絡(luò)訪問(wèn)框架

public interface GitHubService {
  @GET("users/{user}/repos")
  Call<List<Repo>> listRepos(@Path("user") String user);
}

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com/")
    .build();

GitHubService service = retrofit.create(GitHubService.class);
1
2
3
4
5
6
7
8
9
10
11

當(dāng)然，還有許多注解應(yīng)用的地方，這里不一一列舉。

總結(jié)

1. 如果注解難于理解，你就把它類同于標(biāo)簽，標(biāo)簽為了解釋事物，注解為了解釋代碼。
2. 注解的基本語(yǔ)法，創(chuàng)建如同接口，但是多了個(gè) @ 符號(hào)。
3. 注解的元注解。
4. 注解的屬性。
5. 注解主要給編譯器及工具類型的軟件用的。
6. 注解的提取需要借助于 Java 的反射技術(shù)，反射比較慢，所以注解使用時(shí)也需要謹(jǐn)慎計(jì)較時(shí)間成本。

Java 反射機(jī)制中另外一個(gè)比較重要的概念就是動(dòng)態(tài)代理了，寫(xiě)下這篇文章后，我一鼓作氣，又寫(xiě)了這篇 《輕松學(xué)，Java 中的代理模式及動(dòng)態(tài)代理》，有興趣的同學(xué)可以一并閱讀一下。

最后致敬老羅和陳銘，拿你們的事例為博文主題提供論點(diǎn)，只是基于技術(shù)視角，并沒(méi)有一絲惡意和冒犯之心。