一、注解

Java 注解用于為 Java 代碼提供元數據。作為元數據，注解不直接影響你的代碼執行，但也有一些類型的注解實際上可以用于這一目的。Java 注解是從 Java5 開始添加到 Java 的。因為平常開發少見，相信有不少的人員會認為注解的地位不高。其實同 classs 和 interface 一樣，注解也屬于一種類型。

注解(Annotation) 相當于一種標記，在程序中加入注解就等于為程序打上某種標記，沒有加，則等于沒有任何標記，以后，javac編譯器、開發工具和其他程序可以通過反射來了解你的類及各種元素上有無何種標記，看你的程序有什么標記，就去干相應的事，標記可以加在包、類，屬性、方法，方法的參數以及局部變量上。

注解的定義

注解通過 @interface 關鍵字進行定義。

public @interface TestAnnotation {
}

它的形式跟接口很類似，不過前面多了一個 @符號。上面的代碼就創建了一個名字為 TestAnnotaion 的注解。

你可以簡單理解為創建了一張名字為 TestAnnotation 的標簽。

注解的應用

上面創建了一個注解，那么注解的的使用方法是什么呢。

@TestAnnotation
public class Test {
}

創建一個類 Test，然后在類定義的地方加上 @TestAnnotation 就可以用 TestAnnotation 注解這個類了。

你可以簡單理解為將 TestAnnotation 這張標簽貼到 Test 這個類上面。

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

元注解

元注解是什么意思呢？

元注解 是可以注解到注解上的注解，或者說元注解是一種基本注解，但是它能夠應用到其它的注解上面。

如果難于理解的話，你可以這樣理解。元注解也是一張標簽，但是它是一張特殊的標簽，它的作用和目的就是給其他普通的標簽進行解釋說明的。

元標簽有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 種。

@Retention

Retention 的英文意為保留期的意思。當 @Retention 應用到一個注解上的時候，它解釋說明了這個注解的的存活時間。

它的取值如下：

• RetentionPolicy.SOURCE 注解只在源碼階段保留，在編譯器進行編譯時它將被丟棄忽視。

• RetentionPolicy.CLASS 注解只被保留到編譯進行的時候，它并不會被加載到 JVM 中。

• RetentionPolicy.RUNTIME 注解可以保留到程序運行的時候，它會被加載進入到 JVM 中，所以在程序運行時可以獲取到它們。

我們可以這樣的方式來加深理解，@Retention 去給一張標簽解釋的時候，它指定了這張標簽張貼的時間。@Retention 相當于給一張標簽上面蓋了一張時間戳，時間戳指明了標簽張貼的時間周期。

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

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

@Documented

顧名思義，這個 元注解肯定是和文檔有關。它的作用是能夠將注解中的元素包含到 Javadoc 中去。

@Target

Target 是目標的意思，@Target 指定了注解運用的地方。

你可以這樣理解，當一個注解被 @Target 注解時，這個注解就被限定了運用的場景。

類比到標簽，原本標簽是你想張貼到哪個地方就到哪個地方，但是因為 @Target 的存在，它張貼的地方就非常具體了，比如只能張貼到方法上、類上、方法參數上等等。@Target 有下面的取值

• ElementType.ANNOTATION_TYPE 可以給一個注解進行注解

• ElementType.CONSTRUCTOR 可以給構造方法進行注解

• ElementType.FIELD 可以給屬性進行注解

• ElementType.LOCAL_VARIABLE 可以給局部變量進行注解

• ElementType.METHOD 可以給方法進行注解

• ElementType.PACKAGE 可以給一個包進行注解

• ElementType.PARAMETER 可以給一個方法內的參數進行注解

• ElementType.TYPE 可以給一個類型進行注解，比如類、接口、枚舉

@Inherited

Inherited 是繼承的意思，但是它并不是說注解本身可以繼承，而是說如果一個超類被 @Inherited 注解過的注解進行注解的話，那么如果它的子類沒有被任何注解應用的話，那么這個子類就繼承了超類的注解。

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}@Test
public class A {}public class B extends A {}

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

可以這樣理解：

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

老子的兒子長大后，只要沒有和老子斷絕父子關系，雖然別人沒有給他貼標簽，但是他自然也是富豪。

老子的孫子長大了，自然也是富豪。

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

@Repeatable

Repeatable 自然是可重復的意思。@Repeatable 是 Java 1.8 才加進來的，所以算是一個新的特性。

什么樣的注解會多次應用呢？通常是注解的值可以同時取多個。

舉個例子，一個人他既是程序員又是產品經理,同時他還是個畫家。

@interface Persons {Person[]  value();
}@Repeatable(Persons.class)
@interface Person{String role default "";
}@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{}

注意上面的代碼，@Repeatable 注解了 Person。而 @Repeatable 后面括號中的類相當于一個容器注解。

什么是容器注解呢？就是用來存放其它注解的地方。它本身也是一個注解。

我們再看看代碼中的相關容器注解。

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

按照規定，它里面必須要有一個 value 的屬性，屬性類型是一個被 @Repeatable 注解過的注解數組，注意它是數組。

