Java基礎 Annotation使用

時間 2019-12-20

標籤 java 基礎 annotation 使用欄目 Java 简体版

原文原文鏈接

Java基礎之理解Annotation

1、概念html

　　 Annontation是Java5開始引入的新特徵。中文名稱通常叫註解。它提供了一種安全的相似註釋的機制，用來將任何的信息或元數據（metadata）與程序元素（類、方法、成員變量等）進行關聯。java

　　更通俗的意思是爲程序的元素（類、方法、成員變量）加上更直觀更明瞭的說明，這些說明信息是與程序的業務邏輯無關，而且是供指定的工具或框架使用的。android

Annontation像一種修飾符同樣，應用於包、類型、構造方法、方法、成員變量、參數及本地變量的聲明語句中。git

2、原理程序員

　　Annotation實際上是一種接口。經過Java的反射機制相關的API來訪問annotation信息。相關類（框架或工具中的類）根據這些信息來決定如何使用該程序元素或改變它們的行爲。github

　　annotation是不會影響程序代碼的執行，不管annotation怎麼變化，代碼都始終如一地執行。編程

　　Java語言解釋器在工做時會忽略這些annotation，所以在JVM 中這些annotation是「不起做用」的，只能經過配套的工具才能對這些annontaion類型的信息進行訪問和處理。api

　　Annotation與interface的異同：數組

　　　　1）、Annotation類型使用關鍵字@interface而不是interface。安全

　　這個關鍵字聲明隱含了一個信息：它是繼承了java.lang.annotation.Annotation接口，並不是聲明瞭一個interface

　　　　2）、Annotation類型、方法定義是獨特的、受限制的。

　　Annotation 類型的方法必須聲明爲無參數、無異常拋出的。這些方法定義了annotation的成員：方法名成爲了成員名，而方法返回值成爲了成員的類型。而方法返回值類型必須爲primitive類型、Class類型、枚舉類型、annotation類型或者由前面類型之一做爲元素的一維數組。方法的後面可使用 default和一個默認數值來聲明成員的默認值，null不能做爲成員默認值，這與咱們在非annotation類型中定義方法有很大不一樣。

　　Annotation類型和它的方法不能使用annotation類型的參數、成員不能是generic。只有返回值類型是Class的方法能夠在annotation類型中使用generic，由於此方法可以用類轉換將各類類型轉換爲Class。

　　　　3）、Annotation類型又與接口有着近似之處。

　　它們能夠定義常量、靜態成員類型（好比枚舉類型定義）。Annotation類型也能夠如接口通常被實現或者繼承。

3、應用場合

　　annotation通常做爲一種輔助途徑，應用在軟件框架或工具中，在這些工具類中根據不一樣的 annontation註解信息採起不一樣的處理過程或改變相應程序元素（類、方法及成員變量等）的行爲。

　　例如：Junit、Struts、Spring等流行工具框架中均普遍使用了annontion。使代碼的靈活性大提升。

4、常見標準的Annotation

　　從java5版本開始，自帶了三種標準annontation類型,

　　　　（1）、Override

　　java.lang.Override 是一個marker annotation類型，它被用做標註方法。它說明了被標註的方法重載了父類的方法，起到了斷言的做用。若是咱們使用了這種annotation在一個沒有覆蓋父類方法的方法時，java編譯器將以一個編譯錯誤來警示。

　　這個annotaton經常在咱們試圖覆蓋父類方法而確又寫錯了方法名時加一個保障性的校驗過程。

　　　　（2）、Deprecated

　　Deprecated也是一種marker annotation。當一個類型或者類型成員使用@Deprecated修飾的話，編譯器將不鼓勵使用這個被標註的程序元素。因此使用這種修飾具備必定的「延續性」：若是咱們在代碼中經過繼承或者覆蓋的方式使用了這個過期的類型或者成員，雖然繼承或者覆蓋後的類型或者成員並非被聲明爲 @Deprecated，但編譯器仍然要報警。

