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

運行上面程序將輸出：

1 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)2 Method with revision no 1 = public java.lang.String com.journaldev.annotations.AnnotationExample.toString()3 Annotation in Method 'public static void com.journaldev.annotations.AnnotationExample.oldMethod()' : @java.lang.Deprecated()4 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)5 Method with revision no 1 = public static void com.journaldev.annotations.AnnotationExample.oldMethod()6 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)

這就是該教程的所有內容，但願你能夠從中學到些東西。