## 寫在前面

JDK5增加了對Annotation（註解）的支援，Annotation是程式碼裡的特殊標記，這些標記可以在編譯，類載入和執行時被讀取讀取出來，並執行相應的處理和操作！比如在不改變程式邏輯的情況下，開發人員可以在程式碼中嵌入一些補充資訊，程式碼分析和開發部署工具APT（AnnotationProcessTool）可以通過這些資訊進行驗證或部署。

APT工具在處理註解時，會根據原始檔的Annotation資訊，生成附加原始檔或者進行一些其他操作！最後在車鞥徐編譯時期，APT會將生成的附加原始檔和原有原始檔進行合併，生成最終的*.class檔案！預設情況下，Annotation可以修飾任何程式元素（ElementType），包括類，介面，成員方法，成員變數。根據Annotation是否帶成員變數，可分為兩類：

• 標記Annotation，根據自身存在與否提供資訊；
• 元資料Annotation，根據接收的成員變數值，提供元資料資訊；

## 設計Annotation

與定義一個介面很相似，自定義Annotation使用@interface關鍵字：

//字元定義Annotation
public @interface CustomAnno {
}

//使用上面自定義的Annotaiton，修飾類
@CustomAnno
public class BeautifulClass {
    //修飾成員方法
    @CustomAnno
    public void toPlus() {...}
}

Annotation也可以有成員變數，如下定義：

public @interface HelloAnno {
    //定義帶兩個成員變數的Annotation
    //Annotaion中的成員變數以方法的形式來定義
    String apple();
    Integer pear();
}

//使用帶成員變數的Annotation
public class beautifulClass2 {
    //需要為成員變數賦值
    @HelloAnno(apple="apple", pear=101)
    public void toPlus() {...}
}

當然，帶成員變數的Annotation也可以為期指定初始值（預設值），在哪在使用註解的時候就不需要再次未改成員變數賦值了；當然，如果需要的話也可以再次賦值，則新值會覆蓋預設值！如下：

public @interface BlackAnno {
    //定義帶兩個成員變數的Annotation
    //Annotaion中的成員變數以方法的形式來定義
    //指定成員變數的預設值，使用default關鍵字
    String apple() default "black";
    Integer pear() default 101;
}

//使用帶成員變數的Annotation
public class beautifulClass3 {
    //@HelloAnno已經指定了預設值
    //則使用時不需要賦值，直接使用即可
    @HelloAnno
    public void toPlus1() {...}
    
    //如果需要，也可以為成員變數賦值，則會覆蓋預設值
    @HelloAnno(apple="apple", pear=101)
    public void toPlus2() {...}
}

## 提取Annotation

使用Annotation修飾了類以及成員方法後，這些Annotation不會自己生效，必須有開發者提供相應的工具來提取並處理Annotation資訊。

java.lang.reflect包下包含一些實現反射功能的工具類：比如定義Annotation時使用@Rentation(RetentionPolicy.RUNTIME)修飾，則Annotation會被編譯器儲存在*.class檔案中，Java在執行時會通過反射讀取類檔案中的Annotation！

AnnotatedElement介面是所有程式元素（Class,Method,Constructor等）的父介面，所以獲得某個AnnotationElement物件後，就可以呼叫該物件的如下方法來訪問Annotation註解資訊：

• <T extends Annotation> T getAnnotation(Class<T> annotationClass)
• Annotation[] getAnnotations()
• default <T extends Annotation> T[] getAnnotationsByType(Class<T> annotationClass)
• default <T extends Annotation> T getDeclaredAnnotation(Class<T> annotationClass)
• Annotation[] getDeclaredAnnotations()
• default <T extends Annotation> T[] getDeclaredAnnotationsByType(Class<T> annotationClass)
• default boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)

## 自定義註解demo

自定義一個Java註解 @CustomAnno，程式碼如下：

/**
 * 自定義一個 Java 註解
 *  1. @Retention(RetentionPolicy.RUNTIME)
 *      執行時讀取並處理註解資訊
 *  2. @Target(ElementType.METHOD)
 *      自定義註解只能修飾方法
 *
 * Created by wondertwo on 2016/10/16.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface CustomAnno {}

用以上自定義的註解，來修飾Person類的八個方法，程式碼如下：

/**
 * Created by wondertwo on 2016/10/16.
 */
public class Person {
    /**
     * 使用自定義註解 @CustomAnno 修飾以下 8個方法
     */
    @CustomAnno
    public static void method_1() {}
    @CustomAnno
    public static void method_2() {}
    @CustomAnno
    public static void method_3() {}
    @CustomAnno
    public static void method_4() {}
    @CustomAnno
    public static void method_5() {}
    @CustomAnno
    public static void method_6() {}
    @CustomAnno
    public static void method_7() {}
    @CustomAnno
    public static void method_8() {}
}

測試註解，通過反射呼叫方法，程式碼如下：

/**
 * Created by wondertwo on 2016/10/16.
 */
public class AnnoTest {
    public static void main(String[] args) throws ClassNotFoundException {
        process("me.wondertwo.annotation.Person"); //Person
    }
    private static void process(String clazz) throws ClassNotFoundException {
        int passed= 0 , failed = 0;
        //遍歷clazz對應類的所有方法
        for (Method method : Class.forName(clazz).getMethods()) {
            //如果該方法使用了自定義註解 @CustomAnno 修飾
            if (method.isAnnotationPresent(CustomAnno.class)) {
                try {
                    method.invoke(null);
                    passed++;
                } catch (Exception e) {
                    e.printStackTrace();
                    System.out.println("方法 " + method + " 測試失敗，出現異常");
                    failed++;
                }
            }
        }
        System.out.println("一共運行了 " + (passed+failed) + " 個方法");
        System.out.println("成功執行方法 " + passed + " 個");
        System.out.println("失敗執行方法 " + failed + " 個");
    }
}
/**
 * 執行結果輸出如下：
 * 一共運行了 8 個方法
 * 成功執行方法 8 個
 * 失敗執行方法 0 個
 * Process finished with exit code 0
 */

我們的自定義註解，成功的被提取出來並執行了！