如果不好理解的話，可以這樣理解。Persons 是一張總的標簽，上面貼滿了 Person 這種同類型但內容不一樣的標簽。把 Persons 給一個 SuperMan 貼上，相當于同時給他貼了程序員、產品經理、畫家的標簽。

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

注解的屬性

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

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {int id();String msg();}

上面代碼定義了 TestAnnotation 這個注解中擁有 id 和 msg 兩個屬性。在使用的時候，我們應該給它們進行賦值。

賦值的方式是在注解的括號內以 value=”” 形式，多個屬性之前用 ，隔開。

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

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

注解中屬性可以有默認值，默認值需要用 default 關鍵值指定。比如：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {public int id() default -1;public String msg() default "Hi";}

TestAnnotation 中 id 屬性默認值為 -1，msg 屬性默認值為 Hi。
它可以這樣應用。

@TestAnnotation()
public class Test {}

因為有默認值，所以無需要再在 @TestAnnotation 后面的括號里面進行賦值了，這一步可以省略。

另外，還有一種情況。如果一個注解內僅僅只有一個名字為 value 的屬性時，應用這個注解時可以直接接屬性值填寫到括號內。

public @interface Check {String value();
}

上面代碼中，Check 這個注解只有 value 這個屬性。所以可以這樣應用。

@Check("hi")
int a;

這和下面的效果是一樣的

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

最后，還需要注意的一種情況是一個注解沒有任何屬性。比如

public @interface Perform {}

那么在應用這個注解的時候，括號都可以省略。

@Perform
public void testMethod(){}

Java 預置的注解

學習了上面相關的知識，我們已經可以自己定義一個注解了。其實 Java 語言本身已經提供了幾個現成的注解。

@Deprecated

這個元素是用來標記過時的元素，想必大家在日常開發中經常碰到。編譯器在編譯階段遇到這個注解時會發出提醒警告，告訴開發者正在調用一個過時的元素比如過時的方法、過時的類、過時的成員變量。

public class Hero {@Deprecatedpublic void say(){System.out.println("Noting has to say!");}public void speak(){System.out.println("I have a dream!");}}

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

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

@Override

這個大家應該很熟悉了，提示子類要復寫父類中被 @Override 修飾的方法

@SuppressWarnings

阻止警告的意思。之前說過調用被 @Deprecated 注解的方法后，編譯器會警告提醒，而有時候開發者會忽略這種警告，他們可以在調用的地方通過 @SuppressWarnings 達到目的。

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

@SafeVarargs

參數安全類型注解。它的目的是提醒開發者不要用參數做一些不安全的操作,它的存在會阻止編譯器產生 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 warningsString s = stringLists[0].get(0); // Oh no, ClassCastException at runtime!
}

上面的代碼中，編譯階段不會報錯，但是運行時會拋出 ClassCastException 這個異常，所以它雖然告訴開發者要妥善處理，但是開發者自己還是搞砸了。

Java 官方文檔說，未來的版本會授權編譯器對這種不安全的操作產生錯誤警告。

@FunctionalInterface

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

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

比如：

@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();
}

我們進行線程開發中常用的 Runnable 就是一個典型的函數式接口，上面源碼可以看到它就被 @FunctionalInterface 注解。

可能有人會疑惑，函數式接口標記有什么用，這個原因是函數式接口可以很容易轉換為 Lambda 表達式。這是另外的主題了，有興趣的同學請自己搜索相關知識點學習。

二、注解的提取

博文前面的部分講了注解的基本語法，現在是時候檢測我們所學的內容了。

我通過用標簽來比作注解，前面的內容是講怎么寫注解，然后貼到哪個地方去，而現在我們要做的工作就是檢閱這些標簽內容。 形象的比喻就是你把這些注解標簽在合適的時候撕下來，然后檢閱上面的內容信息。

要想正確檢閱注解，離不開一個手段，那就是反射。

三、注解與反射

注解通過反射獲取。首先可以通過 Class 對象的 isAnnotationPresent() 方法判斷它是否應用了某個注解

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

然后通過 getAnnotation() 方法來獲取 Annotation 對象。

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

或者是 getAnnotations() 方法。

public Annotation[] getAnnotations() {}

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

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

@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());}}}

程序的運行結果是：

id:-1
msg:

這個正是 TestAnnotation 中 id 和 msg 的默認值。

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

@TestAnnotation(msg="hello")
public class Test {@Check(value="hi")int a;@Performpublic 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);//獲取一個成員變量上的注解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 blocke.printStackTrace();System.out.println(e.getMessage());} catch (SecurityException e) {// TODO Auto-generated catch blocke.printStackTrace();System.out.println(e.getMessage());} catch (NoSuchMethodException e) {// TODO Auto-generated catch blocke.printStackTrace();System.out.println(e.getMessage());}}}

它們的結果如下：

id:-1
msg:hello
check value:hi
method testMethod annotation:Perform

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

四、注解的使用場景

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

對啊注解到底有什么用？

我們不妨將目光放到 Java 官方文檔上來。

