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

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

       在註解誕生之前，程式的元資料存在的形式僅限於java註釋或javadoc，但註解可以提供更多功能，它不僅包含元資料，還能作用於執行期，註解解析器能夠使用註解決定處理流程。舉個例子，在

在Java中建立自定義註解

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

package cn.timebusker.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 "timebusker";
    String date();
    int revision() default 1;
    String comments();
}
 

• 註解方法不能有引數。
• 註解方法的返回型別侷限於原始型別，字串，列舉，註解，或以上型別構成的陣列。
• 註解方法可以包含預設值。
• 註解可以包含與其繫結的元註解，元註解為註解提供資訊，有四種元註解型別：

       @Documented – 表示使用該註解的元素應被javadoc或類似工具文件化，它應用於型別宣告，型別宣告的註解會影響客戶端對註解元素的使用。如果一個型別宣告添加了Documented註解，那麼它的註解會成為被註解元素的公共API的一部分。

       @Target – 表示支援註解的程式元素的種類，一些可能的值有TYPE, METHOD, CONSTRUCTOR, FIELD等等。如果Target元註解不存在，那麼該註解就可以使用在任何程式元素之上。

      @Inherited – 表示一個註解型別會被自動繼承，如果使用者在類宣告的時候查詢註解型別，同時類宣告中也沒有這個型別的註解，那麼註解型別會自動查詢該類的父類，這個過程將會不停地重複，直到該型別的註解被找到為止，或是到達類結構的頂層（Object）。

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

Java內建註解

       @Override – 當我們想要覆蓋父類的一個方法時，需要使用該註解告知編譯器我們正在覆蓋一個方法。這樣的話，當父類的方法被刪除或修改了，編譯器會提示錯誤資訊。大家可以學習一下為什麼我們總是應該在覆蓋方法時使用Java覆蓋註解。

       @Deprecated – 當我們想要讓編譯器知道一個方法已經被棄用(deprecate)時，應該使用這個註解。Java推薦在javadoc中提供資訊，告知使用者為什麼這個方法被棄用了，以及替代方法是什麼。

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

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

package com.timebusker.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反射機制從一個類中解析註解，請記住，註解保持性策略應該是RUNTIME，否則它的資訊在執行期無效，我們也不能從中獲取任何資料。

package com.timebusker.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.timebusker.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();  
        }  
    }  
   
}