　　注意：@Deprecated這個annotation類型和javadoc中的 @deprecated這個tag是有區別的：前者是java編譯器識別的，然後者是被javadoc工具所識別用來生成文檔（包含程序成員爲何已通過時、它應當如何被禁止或者替代的描述）。

　　　　（3）、SuppressWarnings

　　此註解能告訴Java編譯器關閉對類、方法及成員變量的警告。

　　有時編譯時會提出一些警告，對於這些警告有的隱藏着Bug，有的是沒法避免的，對於某些不想看到的警告信息，能夠經過這個註解來屏蔽。

　　SuppressWarning不是一個marker annotation。它有一個類型爲String[]的成員，這個成員的值爲被禁止的警告名。對於javac編譯器來說，被-Xlint選項有效的警告名也一樣對@SuppressWarings有效，同時編譯器忽略掉沒法識別的警告名。

　　annotation語法容許在annotation名後跟括號，括號中是使用逗號分割的name=value對用於爲annotation的成員賦值：

代碼：

@SuppressWarnings(value={"unchecked","fallthrough"})

public void lintTrap() { /* sloppy method body omitted */ }

在這個例子中SuppressWarnings annotation類型只定義了一個單一的成員，因此只有一個簡單的value={...}做爲name=value對。又因爲成員值是一個數組，故使用大括號來聲明數組值。

注意：咱們能夠在下面的狀況中縮寫annotation：當annotation只有單一成員，併成員命名爲"value="。這時能夠省去"value="。好比將上面的SuppressWarnings annotation進行縮寫：

代碼：

@SuppressWarnings({"unchecked","fallthrough"})

若是SuppressWarnings所聲明的被禁止警告個數爲一個時，能夠省去大括號：

@SuppressWarnings("unchecked")

5、自定義annontation示例

示例共涉及四個類：

　　清單1:Author.java

package com.magc.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

    /**
     * 定義做者信息，name和group
     * @author magc
     *
     */
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    @Documented
public @interface Author {

        String name();
        String group();
}

　　清單2:Description.java

/**
 * 
 */
package com.magc.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author magc
 *
 * 定義描述信息 value
 */
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @Documented
    
public @interface Description {
        String value();
}

清單3:Utility.java

package com.magc.annotation;

    @Description(value = "這是一個有用的工具類")
public class Utility {

        @Author(name = "haoran_202",group="com.magc")
        public String work()
        {
            return "work over!";
        }
        
        
    
}

注：這是個普通的Java類，運行了@Description和@Author註解。

清單3:AnalysisAnnotation.java

package com.magc.annotation;

import java.lang.reflect.Method;

public class AnalysisAnnotation {
    /**
     * 在運行時分析處理annotation類型的信息
     * 
     * 
     */
    public static void main(String[] args) {
        try {
                //經過運行時反射API得到annotation信息
                Class rt_class = Class.forName("com.magc.annotation.Utility");
                Method[] methods = rt_class.getMethods();
                
                boolean flag = rt_class.isAnnotationPresent(Description.class);
                
                if(flag)
                {
                    Description description = (Description)rt_class.getAnnotation(Description.class);
                    System.out.println("Utility's Description--->"+description.value());
                    for (Method method : methods) {
                        if(method.isAnnotationPresent(Author.class))
                        {
                            Author author = (Author)method.getAnnotation(Author.class);
                            System.out.println("Utility's Author--->"+author.name()+" from "+author.group());
                            
                        }
                    }
                }
            
            
            } catch (ClassNotFoundException e) {
                e.printStackTrace();
            }
    }

}

注：這是個與自定義@Description和@Author配套的基礎框架或工具類，經過此類來得到與普通Java類Utility.java關聯的信息,即描述和做者。

運行AnalysisAnnotation,輸出結果爲：

Utility's Description--->這是一個有用的工具類
Utility's Author--->haoran_202 from com.magc

註解語法

由於日常開發少見，相信有很多的人員會認爲註解的地位不高。其實同 classs 和 interface 同樣，註解也屬於一種類型。它是在 Java SE 5.0 版本中開始引入的概念。

註解的定義

註解經過 @interface 關鍵字進行定義。

public @interface TestAnnotation {
}