文章開始的時候，我用標簽來類比注解。但標簽比喻只是我的手段，而不是目的。為的是讓大家在初次學習注解時能夠不被那些抽象的新概念搞懵。既然現在，我們已經對注解有所了解，我們不妨再仔細閱讀官方最嚴謹的文檔。

注解是一系列元數據，它提供數據用來解釋程序代碼，但是注解并非是所解釋的代碼本身的一部分。注解對于代碼的運行效果沒有直接影響。

注解有許多用處，主要如下：

• 提供信息給編譯器： 編譯器可以利用注解來探測錯誤和警告信息

• 編譯階段時的處理： 軟件工具可以用來利用注解信息來生成代碼、Html文檔或者做其它相應處理。

• 運行時的處理： 某些注解可以在程序運行的時候接受代碼的提取

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

如果難于理解，可以這樣看。羅永浩還是羅永浩，不會因為某些人對于他“傻x”的評價而改變，標簽只是某些人對于其他事物的評價，但是標簽不會改變事物本身，標簽只是特定人群的手段。所以，注解同樣無法改變代碼本身，注解只是某些工具的的工具。

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

當開發者使用了Annotation 修飾了類、方法、Field 等成員之后，這些 Annotation 不會自己生效，必須由開發者提供相應的代碼來提取并處理 Annotation 信息。這些處理提取和處理 Annotation 的代碼統稱為 APT（Annotation Processing Tool)。

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

如果，你還是沒有搞清楚的話，我親自寫一個好了。

五、親手自定義注解完成某個目的

我要寫一個測試框架，測試程序員的代碼有無明顯的異常。

—— 程序員 A : 我寫了一個類，它的名字叫做 NoBug，因為它所有的方法都沒有錯誤。
—— 我：自信是好事，不過為了防止意外，讓我測試一下如何？
—— 程序員 A: 怎么測試？
—— 我：把你寫的代碼的方法都加上 @Jiecha 這個注解就好了。
—— 程序員 A: 好的。

NoBug.java

package ceshi;
import ceshi.Jiecha;public class NoBug {@Jiechapublic void suanShu(){System.out.println("1234567890");}@Jiechapublic void jiafa(){System.out.println("1+1="+1+1);}@Jiechapublic void jiefa(){System.out.println("1-1="+(1-1));}@Jiechapublic void chengfa(){System.out.println("3 x 5="+ 3*5);}@Jiechapublic void chufa(){System.out.println("6 / 0="+ 6 / 0);}public void ziwojieshao(){System.out.println("我寫的程序沒有 bug!");}}

上面的代碼，有些方法上面運用了 @Jiecha 注解。

這個注解是我寫的測試軟件框架中定義的注解。

package ceshi;import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;@Retention(RetentionPolicy.RUNTIME)
public @interface Jiecha {}

然后，我再編寫一個測試類 TestTool 就可以測試 NoBug 相應的方法了。

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 stubNoBug testobj = new NoBug();Class clazz = testobj.getClass();Method[] method = clazz.getDeclaredMethods();//用來記錄測試產生的 log 信息StringBuilder log = new StringBuilder();// 記錄異常的次數int errornum = 0;for ( Method m: method ) {// 只有被 @Jiecha 標注過的方法才進行測試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 ");//記錄測試過程中，發生的異常的名稱log.append(e.getCause().getClass().getSimpleName());log.append("\n\r");//記錄測試過程中，發生的異常的具體信息log.append(e.getCause().getMessage());log.append("\n\r");} }}log.append(clazz.getSimpleName());log.append(" has  ");log.append(errornum);log.append(" error.");// 生成測試報告System.out.println(log.toString());}}

測試的結果是：

1234567890
1+1=11
1-1=0
3 x 5=15
chufa has error:caused by ArithmeticException/ by zeroNoBug has  1 error.

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

所以，NoBug 這個類有 Bug。

這樣，通過注解我完成了我自己的目的，那就是對別人的代碼進行測試。

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

六、注解應用實例

注解運用的地方太多了，因為我是 Android 開發者，所以我接觸到的具體例子有下：

JUnit

JUnit 這個是一個測試框架，典型使用方法如下：

public class ExampleUnitTest {@Testpublic void addition_isCorrect() throws Exception {assertEquals(4, 2 + 2);}
}

@Test 標記了要進行測試的方法 addition_isCorrect()。

ButterKnife

ButterKnife 是 Android 開發中大名鼎鼎的 IOC 框架，它減少了大量重復的代碼。

public class MainActivity extends AppCompatActivity {@BindView(R.id.tv_test)TextView mTv;@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);ButterKnife.bind(this);}
}

Dagger2

也是一個很有名的依賴注入框架。

Retrofit

很牛逼的 Http 網絡訪問框架

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);

當然，還有許多注解應用的地方，這里不一一列舉。

七、總結

• 如果注解難于理解，你就把它類同于標簽，標簽為了解釋事物，注解為了解釋代碼。

• 注解的基本語法，創建如同接口，但是多了個 @ 符號。

• 注解的元注解。

• 注解的屬性。

• 注解主要給編譯器及工具類型的軟件用的。

• 注解的提取需要借助于 Java 的反射技術，反射比較慢，所以注解使用時也需要謹慎計較時間成本。