Annotation for ANDROID ---First

學習註解原理的理由越來越多的Android庫中使用的註解，比如butterknife，EventBus3，okHttp裡面也是使用了註解，減少了重複程式碼的編寫，極大的方便我們快速開發，那麼瞭解其內部的工作原理極其重要，而且如果我們不知道其中的原理，我們在使用過程中遇到的相關問題就會一頭霧水，難以解決，所以我決定寫一個註解Annotation的系列文章，窺探註解之祕。
註解（Annotation）是什麼？Annotation是後設資料的一種形式，向外提供程式的資訊，但它本身並不是這個程式的一部分，它可以被新增到包，類，方法，變數中，並且可以在某個生命週期中（java原始碼中，編譯期，Runtime）被反射獲取。Annotation並不是直接影響它所註解的程式碼 。
簡單來說，註解（Annotation） 為我們在程式碼中新增資訊提供了一種形式化的方法，是我們可以在稍後某個時刻方便地使用這些資料（通過 解析註解 來使用這些資料）
註解（Annotation）用來做什麼？1.給編譯器提供資訊--例如提供給編譯器探測錯誤和壓制警告等等2.編譯期生成程式碼3.執行期（Runtime）處理註解
自定義註解新建一個java library的module，新建一個class
@Retention(RetentionPolicy.SOURCE)@Target(ElementType.TYPE)public @interface SourceAnnotation { String value() default "SourceAnnotation";}

先講一下元註解的概念，用來註解註解類的註解就是元註解，java提供了五種元註解，分別是@Documented,@Inherited, @Repeatable, @Target, @Retention
@Documented 它代表著此註解的元素會被javadoc工具提取成文件
@Inherited 允許子類繼承父類中的註解
@Repeatable Java SE8引入的註解，表示這個註解可以在同一處多次宣告
@Target 是用來描述該註解標記哪一種型別在java原始碼中，它的取值可為：
ElementType.ANNOTATION_TYPE 可以使用在註解型別上ElementType.CONSTRUCTOR 可以使用在構造方法上ElementType.FIELD 可以使用在屬性（成員變數）上ElementType.LOCAL_VARIABLE 可以使用在區域性變數上ElementType.METHOD 可以使用在方法上ElementType.PACKAGE 可以使用在包宣告上ElementType.PARAMETER 可以使用在方法引數上ElementType.TYPE 可以使用在類中任何元素

@Retention代表這個註解的生命週期，可以存活到什麼時期:
RetentionPolicy.SOURCE 存在在java原始碼中RetentionPolicy.CLASS 存活到編譯成Class中RetentionPolicy.RUNTIME 存活到執行時期

接下來重點理解一下這個Rentention，我們新建一個AnnotationClass的類，然後用上面定義的SourceAnnotation去註解它
@SourceAnnotation()public class AnnotationClass {}

編譯一下，

然後在build資料夾classes中查詢到AnnotationClass.class檔案檢視

package com.example;public class AnnotationClass { public AnnotationClass() { }}

我們的註解@SourceAnnotation()已經不存在了，這個就是RetentionPolicy.SOURCE的作用，使註解僅存在與java原始碼中。我接下來再定義一個註解，設定為RetentionPolicy.CLASS
@Retention(RetentionPolicy.CLASS)@Target(ElementType.TYPE)public @interface ClassAnnotation { public String value() default "ClassAnnotation";}

同樣，我們來註解一下AnnotationClass
@ClassAnnotation()public class AnnotationClass {}

編譯，查詢AnnotationClass.class檔案
@ClassAnnotationpublic class AnnotationClass { public AnnotationClass() { }}

發現我們@ClassAnnotation的註解還是存在的。
最後，我們使用RetentionPolicy.RUNTIME，新建
@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.TYPE)public @interface RuntimeAnnotation { String value() default "RuntimeAnnotation";}

註解AnnotationClass，編譯，猜想一下，是不是一樣存在？
@RuntimeAnnotationpublic class AnnotationClass { public AnnotationClass() { }}

是的，同在編譯成Class檔案中可以查詢到，那麼RetentionPolicy.Runtime和RetentionPolicy.CLASS區別又在哪裡呢？這涉及到Annotation的使用，我們上面提到，Annotation資訊的獲取是通過反射獲取的，我們可以通過Class中getAnnotation的方法來獲取接下來，我們來嘗試獲取AnnationClass類中的註解資訊。
註解資訊的獲取我們在AnnotationTest中，寫一個Main方法，作為程式的入口，編寫一下程式碼
public class AnnotationTest { public static void main(String[] args){ Class annotationClass = AnnotationClass.class; RuntimeAnnotation annotation = (RuntimeAnnotation) annotationClass.getAnnotation(RuntimeAnnotation.class); String value = annotation.value(); System.out.println("value:"+value); }}

我們上面定義了RuntimeAnnotation註解的預設的值是"RuntimeAnnotion",執行一下

檢視輸出

確實列印了RuntimeAnnotion的值，說明執行時期獲取到這個註解的值。接下來，我們獲取一下ClassAnnotation這個註解的值，看能否獲取得到，修改AnnotationClass的註解為@ClassAnnotation
@ClassAnnotation()public class AnnotationClass {}

修改main方法為
public class AnnotationTest { public static void main(String[] args){ Class annotationClass = AnnotationClass.class;// RuntimeAnnotation annotation = (RuntimeAnnotation) annotationClass.getAnnotation(RuntimeAnnotation.class); ClassAnnotation annotation = (ClassAnnotation) annotationClass.getAnnotation(ClassAnnotation.class); String value = annotation.value(); System.out.println("value:"+value); }}

如果獲取得到話，應該列印出的是預設值"ClassAnnotation"，我們執行一下,檢視輸出

我們發現報錯了，而且報錯的原因是在
String value = annotaion.value();

這一行報出空指標異常，也就是說我們獲取ClassAnnotation這個註解不存在，我們之前看到過，在編譯的class檔案中，這個註解是存在的。所以這個就是RetentionPolicy.CLASS和RetentionPolicy.RUNTIME的區別，RetentionPolicy.CLASS的註解是不會存活到執行時期的，在執行時期要想通過反射獲得註解，那麼你定義這個註解的時候需要使用RetentionPolicy.RUNTIME。
理解註解的基本使用之後，接下來我們將利用ART（Annotation Processing Tool）技術在編譯期生產程式碼