它的形式跟接口很相似，不過前面多了一個 @ 符號。上面的代碼就建立了一個名字爲 TestAnnotaion 的註解。

你能夠簡單理解爲建立了一張名字爲 TestAnnotation 的標籤。

註解的應用

上面建立了一個註解，那麼註解的的使用方法是什麼呢。

@TestAnnotation
public class Test {
}

建立一個類 Test,而後在類定義的地方加上 @TestAnnotation 就能夠用 TestAnnotation 註解這個類了。

你能夠簡單理解爲將 TestAnnotation 這張標籤貼到 Test 這個類上面。

不過，要想註解可以正常工做，還須要介紹一下一個新的概念那就是元註解。

元註解

元註解是什麼意思呢？

元註解是能夠註解到註解上的註解，或者說元註解是一種基本註解，可是它可以應用到其它的註解上面。

若是難於理解的話，你能夠這樣理解。元註解也是一張標籤，可是它是一張特殊的標籤，它的做用和目的就是給其餘普通的標籤進行解釋說明的。

元標籤有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 種。

@Retention

Retention 的英文意爲保留期的意思。當 @Retention 應用到一個註解上的時候，它解釋說明了這個註解的的存活時間。

它的取值以下：
- RetentionPolicy.SOURCE 註解只在源碼階段保留，在編譯器進行編譯時它將被丟棄忽視。
- RetentionPolicy.CLASS 註解只被保留到編譯進行的時候，它並不會被加載到 JVM 中。
- RetentionPolicy.RUNTIME 註解能夠保留到程序運行的時候，它會被加載進入到 JVM 中，因此在程序運行時能夠獲取到它們。

咱們能夠這樣的方式來加深理解，@Retention 去給一張標籤解釋的時候，它指定了這張標籤張貼的時間。@Retention 至關於給一張標籤上面蓋了一張時間戳，時間戳指明瞭標籤張貼的時間週期。

@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}

上面的代碼中，咱們指定 TestAnnotation 能夠在程序運行週期被獲取到，所以它的生命週期很是的長。

@Documented

顧名思義，這個元註解確定是和文檔有關。它的做用是可以將註解中的元素包含到 Javadoc 中去。

@Target

Target 是目標的意思，@Target 指定了註解運用的地方。

你能夠這樣理解，當一個註解被 @Target 註解時，這個註解就被限定了運用的場景。

類比到標籤，本來標籤是你想張貼到哪一個地方就到哪一個地方，可是由於 @Target 的存在，它張貼的地方就很是具體了，好比只能張貼到方法上、類上、方法參數上等等。@Target 有下面的取值

ElementType.ANNOTATION_TYPE 能夠給一個註解進行註解
ElementType.CONSTRUCTOR 能夠給構造方法進行註解
ElementType.FIELD 能夠給屬性進行註解
ElementType.LOCAL_VARIABLE 能夠給局部變量進行註解
ElementType.METHOD 能夠給方法進行註解
ElementType.PACKAGE 能夠給一個包進行註解
ElementType.PARAMETER 能夠給一個方法內的參數進行註解
ElementType.TYPE 能夠給一個類型進行註解，好比類、接口、枚舉

@Inherited

Inherited 是繼承的意思，可是它並非說註解自己能夠繼承，而是說若是一個超類被 @Inherited 註解過的註解進行註解的話，那麼若是它的子類沒有被任何註解應用的話，那麼這個子類就繼承了超類的註解。
說的比較抽象。代碼來解釋。

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}


@Test
public class A {}


public class B extends A {}

註解 Test 被 @Inherited 修飾，以後類 A 被 Test 註解，類 B 繼承 A,類 B 也擁有 Test 這個註解。

能夠這樣理解：

老子很是有錢，因此人們給他貼了一張標籤叫作富豪。

老子的兒子長大後，只要沒有和老子斷絕父子關係，雖然別人沒有給他貼標籤，可是他天然也是富豪。

老子的孫子長大了，天然也是富豪。

