文章開(kāi)頭先引入一處圖片。
Annotation 中文譯過(guò)來(lái)就是注解、標釋的意思,在 Java 中注解是一個(gè)很重要的知識點(diǎn),但經(jīng)常還是有點(diǎn)讓新手不容易理解。
我個(gè)人認為,比較糟糕的技術(shù)文檔主要特征之一就是:用專(zhuān)業(yè)名詞來(lái)介紹專(zhuān)業(yè)名詞。
比如:
Java 注解用于為 Java 代碼提供元數據。作為元數據,注解不直接影響你的代碼執行,但也有一些類(lèi)型的注解實(shí)際上可以用于這一目的。Java 注解是從 Java5 開(kāi)始添加到 Java 的。
這是大多數網(wǎng)站上對于 Java 注解,解釋確實(shí)正確,但是說(shuō)實(shí)在話(huà),我第一次學(xué)習的時(shí)候,頭腦一片空白。這什么跟什么???聽(tīng)了像沒(méi)有聽(tīng)一樣。因為概念太過(guò)于抽象,所以初學(xué)者實(shí)在是比較吃力才能夠理解,然后隨著(zhù)自己開(kāi)發(fā)過(guò)程中不斷地強化練習,才會(huì )慢慢對它形成正確的認識。
我在寫(xiě)這篇文章的時(shí)候,我就在思考。如何讓自己或者讓讀者能夠比較直觀(guān)地認識注解這個(gè)概念?是要去官方文檔上翻譯說(shuō)明嗎?我馬上否定了這個(gè)答案。
后來(lái),我想到了一樣東西————墨水,墨水可以揮發(fā)、可以有不同的顏色,用來(lái)解釋注解正好。
不過(guò),我繼續發(fā)散思維后,想到了一樣東西能夠更好地代替墨水,那就是印章。印章可以沾上不同的墨水或者印泥,可以定制印章的文字或者圖案,如果愿意它也可以被戳到你任何想戳的物體表面。
但是,我再繼續發(fā)散思維后,又想到一樣東西能夠更好地代替印章,那就是標簽。標簽是一張便利紙,標簽上的內容可以自由定義。常見(jiàn)的如貨架上的商品價(jià)格標簽、圖書(shū)館中的書(shū)本編碼標簽、實(shí)驗室中化學(xué)材料的名稱(chēng)類(lèi)別標簽等等。
并且,往抽象地說(shuō),標簽并不一定是一張紙,它可以是對人和事物的屬性評價(jià)。也就是說(shuō),標簽具備對于抽象事物的解釋。
所以,基于如此,我完成了自我的知識認知升級,我決定用標簽來(lái)解釋注解。
回到博文開(kāi)始的地方,之前某新聞客戶(hù)端的評論有蓋樓的習慣,于是 “喬布斯重新定義了手機、羅永浩重新定義了傻X” 就經(jīng)常極為工整地出現在了評論樓層中,并且廣大網(wǎng)友在相當長(cháng)的一段時(shí)間內對于這種行為樂(lè )此不疲。這其實(shí)就是等同于貼標簽的行為。
在某些網(wǎng)友眼中,羅永浩就成了傻X的代名詞。
廣大網(wǎng)友給羅永浩貼了一個(gè)名為“傻x”的標簽,他們并不真正了解羅永浩,不知道他當教師、砸冰箱、辦博客的壯舉,但是因為“傻x”這樣的標簽存在,這有助于他們直接快速地對羅永浩這個(gè)人做出評價(jià),然后基于此,羅永浩就可以成為茶余飯后的談資,這就是標簽的力量。
而在網(wǎng)絡(luò )的另一邊,老羅靠他的人格魅力自然收獲一大批忠實(shí)的擁泵,他們對于老羅貼的又是另一種標簽。
老羅還是老羅,但是由于人們對于它貼上的標簽不同,所以造成對于他的看法大相徑庭,不喜歡他的人整天在網(wǎng)絡(luò )上評論抨擊嘲諷,而崇拜欣賞他的人則會(huì )愿意掙錢(qián)購買(mǎi)錘子手機的發(fā)布會(huì )門(mén)票。
我無(wú)意于評價(jià)這兩種行為,我再引個(gè)例子。
《奇葩說(shuō)》是近年網(wǎng)絡(luò )上非?;馃岬霓q論節目,其中辯手陳銘被另外一個(gè)辯手馬薇薇攻擊說(shuō)是————“站在宇宙中心呼喚愛(ài)”,然后貼上了一個(gè)大大的標簽————“雞湯男”,自此以后,觀(guān)眾再看到陳銘的時(shí)候,首先映入腦海中便是“雞湯男”三個(gè)大字,其實(shí)本身而言陳銘非常優(yōu)秀,為人師表、作風(fēng)正派、談吐舉止得體,但是在網(wǎng)絡(luò )中,因為娛樂(lè )至上的環(huán)境所致,人們更愿意以?shī)蕵?lè )的心態(tài)來(lái)認知一切,于是“雞湯男”就如陳銘自己所說(shuō)成了一個(gè)撕不了的標簽。
我們可以抽象概括一下,標簽是對事物行為的某些角度的評價(jià)與解釋。
到這里,終于可以引出本文的主角注解了。
初學(xué)者可以這樣理解注解:想像代碼具有生命,注解就是對于代碼中某些鮮活個(gè)體的貼上去的一張標簽。簡(jiǎn)化來(lái)講,注解如同一張標簽。
在未開(kāi)始學(xué)習任何注解具體語(yǔ)法而言,你可以把注解看成一張標簽。這有助于你快速地理解它的大致作用。如果初學(xué)者在學(xué)習過(guò)程有大腦放空的時(shí)候,請不要慌張,對自己說(shuō):
注解,標簽。注解,標簽。
因為平常開(kāi)發(fā)少見(jiàn),相信有不少的人員會(huì )認為注解的地位不高。其實(shí)同 classs 和 interface 一樣,注解也屬于一種類(lèi)型。它是在 Java SE 5.0 版本中開(kāi)始引入的概念。
注解通過(guò) @interface 關(guān)鍵字進(jìn)行定義。
public @interface TestAnnotation {}它的形式跟接口很類(lèi)似,不過(guò)前面多了一個(gè) @ 符號。上面的代碼就創(chuàng )建了一個(gè)名字為 TestAnnotaion 的注解。
你可以簡(jiǎn)單理解為創(chuàng )建了一張名字為 TestAnnotation 的標簽。
上面創(chuàng )建了一個(gè)注解,那么注解的的使用方法是什么呢。
@TestAnnotationpublic class Test {}創(chuàng )建一個(gè)類(lèi) Test,然后在類(lèi)定義的地方加上 @TestAnnotation 就可以用 TestAnnotation 注解這個(gè)類(lèi)了。
你可以簡(jiǎn)單理解為將 TestAnnotation 這張標簽貼到 Test 這個(gè)類(lèi)上面。
不過(guò),要想注解能夠正常工作,還需要介紹一下一個(gè)新的概念那就是元注解。
元注解是什么意思呢?
元注解是可以注解到注解上的注解,或者說(shuō)元注解是一種基本注解,但是它能夠應用到其它的注解上面。
如果難于理解的話(huà),你可以這樣理解。元注解也是一張標簽,但是它是一張特殊的標簽,它的作用和目的就是給其他普通的標簽進(jìn)行解釋說(shuō)明的。
元標簽有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 種。
Retention 的英文意為保留期的意思。當 @Retention 應用到一個(gè)注解上的時(shí)候,它解釋說(shuō)明了這個(gè)注解的的存活時(shí)間。
它的取值如下:
- RetentionPolicy.SOURCE 注解只在源碼階段保留,在編譯器進(jìn)行編譯時(shí)它將被丟棄忽視。
- RetentionPolicy.CLASS 注解只被保留到編譯進(jìn)行的時(shí)候,它并不會(huì )被加載到 JVM 中。
- RetentionPolicy.RUNTIME 注解可以保留到程序運行的時(shí)候,它會(huì )被加載進(jìn)入到 JVM 中,所以在程序運行時(shí)可以獲取到它們。
我們可以這樣的方式來(lái)加深理解,@Retention 去給一張標簽解釋的時(shí)候,它指定了這張標簽張貼的時(shí)間。@Retention 相當于給一張標簽上面蓋了一張時(shí)間戳,時(shí)間戳指明了標簽張貼的時(shí)間周期。
@Retention(RetentionPolicy.RUNTIME)public @interface TestAnnotation {}上面的代碼中,我們指定 TestAnnotation 可以在程序運行周期被獲取到,因此它的生命周期非常的長(cháng)。
顧名思義,這個(gè)元注解肯定是和文檔有關(guān)。它的作用是能夠將注解中的元素包含到 Javadoc 中去。
Target 是目標的意思,@Target 指定了注解運用的地方。
你可以這樣理解,當一個(gè)注解被 @Target 注解時(shí),這個(gè)注解就被限定了運用的場(chǎng)景。
類(lèi)比到標簽,原本標簽是你想張貼到哪個(gè)地方就到哪個(gè)地方,但是因為 @Target 的存在,它張貼的地方就非常具體了,比如只能張貼到方法上、類(lèi)上、方法參數上等等。@Target 有下面的取值
Inherited 是繼承的意思,但是它并不是說(shuō)注解本身可以繼承,而是說(shuō)如果一個(gè)超類(lèi)被 @Inherited 注解過(guò)的注解進(jìn)行注解的話(huà),那么如果它的子類(lèi)沒(méi)有被任何注解應用的話(huà),那么這個(gè)子類(lèi)就繼承了超類(lèi)的注解。
說(shuō)的比較抽象。代碼來(lái)解釋。
@Inherited@Retention(RetentionPolicy.RUNTIME)@interface Test {}@Testpublic class A {}public class B extends A {}注解 Test 被 @Inherited 修飾,之后類(lèi) A 被 Test 注解,類(lèi) B 繼承 A,類(lèi) B 也擁有 Test 這個(gè)注解。
可以這樣理解:
老子非常有錢(qián),所以人們給他貼了一張標簽叫做富豪。
老子的兒子長(cháng)大后,只要沒(méi)有和老子斷絕父子關(guān)系,雖然別人沒(méi)有給他貼標簽,但是他自然也是富豪。
老子的孫子長(cháng)大了,自然也是富豪。
這就是人們口中戲稱(chēng)的富一代,富二代,富三代。雖然叫法不同,好像好多個(gè)標簽,但其實(shí)事情的本質(zhì)也就是他們有一張共同的標簽,也就是老子身上的那張富豪的標簽。
Repeatable 自然是可重復的意思。@Repeatable 是 Java 1.8 才加進(jìn)來(lái)的,所以算是一個(gè)新的特性。
什么樣的注解會(huì )多次應用呢?通常是注解的值可以同時(shí)取多個(gè)。
舉個(gè)例子,一個(gè)人他既是程序員又是產(chǎn)品經(jīng)理,同時(shí)他還是個(gè)畫(huà)家。
@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 后面括號中的類(lèi)相當于一個(gè)容器注解。
什么是容器注解呢?就是用來(lái)存放其它注解的地方。它本身也是一個(gè)注解。
我們再看看代碼中的相關(guān)容器注解。
@interface Persons { Person[] value();}按照規定,它里面必須要有一個(gè) value 的屬性,屬性類(lèi)型是一個(gè)被 @Repeatable 注解過(guò)的注解數組,注意它是數組。
如果不好理解的話(huà),可以這樣理解。Persons 是一張總的標簽,上面貼滿(mǎn)了 Person 這種同類(lèi)型但內容不一樣的標簽。把 Persons 給一個(gè) SuperMan 貼上,相當于同時(shí)給他貼了程序員、產(chǎn)品經(jīng)理、畫(huà)家的標簽。
我們可能對于 @Person(role=”P(pán)M”) 括號里面的內容感興趣,它其實(shí)就是給 Person 這個(gè)注解的 role 屬性賦值為 PM ,大家不明白正常,馬上就講到注解的屬性這一塊。
注解的屬性也叫做成員變量。注解只有成員變量,沒(méi)有方法。注解的成員變量在注解的定義中以“無(wú)形參的方法”形式來(lái)聲明,其方法名定義了該成員變量的名字,其返回值定義了該成員變量的類(lèi)型。
@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)public @interface TestAnnotation { int id(); String msg();}上面代碼定義了 TestAnnotation 這個(gè)注解中擁有 id 和 msg 兩個(gè)屬性。在使用的時(shí)候,我們應該給它們進(jìn)行賦值。
賦值的方式是在注解的括號內以 value=”” 形式,多個(gè)屬性之前用 ,隔開(kāi)。
@TestAnnotation(id=3,msg="hello annotation")public class Test {}需要注意的是,在注解中定義屬性時(shí)它的類(lèi)型必須是 8 種基本數據類(lèi)型外加 類(lèi)、接口、注解及它們的數組。
注解中屬性可以有默認值,默認值需要用 default 關(guān)鍵值指定。比如:
@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 {}因為有默認值,所以無(wú)需要再在 @TestAnnotation 后面的括號里面進(jìn)行賦值了,這一步可以省略。
另外,還有一種情況。如果一個(gè)注解內僅僅只有一個(gè)名字為 value 的屬性時(shí),應用這個(gè)注解時(shí)可以直接接屬性值填寫(xiě)到括號內。
public @interface Check { String value();}上面代碼中,Check 這個(gè)注解只有 value 這個(gè)屬性。所以可以這樣應用。
@Check("hi")int a;這和下面的效果是一樣的
@Check(value="hi")int a;最后,還需要注意的一種情況是一個(gè)注解沒(méi)有任何屬性。比如
public @interface Perform {}那么在應用這個(gè)注解的時(shí)候,括號都可以省略。
@Performpublic void testMethod(){}學(xué)習了上面相關(guān)的知識,我們已經(jīng)可以自己定義一個(gè)注解了。其實(shí) Java 語(yǔ)言本身已經(jīng)提供了幾個(gè)現成的注解。
這個(gè)元素是用來(lái)標記過(guò)時(shí)的元素,想必大家在日常開(kāi)發(fā)中經(jīng)常碰到。編譯器在編譯階段遇到這個(gè)注解時(shí)會(huì )發(fā)出提醒警告,告訴開(kāi)發(fā)者正在調用一個(gè)過(guò)時(shí)的元素比如過(guò)時(shí)的方法、過(guò)時(shí)的類(lèi)、過(guò)時(shí)的成員變量。
public class Hero { @Deprecated public void say(){ System.out.println("Noting has to say!"); } public void speak(){ System.out.println("I have a dream!"); }}定義了一個(gè) Hero 類(lèi),它有兩個(gè)方法 say() 和 speak() ,其中 say() 被 @Deprecated 注解。然后我們在 IDE 中分別調用它們。
可以看到,say() 方法上面被一條直線(xiàn)劃了一條,這其實(shí)就是編譯器識別后的提醒效果。
這個(gè)大家應該很熟悉了,提示子類(lèi)要復寫(xiě)父類(lèi)中被 @Override 修飾的方法
阻止警告的意思。之前說(shuō)過(guò)調用被 @Deprecated 注解的方法后,編譯器會(huì )警告提醒,而有時(shí)候開(kāi)發(fā)者會(huì )忽略這種警告,他們可以在調用的地方通過(guò) @SuppressWarnings 達到目的。
@SuppressWarnings("deprecation")public void test1(){ Hero hero = new Hero(); hero.say(); hero.speak();}參數安全類(lèi)型注解。它的目的是提醒開(kāi)發(fā)者不要用參數做一些不安全的操作,它的存在會(huì )阻止編譯器產(chǎn)生 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!}上面的代碼中,編譯階段不會(huì )報錯,但是運行時(shí)會(huì )拋出 ClassCastException 這個(gè)異常,所以它雖然告訴開(kāi)發(fā)者要妥善處理,但是開(kāi)發(fā)者自己還是搞砸了。
Java 官方文檔說(shuō),未來(lái)的版本會(huì )授權編譯器對這種不安全的操作產(chǎn)生錯誤警告。
函數式接口注解,這個(gè)是 Java 1.8 版本引入的新特性。函數式編程很火,所以 Java 8 也及時(shí)添加了這個(gè)特性。
函數式接口 (Functional Interface) 就是一個(gè)具有一個(gè)方法的普通接口。
比如
@FunctionalInterfacepublic 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();}我們進(jìn)行線(xiàn)程開(kāi)發(fā)中常用的 Runnable 就是一個(gè)典型的函數式接口,上面源碼可以看到它就被 @FunctionalInterface 注解。
可能有人會(huì )疑惑,函數式接口標記有什么用,這個(gè)原因是函數式接口可以很容易轉換為 Lambda 表達式。這是另外的主題了,有興趣的同學(xué)請自己搜索相關(guān)知識點(diǎn)學(xué)習。
博文前面的部分講了注解的基本語(yǔ)法,現在是時(shí)候檢測我們所學(xué)的內容了。
我通過(guò)用標簽來(lái)比作注解,前面的內容是講怎么寫(xiě)注解,然后貼到哪個(gè)地方去,而現在我們要做的工作就是檢閱這些標簽內容。 形象的比喻就是你把這些注解標簽在合適的時(shí)候撕下來(lái),然后檢閱上面的內容信息。
要想正確檢閱注解,離不開(kāi)一個(gè)手段,那就是反射。
注解通過(guò)反射獲取。首先可以通過(guò) Class 對象的 isAnnotationPresent() 方法判斷它是否應用了某個(gè)注解
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}然后通過(guò) getAnnotation() 方法來(lái)獲取 Annotation 對象。
public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}或者是 getAnnotations() 方法。
public Annotation[] getAnnotations() {}前一種方法返回指定類(lèi)型的注解,后一種方法返回注解到這個(gè)元素上的所有注解。
如果獲取到的 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:-1msg:這個(gè)正是 TestAnnotation 中 id 和 msg 的默認值。
上面的例子中,只是檢閱出了注解在類(lèi)上的注解,其實(shí)屬性、方法上的注解照樣是可以的。同樣還是要假手于反射。
@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); //獲取類(lèi)的注解 System.out.println("id:"+testAnnotation.id()); System.out.println("msg:"+testAnnotation.msg()); } try { Field a = Test.class.getDeclaredField("a"); a.setAccessible(true); //獲取一個(gè)成員變量上的注解 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:-1msg:hellocheck value:himethod testMethod annotation:Perform需要注意的是,如果一個(gè)注解要在運行時(shí)被成功提取,那么 @Retention(RetentionPolicy.RUNTIME) 是必須的。
我相信博文講到這里大家都很熟悉了注解,但是有不少同學(xué)肯定會(huì )問(wèn),注解到底有什么用呢?
對啊注解到底有什么用?
我們不妨將目光放到 Java 官方文檔上來(lái)。
文章開(kāi)始的時(shí)候,我用標簽來(lái)類(lèi)比注解。但標簽比喻只是我的手段,而不是目的。為的是讓大家在初次學(xué)習注解時(shí)能夠不被那些抽象的新概念搞懵。既然現在,我們已經(jīng)對注解有所了解,我們不妨再仔細閱讀官方最嚴謹的文檔。
注解是一系列元數據,它提供數據用來(lái)解釋程序代碼,但是注解并非是所解釋的代碼本身的一部分。注解對于代碼的運行效果沒(méi)有直接影響。
注解有許多用處,主要如下:
- 提供信息給編譯器: 編譯器可以利用注解來(lái)探測錯誤和警告信息
- 編譯階段時(shí)的處理: 軟件工具可以用來(lái)利用注解信息來(lái)生成代碼、Html文檔或者做其它相應處理。
- 運行時(shí)的處理: 某些注解可以在程序運行的時(shí)候接受代碼的提取
值得注意的是,注解不是代碼本身的一部分。
如果難于理解,可以這樣看。羅永浩還是羅永浩,不會(huì )因為某些人對于他“傻x”的評價(jià)而改變,標簽只是某些人對于其他事物的評價(jià),但是標簽不會(huì )改變事物本身,標簽只是特定人群的手段。所以,注解同樣無(wú)法改變代碼本身,注解只是某些工具的的工具。
還是回到官方文檔的解釋上,注解主要針對的是編譯器和其它工具軟件(SoftWare tool)。
當開(kāi)發(fā)者使用了Annotation 修飾了類(lèi)、方法、Field 等成員之后,這些 Annotation 不會(huì )自己生效,必須由開(kāi)發(fā)者提供相應的代碼來(lái)提取并處理 Annotation 信息。這些處理提取和處理 Annotation 的代碼統稱(chēng)為 APT(Annotation Processing Tool)。
現在,我們可以給自己答案了,注解有什么用?給誰(shuí)用?給 編譯器或者 APT 用的。
如果,你還是沒(méi)有搞清楚的話(huà),我親自寫(xiě)一個(gè)好了。
我要寫(xiě)一個(gè)測試框架,測試程序員的代碼有無(wú)明顯的異常。
—— 程序員 A : 我寫(xiě)了一個(gè)類(lèi),它的名字叫做 NoBug,因為它所有的方法都沒(méi)有錯誤。
—— 我:自信是好事,不過(guò)為了防止意外,讓我測試一下如何?
—— 程序員 A: 怎么測試?
—— 我:把你寫(xiě)的代碼的方法都加上 @Jiecha 這個(gè)注解就好了。
—— 程序員 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("我寫(xiě)的程序沒(méi)有 bug!"); }}上面的代碼,有些方法上面運用了 @Jiecha 注解。
這個(gè)注解是我寫(xiě)的測試軟件框架中定義的注解。
package ceshi;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;@Retention(RetentionPolicy.RUNTIME)public @interface Jiecha {}然后,我再編寫(xiě)一個(gè)測試類(lèi) 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(); //用來(lái)記錄測試產(chǎn)生的 log 信息 StringBuilder log = new StringBuilder(); // 記錄異常的次數 int errornum = 0; for ( Method m: method ) { // 只有被 @Jiecha 標注過(guò)的方法才進(jìn)行測試 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 "); //記錄測試過(guò)程中,發(fā)生的異常的名稱(chēng) log.append(e.getCause().getClass().getSimpleName()); log.append("\n\r"); //記錄測試過(guò)程中,發(fā)生的異常的具體信息 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()); }}測試的結果是:
12345678901+1=111-1=03 x 5=15chufa has error: caused by ArithmeticException/ by zeroNoBug has 1 error.提示 NoBug 類(lèi)中的 chufa() 這個(gè)方法有異常,這個(gè)異常名稱(chēng)叫做 ArithmeticException,原因是運算過(guò)程中進(jìn)行了除 0 的操作。
所以,NoBug 這個(gè)類(lèi)有 Bug。
這樣,通過(guò)注解我完成了我自己的目的,那就是對別人的代碼進(jìn)行測試。
所以,再問(wèn)我注解什么時(shí)候用?我只能告訴你,這取決于你想利用它干什么用。
注解運用的地方太多了,因為我是 Android 開(kāi)發(fā)者,所以我接觸到的具體例子有下:
JUnit 這個(gè)是一個(gè)測試框架,典型使用方法如下:
public class ExampleUnitTest { @Test public void addition_isCorrect() throws Exception { assertEquals(4, 2 + 2); }}@Test 標記了要進(jìn)行測試的方法 addition_isCorrect().
ButterKnife 是 Android 開(kāi)發(fā)中大名鼎鼎的 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); }}也是一個(gè)很有名的依賴(lài)注入框架。
很牛逼的 Http 網(wǎng)絡(luò )訪(fǎng)問(wèn)框架
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);當然,還有許多注解應用的地方,這里不一一列舉。
Java 反射機制中另外一個(gè)比較重要的概念就是動(dòng)態(tài)代理了,寫(xiě)下這篇文章后,我一鼓作氣,又寫(xiě)了這篇 《輕松學(xué),Java 中的代理模式及動(dòng)態(tài)代理》,有興趣的同學(xué)可以一并閱讀一下。
最后致敬老羅和陳銘,拿你們的事例為博文主題提供論點(diǎn),只是基于技術(shù)視角,并沒(méi)有一絲惡意和冒犯之心。
聯(lián)系客服