Java自訂註解的定義與使用

標籤：tty   get   journal   reflect   ann   地址   throw   complete   www   

跟蹤代碼的依賴性，實現代替設定檔的功能。比較常見的是Spring等架構中的基於註解配置。

登陸、許可權攔截、Tlog，以及各種Java架構，如Spring，Hibernate，JUnit 。提到註解就不能不說反射，Java自訂註解是通過運行時靠反射擷取註解。實際開發中，例如我們要擷取某個方法的調用日誌，可以通過AOP（動態代理機制）給方法添加切面，通過反射來擷取方法包含的註解，如果包含日誌註解，就進行日誌記錄。

 

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

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

 

在Java中建立自訂註解

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

package com.journaldev.annotations; import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Inherited;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target; @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，在編譯器中將被丟棄。

我們來看一個例子，展示了如何使用內建註解，以及上述樣本中提及的自訂註解。

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中的反射》獲得更多資訊。

 

轉載地址：http://www.importnew.com/14479.html

Java自訂註解的定義與使用