Java自定義Annotation,通過反射解析Annotation

建立一個自定義的Annotation

import java.lang.annotation.*;
import java.lang.reflect.Method;

@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MethodInfo {
    String author() default "hupeng";
    String version() default "1.0";
    String date();
    String comment();

}

• Annotation methods can’t have parameters.
• Annotation methods return types are limited to primitives, String, Enums, Annotation or array of these.
• Annotation methods can have default values.

@Target：

@Target說明了Annotation所修飾的物件範圍：Annotation可被用於 packages、types（類、介面、列舉、Annotation型別）、型別成員（方法、構造方法、成員變數、列舉值）、方法引數和本地變數（如迴圈變數、catch引數）。在Annotation型別的宣告中使用了target可更加明晰其修飾的目標。

作用：用於描述註解的使用範圍（即：被描述的註解可以用在什麼地方）

取值(ElementType)有：

1.CONSTRUCTOR:用於描述構造器
2.FIELD:用於描述域
3.LOCAL_VARIABLE:用於描述區域性變數
4.METHOD:用於描述方法
5.PACKAGE:用於描述包
6.PARAMETER:用於描述引數
7.TYPE:用於描述類、介面(包括註解型別) 或enum宣告

@Retention：

@Retention定義了該Annotation被保留的時間長短：某些Annotation僅出現在原始碼中，而被編譯器丟棄；而另一些卻被編譯在class檔案中；編譯在class檔案中的Annotation可能會被虛擬機器忽略，而另一些在class被裝載時將被讀取（請注意並不影響class的執行，因為Annotation與class在使用上是被分離的）。使用這個meta-Annotation可以對 Annotation的“生命週期”限制。

作用：表示需要在什麼級別儲存該註釋資訊，用於描述註解的生命週期（即：被描述的註解在什麼範圍內有效）

取值（RetentionPoicy）有：

1.SOURCE:在原始檔中有效（即原始檔保留）
2.CLASS:在class檔案中有效（即class保留）
3.RUNTIME:在執行時有效（即執行時保留）

@Documented:

@Documented用於描述其它型別的annotation應該被作為被標註的程式成員的公共API，因此可以被例如javadoc此類的工具文件化。Documented是一個標記註解，沒有成員。

@Inherited：

@Inherited 元註解是一個標記註解，@Inherited闡述了某個被標註的型別是被繼承的。，則這個annotation將被用於該class的子類。

注意：@Inherited annotation型別是被標註過的class的子類所繼承。類並不從它所實現的介面繼承annotation，方法並不從它所過載的方法繼承annotation。

Java 內建的Annotation

從java5版本開始，自帶了三種標準annontation型別,

• Override，java.lang.Override 是一個marker annotation型別，它被用作標註方法。它說明了被標註的方法過載了父類的方法，起到了斷言的作用。如果我們使用了這種annotation在一個沒有覆蓋父類方法的方法時，java編譯器將以一個編譯錯誤來警示。這個annotaton常常在我們試圖覆蓋父類方法而確又寫錯了方法名時加一個保障性的校驗過程。
• Deprecated，Deprecated也是一種marker annotation。，編譯器將不鼓勵使用這個被標註的程式元素。所以使用這種修飾具有一定的 “延續性”：如果我們在程式碼中通過繼承或者覆蓋的方式使用了這個過時的型別或者成員，雖然繼承或者覆蓋後的型別或者成員並不是被宣告為 @Deprecated，但編譯器仍然要報警。注意：@Deprecated這個annotation型別和javadoc中的 @deprecated這個tag是有區別的：前者是java編譯器識別的，而後者是被javadoc工具所識別用來生成文件（包含程式成員為什麼已經過時、它應當如何被禁止或者替代的描述）。
• SuppressWarnings，此註解能告訴Java編譯器關閉對類、方法及成員變數的警告。有時編譯時會提出一些警告，對於這些警告有的隱藏著Bug，有的是無法避免的，對於某些不想看到的警告資訊，可以通過這個註解來遮蔽。SuppressWarning不是一個marker annotation。它有一個型別為String[]的成員，這個成員的值為被禁止的警告名。對於javac編譯器來講，，同時編譯器忽略掉無法識別的警告名。

下面我們來使用Java內建的Annotation 和 自定義的Annotation

public class AnnotationExample {
    @Override
    @MethodInfo(author = "xxx",version = "1.0",date = "2015/03/26",comment = "override toString()")
    public String toString() {
        return "AnnotationExample{}";
    }

    @Deprecated
    @MethodInfo(comment = "deprecated method", date = "2015/03/26")
    public static void oldMethod() {
        System.out.println("old method, don't use it.");
    }

    @SuppressWarnings({ "unchecked", "deprecation" })
    @MethodInfo(author = "Pankaj", comment = "Main method", date = "Nov 17 2012", version = "1.0")
    public static void genericsTest() {
        oldMethod();
    }
}

使用反射來解析Annotation

注意我們的Annotation的Retention Policy 必須是RUNTIME，否則我們無法在執行時從他裡面獲得任何資料。

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

/**
 * Created by Administrator on 2015/3/26.
 */
public class AnnotationParsing {

    public static void main(String[] args) {
        for (Method method: AnnotationExample.class.getMethods()) {
            if (method.isAnnotationPresent(MethodInfo.class)) {
                for (Annotation annotation:method.getAnnotations()) {
                    System.out.println(annotation + " in method:"+ method);
                }

                MethodInfo methodInfo = method.getAnnotation(MethodInfo.class);

                if ("1.0".equals(methodInfo.version())) {
                    System.out.println("Method with revision no 1.0 = "
                            + method);
                }
            }
        }
    }
}