這就是人們口中戲稱的富一代，富二代，富三代。雖然叫法不一樣，好像好多個標籤，但其實事情的本質也就是他們有一張共同的標籤，也就是老子身上的那張富豪的標籤。

@Repeatable

Repeatable 天然是可重複的意思。@Repeatable 是 Java 1.8 才加進來的，因此算是一個新的特性。

什麼樣的註解會屢次應用呢？一般是註解的值能夠同時取多個。

舉個例子，一我的他既是程序員又是產品經理,同時他仍是個畫家。

@interface Persons {
    Person[]  value();
}


@Repeatable(Persons.class)
@interface Person{
    String role default "";
}


@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{

}

注意上面的代碼，@Repeatable 註解了 Person。而 @Repeatable 後面括號中的類至關於一個容器註解。

什麼是容器註解呢？就是用來存放其它註解的地方。它自己也是一個註解。

咱們再看看代碼中的相關容器註解。

@interface Persons {
    Person[]  value();
}

按照規定，它裏面必需要有一個 value 的屬性，屬性類型是一個被 @Repeatable 註解過的註解數組，注意它是數組。

若是很差理解的話，能夠這樣理解。Persons 是一張總的標籤，上面貼滿了 Person 這種同類型但內容不同的標籤。把 Persons 給一個 SuperMan 貼上，至關於同時給他貼了程序員、產品經理、畫家的標籤。

咱們可能對於 @Person(role=」PM」) 括號裏面的內容感興趣，它其實就是給 Person 這個註解的 role 屬性賦值爲 PM ，你們不明白正常，立刻就講到註解的屬性這一塊。

註解的屬性

註解的屬性也叫作成員變量。註解只有成員變量，沒有方法。註解的成員變量在註解的定義中以「無形參的方法」形式來聲明，其方法名定義了該成員變量的名字，其返回值定義了該成員變量的類型。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {

    int id();

    String msg();

}

上面代碼定義了 TestAnnotation 這個註解中擁有 id 和 msg 兩個屬性。在使用的時候，咱們應該給它們進行賦值。

賦值的方式是在註解的括號內以 value=」」形式，多個屬性以前用，隔開。

@TestAnnotation(id=3,msg="hello annotation")
public class Test {

}

須要注意的是，在註解中定義屬性時它的類型必須是 8 種基本數據類型外加類、接口、註解及它們的數組。

註解中屬性能夠有默認值，默認值須要用 default 關鍵值指定。好比：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {

    public int id() default -1;

    public String msg() default "Hi";

}

TestAnnotation 中 id 屬性默認值爲 -1，msg 屬性默認值爲 Hi。
它能夠這樣應用。

@TestAnnotation()
public class Test {}

由於有默認值，因此無須要再在 @TestAnnotation 後面的括號裏面進行賦值了，這一步能夠省略。

另外，還有一種狀況。若是一個註解內僅僅只有一個名字爲 value 的屬性時，應用這個註解時能夠直接接屬性值填寫到括號內。

public @interface Check {
    String value();
}

上面代碼中，Check 這個註解只有 value 這個屬性。因此能夠這樣應用。

@Check("hi")
int a;

這和下面的效果是同樣的

@Check(value="hi")
int a;

最後，還須要注意的一種狀況是一個註解沒有任何屬性。好比

public @interface Perform {}

那麼在應用這個註解的時候，括號均可以省略。

@Perform
public void testMethod(){}

Java 預置的註解

學習了上面相關的知識，咱們已經能夠本身定義一個註解了。其實 Java 語言自己已經提供了幾個現成的註解。

@Deprecated

這個元素是用來標記過期的元素，想必你們在平常開發中常常碰到。編譯器在編譯階段遇到這個註解時會發出提醒警告，告訴開發者正在調用一個過期的元素好比過期的方法、過期的類、過期的成員變量。

public class Hero {

    @Deprecated
    public void say(){
        System.out.println("Noting has to say!");
    }


    public void speak(){
        System.out.println("I have a dream!");
    }


}

定義了一個 Hero 類，它有兩個方法 say() 和 speak() ，其中 say() 被 @Deprecated 註解。而後咱們在 IDE 中分別調用它們。

