Java註解教程：自定義註解示例，利用反射進行解析

Java註解可以提供代碼的相關信息，同時對於所註解的代碼結構又沒有直接影響。在這篇教程中，咱們將學習Java註解，如何編寫自定義註解，註解的使用，以及如何使用反射解析註解。

註解是Java 1.5引入的，目前已被普遍應用於各類Java框架，如Hibernate，Jersey，Spring。註解至關因而一種嵌入在程序中的元數據，可使用註解解析工具或編譯器對其進行解析，也能夠指定註解在編譯期或運行期有效。

在註解誕生以前，程序的元數據存在的形式僅限於java註釋或javadoc，但註解能夠提供更多功能，它不只包含元數據，還能做用於運行期，註解解析器可以使用註解決定處理流程。舉個例子，在Jersey webservice中，咱們在一個方法上添加了PATH註解和URI字符串，在運行期，jersey會對其進行解析，並決定做用於指定URI模式的方法。

在Java中建立自定義註解

建立自定義註解與編寫接口很類似，除了它的接口關鍵字前有個@符號。咱們能夠在註解中定義方法，先來看個例子，以後咱們會繼續討論它的特性。

@Documented
@Target(ElementType.METHOD)
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MethodInfo {
    String author() default "Pankaj";
    String date();
    int revision() default 1;
    String comments();
}

• 註解方法不能有參數。
• 註解方法的返回類型侷限於原始類型，字符串，枚舉，註解，或以上類型構成的數組。
• 註解方法能夠包含默認值。
• 註解能夠包含與其綁定的元註解，元註解爲註解提供信息，有四種元註解類型：

1. @Documented – 表示使用該註解的元素應被javadoc或相似工具文檔化，它應用於類型聲明，類型聲明的註解會影響客戶端對註解元素的使用。若是一個類型聲明添加了Documented註解，那麼它的註解會成爲被註解元素的公共API的一部分。

2. @Target – 表示支持註解的程序元素的種類，一些可能的值有TYPE, METHOD, CONSTRUCTOR, FIELD等等。若是Target元註解不存在，那麼該註解就可使用在任何程序元素之上。

3. @Inherited – 表示一個註解類型會被自動繼承，若是用戶在類聲明的時候查詢註解類型，同時類聲明中也沒有這個類型的註解，那麼註解類型會自動查詢該類的父類，這個過程將會不停地重複，直到該類型的註解被找到爲止，或是到達類結構的頂層（Object）。

4. @Retention – 表示註解類型保留時間的長短，它接收RetentionPolicy參數，可能的值有SOURCE, CLASS, 以及RUNTIME。

Java內置註解

Java提供3種內置註解。

1. @Override – 當咱們想要覆蓋父類的一個方法時，須要使用該註解告知編譯器咱們正在覆蓋一個方法。這樣的話，當父類的方法被刪除或修改了，編譯器會提示錯誤信息。你們能夠學習一下爲何咱們老是應該在覆蓋方法時使用Java覆蓋註解。

2. @Deprecated – 當咱們想要讓編譯器知道一個方法已經被棄用(deprecate)時，應該使用這個註解。Java推薦在javadoc中提供信息，告知用戶爲何這個方法被棄用了，以及替代方法是什麼。

3. @SuppressWarnings – 這個註解僅僅是告知編譯器，忽略它們產生了特殊警告，好比：在java泛型中使用原始類型。它的保持性策略(retention policy)是SOURCE，在編譯器中將被丟棄。

咱們來看一個例子，展現瞭如何使用內置註解，以及上述示例中說起的自定義註解。

public class AnnotationExample {
    public static void main(String[] args) {

    }
    @Override
    @MethodInfo(author = "Pankaj", comments = "Main method", date = "Nov 17 2012", revision = 1)
    public String toString() {
        return super.toString();
    }

    @Deprecated
    @MethodInfo(comments = "deprecated method", date = "Nov 17 2012")
    public static void oldMethod() {
        System.out.println("old method, don't use it.");
    }

    @SuppressWarnings({ "unchecked", "deprecation" })
    @MethodInfo(author = "Pankaj", comments = "Main method", date = "Nov 17 2012", revision = 10)
    public static void genericsTest() throws FileNotFoundException {
        List l = new ArrayList();
        l.add("abc");
        oldMethod();
    }
}

我相信這個例子是很明瞭的，展現了不一樣場景下註解的使用方式。

Java註解解析

咱們將使用Java反射機制從一個類中解析註解，請記住，註解保持性策略應該是RUNTIME，不然它的信息在運行期無效，咱們也不能從中獲取任何數據。

public class AnnotationParsing {

    public static void main(String[] args) {
        try{
            for (Method method : AnnotationParsing.class.getClassLoader().loadClass("net.itaem.annnodemo.anno.AnnotationExample").getMethods()) {
                if(method.isAnnotationPresent(net.itaem.annnodemo.anno.MethodInfo.class)){
                    try{
                        for (Annotation annotation : method.getDeclaredAnnotations()) {
                            System.out.println("Annotation in Method '"
                                    + method + "' : " + annotation);
                        }
                        MethodInfo methodAnno  = method.getAnnotation(MethodInfo.class);
                        if(methodAnno.revision() == 1){
                            System.out.println("Method with revision no 1 = " + method);
                        }
                    }catch (Exception e){
                        e.printStackTrace();
                    }
                }
            }
        }catch (Exception e){
            e.printStackTrace();
        }
    }
}

 以上程序的輸出是：

Annotation in Method 'public java.lang.String net.itaem.annnodemo.anno.AnnotationExample.toString()' : @net.itaem.annnodemo.anno.MethodInfo(author=Pankaj, revision=1, comments=Main method, date=Nov 17 2012)
Method with revision no 1 = public java.lang.String net.itaem.annnodemo.anno.AnnotationExample.toString()
Annotation in Method 'public static void net.itaem.annnodemo.anno.AnnotationExample.oldMethod()' : @java.lang.Deprecated()
Annotation in Method 'public static void net.itaem.annnodemo.anno.AnnotationExample.oldMethod()' : @net.itaem.annnodemo.anno.MethodInfo(author=Pankaj, revision=1, comments=deprecated method, date=Nov 17 2012)
Method with revision no 1 = public static void net.itaem.annnodemo.anno.AnnotationExample.oldMethod()
Annotation in Method 'public static void net.itaem.annnodemo.anno.AnnotationExample.genericsTest() throws java.io.FileNotFoundException' : @net.itaem.annnodemo.anno.MethodInfo(author=Pankaj, revision=10, comments=Main method, date=Nov 17 2012)