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

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

注解是Java 1.5引入的，目前已被廣泛應用於各種Java框架，如Hibernate，Jersey，Spring。注解相當於是一種嵌入在程序中的元數據，可以使用注解解析工具或編譯器對其進行解析，也可以指定注解在編譯期或運行期有效。

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

在Java中創建自定義注解

創建自定義注解與編寫接口很相似，除了它的接口關鍵字前有個@符號。我們可以在注解中定義方法，先來看個例子，之后我們會繼續討論它的特性。

package com.journaldev.annotations;
 
import java.io.FileNotFoundException;
import java.util.ArrayList;
import java.util.List;
 
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 "Overriden toString method";
    }
 
    @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();
    }
 
}

 

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

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，在編譯器中將被丟棄。

我們來看一個例子，展示了如何使用內置注解，以及上述示例中提及的自定義注解。

package com.journaldev.annotations;
 
import java.io.FileNotFoundException;
import java.util.ArrayList;
import java.util.List;
 
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 "Overriden toString method";
    }
 
    @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，否則它的信息在運行期無效，我們也不能從中獲取任何數據。

 

package com.journaldev.annotations;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
 
public class AnnotationParsing {
 
    public static void main(String[] args) {
        try {
            for (Method method : AnnotationParsing.class
                    .getClassLoader()
                    .loadClass(("com.journaldev.annotations.AnnotationExample"))
                    .getMethods()) {
                // checks if MethodInfo annotation is present for the method
                if (method
                        .isAnnotationPresent(com.journaldev.annotations.MethodInfo.class)) {
                    try {
                        // iterates all the annotations available in the method
                        for (Annotation anno : method.getDeclaredAnnotations()) {
                            System.out.println("Annotation in Method '"
                                    + method + "' : " + anno);
                        }
                        MethodInfo methodAnno = method
                                .getAnnotation(MethodInfo.class);
                        if (methodAnno.revision() == 1) {
                            System.out.println("Method with revision no 1 = "
                                    + method);
                        }
 
                    } catch (Throwable ex) {
                        ex.printStackTrace();
                    }
                }
            }
        } catch (SecurityException | ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
 
}

 

以上程序的輸出是：

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

 

注解API非常強大，被廣泛應用於各種Java框架，如Spring，Hibernate，JUnit。可以查看《Java中的反射》獲得更多信息。

這就是java注解教程的全部內容了，我希望你能從中學到一些東西。