能夠看到，say() 方法上面被一條直線劃了一條，這其實就是編譯器識別後的提醒效果。

@Override

這個你們應該很熟悉了，提示子類要複寫父類中被 @Override 修飾的方法

@SuppressWarnings

阻止警告的意思。以前說過調用被 @Deprecated 註解的方法後，編譯器會警告提醒，而有時候開發者會忽略這種警告，他們能夠在調用的地方經過 @SuppressWarnings 達到目的。

@SuppressWarnings("deprecation")
public void test1(){
    Hero hero = new Hero();
    hero.say();
    hero.speak();
}

@SafeVarargs

參數安全類型註解。它的目的是提醒開發者不要用參數作一些不安全的操做,它的存在會阻止編譯器產生 unchecked 這樣的警告。它是在 Java 1.7 的版本中加入的。

@SafeVarargs // Not actually safe!
    static void m(List<String>... stringLists) {
    Object[] array = stringLists;
    List<Integer> tmpList = Arrays.asList(42);
    array[0] = tmpList; // Semantically invalid, but compiles without warnings
    String s = stringLists[0].get(0); // Oh no, ClassCastException at runtime!
}

上面的代碼中，編譯階段不會報錯，可是運行時會拋出 ClassCastException 這個異常，因此它雖然告訴開發者要妥善處理，可是開發者本身仍是搞砸了。

Java 官方文檔說，將來的版本會受權編譯器對這種不安全的操做產生錯誤警告。

@FunctionalInterface

函數式接口註解，這個是 Java 1.8 版本引入的新特性。函數式編程很火，因此 Java 8 也及時添加了這個特性。

函數式接口 (Functional Interface) 就是一個具備一個方法的普通接口。

好比

@FunctionalInterface
public interface Runnable {
    /**
     * When an object implementing interface <code>Runnable</code> is used
     * to create a thread, starting the thread causes the object's
     * <code>run</code> method to be called in that separately executing
     * thread.
     * <p>
     * The general contract of the method <code>run</code> is that it may
     * take any action whatsoever.
     *
     * @see     java.lang.Thread#run()
     */
    public abstract void run();
}

咱們進行線程開發中經常使用的 Runnable 就是一個典型的函數式接口，上面源碼能夠看到它就被 @FunctionalInterface 註解。

可能有人會疑惑，函數式接口標記有什麼用，這個緣由是函數式接口能夠很容易轉換爲 Lambda 表達式。這是另外的主題了，有興趣的同窗請本身搜索相關知識點學習。

註解的提取

博文前面的部分講了註解的基本語法，如今是時候檢測咱們所學的內容了。

我經過用標籤來比做註解，前面的內容是講怎麼寫註解，而後貼到哪一個地方去，而如今咱們要作的工做就是檢閱這些標籤內容。形象的比喻就是你把這些註解標籤在合適的時候撕下來，而後檢閱上面的內容信息。

要想正確檢閱註解，離不開一個手段，那就是反射。

註解與反射。

註解經過反射獲取。首先能夠經過 Class 對象的 isAnnotationPresent() 方法判斷它是否應用了某個註解

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}

而後經過 getAnnotation() 方法來獲取 Annotation 對象。

public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}

或者是 getAnnotations() 方法。

public Annotation[] getAnnotations() {}

前一種方法返回指定類型的註解，後一種方法返回註解到這個元素上的全部註解。

若是獲取到的 Annotation 若是不爲 null，則就能夠調用它們的屬性方法了。好比

@TestAnnotation()
public class Test {

    public static void main(String[] args) {

        boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);

        if ( hasAnnotation ) {
            TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);

            System.out.println("id:"+testAnnotation.id());
            System.out.println("msg:"+testAnnotation.msg());
        }

    }

}

程序的運行結果是：

id:-1
msg:

這個正是 TestAnnotation 中 id 和 msg 的默認值。

上面的例子中，只是檢閱出了註解在類上的註解，其實屬性、方法上的註解照樣是能夠的。一樣仍是要假手於反射。

@TestAnnotation(msg="hello")
public class Test {

