1. 程式人生 > >秒懂,Java 註解 (Annotation)你可以這樣學

秒懂,Java 註解 (Annotation)你可以這樣學

face 幹什麽 有一種 博客 作用 習慣 lis 如果 手機

技術分享圖片
這處圖片引自老羅的博客。為了避免不必要的麻煩,首先聲明我個人比較尊敬老羅的。至於為什麽放這張圖,自然是為本篇博文服務,接下來我自會說明。好了,可以開始今天的博文了。

Annotation 中文譯過來就是註解、標釋的意思,在 Java 中註解是一個很重要的知識點,但經常還是有點讓新手不容易理解。

我個人認為,比較糟糕的技術文檔主要特征之一就是:用專業名詞來介紹專業名詞。

比如:

Java 註解用於為 Java 代碼提供元數據。作為元數據,註解不直接影響你的代碼執行,但也有一些類型的註解實際上可以用於這一目的。Java 註解是從 Java5 開始添加到 Java 的。

這是大多數網站上對於 Java 註解,解釋確實正確,但是說實在話,我第一次學習的時候,頭腦一片空白。這什麽跟什麽啊?聽了像沒有聽一樣。因為概念太過於抽象,所以初學者實在是比較吃力才能夠理解,然後隨著自己開發過程中不斷地強化練習,才會慢慢對它形成正確的認識。

我在寫這篇文章的時候,我就在思考。如何讓自己或者讓讀者能夠比較直觀地認識註解這個概念?是要去官方文檔上翻譯說明嗎?我馬上否定了這個答案。

後來,我想到了一樣東西————墨水,墨水可以揮發、可以有不同的顏色,用來解釋註解正好。

不過,我繼續發散思維後,想到了一樣東西能夠更好地代替墨水,那就是印章。印章可以沾上不同的墨水或者印泥,可以定制印章的文字或者圖案,如果願意它也可以被戳到你任何想戳的物體表面。

但是,我再繼續發散思維後,又想到一樣東西能夠更好地代替印章,那就是標簽。標簽是一張便利紙,標簽上的內容可以自由定義。常見的如貨架上的商品價格標簽、圖書館中的書本編碼標簽、實驗室中化學材料的名稱類別標簽等等。

並且,往抽象地說,標簽並不一定是一張紙,它可以是對人和事物的屬性評價。也就是說,標簽具備對於抽象事物的解釋。

技術分享圖片

所以,基於如此,我完成了自我的知識認知升級,我決定用標簽來解釋註解。

註解如同標簽

回到博文開始的地方,之前某新聞客戶端的評論有蓋樓的習慣,於是 “喬布斯重新定義了手機、羅永浩重新定義了傻X” 就經常極為工整地出現在了評論樓層中,並且廣大網友在相當長的一段時間內對於這種行為樂此不疲。這其實就是等同於貼標簽的行為。

在某些網友眼中,羅永浩就成了傻X的代名詞。

廣大網友給羅永浩貼了一個名為“傻x”的標簽,他們並不真正了解羅永浩,不知道他當教師、砸冰箱、辦博客的壯舉,但是因為“傻x”這樣的標簽存在,這有助於他們直接快速地對羅永浩這個人做出評價,然後基於此,羅永浩就可以成為茶余飯後的談資,這就是標簽的力量。

而在網絡的另一邊,老羅靠他的人格魅力自然收獲一大批忠實的擁泵,他們對於老羅貼的又是另一種標簽。
技術分享圖片

老羅還是老羅,但是由於人們對於它貼上的標簽不同,所以造成對於他的看法大相徑庭,不喜歡他的人整天在網絡上評論抨擊嘲諷,而崇拜欣賞他的人則會願意掙錢購買錘子手機的發布會門票。

我無意於評價這兩種行為,我再引個例子。

《奇葩說》是近年網絡上非常火熱的辯論節目,其中辯手陳銘被另外一個辯手馬薇薇攻擊說是————“站在宇宙中心呼喚愛”,然後貼上了一個大大的標簽————“雞湯男”,自此以後,觀眾再看到陳銘的時候,首先映入腦海中便是“雞湯男”三個大字,其實本身而言陳銘非常優秀,為人師表、作風正派、談吐舉止得體,但是在網絡中,因為娛樂至上的環境所致,人們更願意以娛樂的心態來認知一切,於是“雞湯男”就如陳銘自己所說成了一個撕不了的標簽。

我們可以抽象概括一下,標簽是對事物行為的某些角度的評價與解釋。

到這裏,終於可以引出本文的主角註解了。

初學者可以這樣理解註解:想像代碼具有生命,註解就是對於代碼中某些鮮活個體的貼上去的一張標簽。簡化來講,註解如同一張標簽。

在未開始學習任何註解具體語法而言,你可以把註解看成一張標簽。這有助於你快速地理解它的大致作用。如果初學者在學習過程有大腦放空的時候,請不要慌張,對自己說:

註解,標簽。註解,標簽。

註解語法

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

註解的定義

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

public @interface TestAnnotation {
}
  • 1
  • 2

它的形式跟接口很類似,不過前面多了一個 @ 符號。上面的代碼就創建了一個名字為 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);
  • 當然,還有許多註解應用的地方,這裏不一一列舉。

總結

  1. 如果註解難於理解,你就把它類同於標簽,標簽為了解釋事物,註解為了解釋代碼。
  2. 註解的基本語法,創建如同接口,但是多了個 @ 符號。
  3. 註解的元註解。
  4. 註解的屬性。
  5. 註解主要給編譯器及工具類型的軟件用的。
  6. 註解的提取需要借助於 Java 的反射技術,反射比較慢,所以註解使用時也需要謹慎計較時間成本。

Java 反射機制中另外一個比較重要的概念就是動態代理了,寫下這篇文章後,我一鼓作氣,又寫了這篇 《輕松學,Java 中的代理模式及動態代理》,有興趣的同學可以一並閱讀一下。

秒懂,Java 註解 (Annotation)你可以這樣學