Java註解教學及自訂註解

Java註解提供了關於程式碼的一些信息，但並不直接作用於它所註解的程式碼內容。在這個教程當中，我們將學習Java的註解，如何自訂註解，註解的使用以及如何透過反射解析註解。

Java1.5引入了註解，目前許多java框架中大量使用註解，如Hibernate、Jersey、Spring。註解作為程式的元資料嵌入到程式當中。註解可以被一些解析工具或是編譯工具來解析。我們也可以聲明註解在編譯過程或執行時產生作用。

在使用註解之前，程式來源資料只是透過java註解和javadoc，但是註解提供的功能要遠遠超過這些。註解不僅包含了元數據，它還可以作用於程式運作過程中、註解解釋器可以透過註解解定程式的執行順序。例如，在Jersey webservice 我們為方法添加URI字串的形式的**PATH**註解，那麼在程式運行過程中jerser解釋程序將決定該方法去呼叫所給的URI。

建立Java自訂註解

建立自訂註解和建立一個介面相似，但是註解的interface關鍵字需要以@符號開頭。我們可以為註解聲明方法。我們先來看看註解的例子，然後我們將討論他的一些特性。

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();
}

• 註解方法不能帶有參數；

• 註解方法回傳值類型限定為：基本型別、String、Enums、Annotation或是這些型別的註解方法

；
註解本身能夠包含元註解，元註解被用來註解其它註解。

這裡有四種類型的元註解：

1. @Documented —— 指明擁有這個註解的元素可以被javadoc此類的工具文檔化。這種類型應該用於註解那些影響客戶使用帶註釋的元素聲明的類型。如果一種聲明使用Documented進行註解，這種類型的註解被作為被標註的程式成員的公共API。

2. @Target－指明該類型的註解可以註解的程式元素的範圍。此元註解的取值可以為TYPE,METHOD,CONSTRUCTOR,FIELD等。如果Target元註解沒有出現，那麼定義的註解可以應用於程式的任何元素。

3. @Inherited－指明該註解類型被自動繼承。如果使用者在目前類別中查詢這個元註解類型且目前類別的聲明中不包含這個元註解類型，那麼也將自動查詢目前類別的父類別是否存在Inherited元註解，這個動作將被重複執行知道這個標註類型被找到，或是查詢到頂層的父類別。

4.@Retention－指明了該Annotation被保留的時間長短。 RetentionPolicy值為SOURCE,CLASS,RUNTIME。

Java內建註解

Java提供了三種內建註解。

1. @Override——當我們想要複寫父類別中的方法時，我們需要使用該註解去告知編譯器我們想要複寫這個方法。這樣一來當父類別中的方法移除或發生變更時編譯器將提示錯誤訊息。

2. @Deprecated－當我們希望編譯器知道某一方法不建議使用時，我們應該使用這個註解。 Java在javadoc 中建議使用該註解，我們應該提供為什麼該方法不建議使用以及替代的方法。

3. @SuppressWarnings－這個僅僅是告訴編譯器忽略特定的警告訊息，例如在泛型中使用原生資料型別。它的保留策略是SOURCE（譯者註：在原始檔中有效）並且被編譯器丟棄。

我們來看一個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();
}

}

相信這個例子可以不言自明並能展示在不同場景下的應用。

Java註解解析

我們將使用反射技術來解析java類別的註解。那麼註解的RetentionPolicy應該設定為RUNTIME否則java類別的註解資訊在執行過程中將不可用那麼我們也不能從中得到任何和註解有關的資料。

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)

這就是教學的全部內容，希望你可以從中學到些東西。

以上就是Java註解教學及自訂註解的內容，更多相關內容請關注PHP中文網（www.php.cn）！

🎜🎜