    @Check(value="hi")
    int a;


    @Perform
    public void testMethod(){}


    @SuppressWarnings("deprecation")
    public void test1(){
        Hero hero = new Hero();
        hero.say();
        hero.speak();
    }


    public static void main(String[] args) {

        boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);

        if ( hasAnnotation ) {
            TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
            //獲取類的註解
            System.out.println("id:"+testAnnotation.id());
            System.out.println("msg:"+testAnnotation.msg());
        }


        try {
            Field a = Test.class.getDeclaredField("a");
            a.setAccessible(true);
            //獲取一個成員變量上的註解
            Check check = a.getAnnotation(Check.class);

            if ( check != null ) {
                System.out.println("check value:"+check.value());
            }

            Method testMethod = Test.class.getDeclaredMethod("testMethod");

            if ( testMethod != null ) {
                // 獲取方法中的註解
                Annotation[] ans = testMethod.getAnnotations();
                for( int i = 0;i < ans.length;i++) {
                    System.out.println("method testMethod annotation:"+ans[i].annotationType().getSimpleName());
                }
            }
        } catch (NoSuchFieldException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
            System.out.println(e.getMessage());
        } catch (SecurityException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
            System.out.println(e.getMessage());
        } catch (NoSuchMethodException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
            System.out.println(e.getMessage());
        }



    }

}

它們的結果以下：

id:-1
msg:hello
check value:hi
method testMethod annotation:Perform

須要注意的是，若是一個註解要在運行時被成功提取，那麼 @Retention(RetentionPolicy.RUNTIME) 是必須的。

註解的使用場景

我相信博文講到這裏你們都很熟悉了註解，可是有很多同窗確定會問，註解到底有什麼用呢？

對啊註解到底有什麼用？

咱們不妨將目光放到 Java 官方文檔上來。

文章開始的時候，我用標籤來類比註解。但標籤比喻只是個人手段，而不是目的。爲的是讓你們在初次學習註解時可以不被那些抽象的新概念搞懵。既然如今，咱們已經對註解有所瞭解，咱們不妨再仔細閱讀官方最嚴謹的文檔。

註解是一系列元數據，它提供數據用來解釋程序代碼，可是註解並不是是所解釋的代碼自己的一部分。註解對於代碼的運行效果沒有直接影響。

註解有許多用處，主要以下：
- 提供信息給編譯器：編譯器能夠利用註解來探測錯誤和警告信息
- 編譯階段時的處理：軟件工具能夠用來利用註解信息來生成代碼、Html文檔或者作其它相應處理。
- 運行時的處理：某些註解能夠在程序運行的時候接受代碼的提取

值得注意的是，註解不是代碼自己的一部分。

若是難於理解，能夠這樣看。羅永浩仍是羅永浩，不會由於某些人對於他「傻x」的評價而改變，標籤只是某些人對於其餘事物的評價，可是標籤不會改變事物自己，標籤只是特定人羣的手段。因此，註解一樣沒法改變代碼自己，註解只是某些工具的的工具。

仍是回到官方文檔的解釋上，註解主要針對的是編譯器和其它工具軟件(SoftWare tool)。

當開發者使用了Annotation 修飾了類、方法、Field 等成員以後，這些 Annotation 不會本身生效，必須由開發者提供相應的代碼來提取並處理 Annotation 信息。這些處理提取和處理 Annotation 的代碼統稱爲 APT（Annotation Processing Tool)。

如今，咱們能夠給本身答案了，註解有什麼用？給誰用？給編譯器或者 APT 用的。

若是，你仍是沒有搞清楚的話，我親自寫一個好了。

親手自定義註解完成某個目的

我要寫一個測試框架，測試程序員的代碼有無明顯的異常。

—— 程序員 A : 我寫了一個類，它的名字叫作 NoBug，由於它全部的方法都沒有錯誤。
—— 我：自信是好事，不過爲了防止意外，讓我測試一下如何？
—— 程序員 A: 怎麼測試？
—— 我：把你寫的代碼的方法都加上 @Jiecha 這個註解就行了。
—— 程序員 A: 好的。

NoBug.java

package ceshi;
import ceshi.Jiecha;


public class NoBug {

    @Jiecha
    public void suanShu(){
        System.out.println("1234567890");
    }
    @Jiecha
    public void jiafa(){
        System.out.println("1+1="+1+1);
    }
    @Jiecha
    public void jiefa(){
        System.out.println("1-1="+(1-1));
    }
    @Jiecha
    public void chengfa(){
        System.out.println("3 x 5="+ 3*5);
    }
    @Jiecha
    public void chufa(){
        System.out.println("6 / 0="+ 6 / 0);
    }

    public void ziwojieshao(){
        System.out.println("我寫的程序沒有 bug!");
    }

}

上面的代碼，有些方法上面運用了 @Jiecha 註解。

這個註解是我寫的測試軟件框架中定義的註解。

package ceshi;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface Jiecha {

}

而後，我再編寫一個測試類 TestTool 就能夠測試 NoBug 相應的方法了。

package ceshi;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;



public class TestTool {

    public static void main(String[] args) {
        // TODO Auto-generated method stub

        NoBug testobj = new NoBug();

        Class clazz = testobj.getClass();

        Method[] method = clazz.getDeclaredMethods();
        //用來記錄測試產生的 log 信息
        StringBuilder log = new StringBuilder();
        // 記錄異常的次數
        int errornum = 0;

        for ( Method m: method ) {
            // 只有被 @Jiecha 標註過的方法才進行測試
            if ( m.isAnnotationPresent( Jiecha.class )) {
                try {
                    m.setAccessible(true);
                    m.invoke(testobj, null);

                } catch (Exception e) {
                    // TODO Auto-generated catch block
                    //e.printStackTrace();
                    errornum++;
                    log.append(m.getName());
                    log.append(" ");
                    log.append("has error:");
                    log.append("\n\r  caused by ");
                    //記錄測試過程當中，發生的異常的名稱
                    log.append(e.getCause().getClass().getSimpleName());
                    log.append("\n\r");
                    //記錄測試過程當中，發生的異常的具體信息
                    log.append(e.getCause().getMessage());
                    log.append("\n\r");
                } 
            }
        }


        log.append(clazz.getSimpleName());
        log.append(" has  ");
        log.append(errornum);
        log.append(" error.");

        // 生成測試報告
        System.out.println(log.toString());

    }

}

測試的結果是：

1234567890
1+1=11
1-1=0
3 x 5=15
chufa has error:

  caused by ArithmeticException

/ by zero

NoBug has  1 error.

提示 NoBug 類中的 chufa() 這個方法有異常，這個異常名稱叫作 ArithmeticException，緣由是運算過程當中進行了除 0 的操做。

因此，NoBug 這個類有 Bug。

這樣，經過註解我完成了我本身的目的，那就是對別人的代碼進行測試。

因此，再問我註解何時用？我只能告訴你，這取決於你想利用它幹什麼用。

註解應用實例

註解運用的地方太多了，由於我是 Android 開發者，因此我接觸到的具體例子有下：

JUnit

JUnit 這個是一個測試框架，典型使用方法以下：

public class ExampleUnitTest {
    @Test
    public void addition_isCorrect() throws Exception {
        assertEquals(4, 2 + 2);
    }
}

@Test 標記了要進行測試的方法 addition_isCorrect().

ButterKnife

ButterKnife 是 Android 開發中大名鼎鼎的 IOC 框架，它減小了大量重複的代碼。

public class MainActivity extends AppCompatActivity {

    @BindView(R.id.tv_test)
    TextView mTv;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        ButterKnife.bind(this);
    }
}

Dagger2

也是一個頗有名的依賴注入框架。

Retrofit

很牛逼的 Http 網絡訪問框架

public interface GitHubService {
  @GET("users/{user}/repos")
  Call<List<Repo>> listRepos(@Path("user") String user);
}

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com/")
    .build();

GitHubService service = retrofit.create(GitHubService.class);

固然，還有許多註解應用的地方，這裏不一一列舉。