原作者：frank909
原博客鏈接：秒懂，Java 注解 （Annotation）你可以這樣學(xué)
文章開頭先引入一處圖片扶歪。
這處圖片引自老羅的博客尉间。為了避免不必要的麻煩，首先聲明我個人比較尊敬老羅的击罪。至于為什么放這張圖哲嘲，自然是為本篇博文服務(wù)，接下來我自會說明媳禁。好了眠副，可以開始今天的博文了。
Annotation 中文譯過來就是注解竣稽、標釋的意思囱怕，在 Java 中注解是一個很重要的知識點，但經(jīng)常還是有點讓新手不容易理解毫别。
我個人認為娃弓，比較糟糕的技術(shù)文檔主要特征之一就是：用專業(yè)名詞來介紹專業(yè)名詞。
比如：
Java 注解用于為 Java 代碼提供元數(shù)據(jù)岛宦。作為元數(shù)據(jù)台丛，注解不直接影響你的代碼執(zhí)行，但也有一些類型的注解實際上可以用于這一目的。Java 注解是從 Java5 開始添加到 Java 的挽霉。
這是大多數(shù)網(wǎng)站上對于 Java 注解防嗡，解釋確實正確，但是說實在話侠坎，我第一次學(xué)習(xí)的時候蚁趁，頭腦一片空白。這什么跟什么笆敌亍他嫡？聽了像沒有聽一樣。因為概念太過于抽象庐完，所以初學(xué)者實在是比較吃力才能夠理解钢属，然后隨著自己開發(fā)過程中不斷地強化練習(xí)，才會慢慢對它形成正確的認識假褪。
我在寫這篇文章的時候署咽，我就在思考近顷。如何讓自己或者讓讀者能夠比較直觀地認識注解這個概念生音？是要去官方文檔上翻譯說明嗎？我馬上否定了這個答案窒升。
后來缀遍，我想到了一樣?xùn)|西————墨水，墨水可以揮發(fā)饱须、可以有不同的顏色域醇，用來解釋注解正好。
不過蓉媳，我繼續(xù)發(fā)散思維后譬挚，想到了一樣?xùn)|西能夠更好地代替墨水，那就是印章酪呻。印章可以沾上不同的墨水或者印泥减宣，可以定制印章的文字或者圖案，如果愿意它也可以被戳到你任何想戳的物體表面玩荠。
但是漆腌，我再繼續(xù)發(fā)散思維后，又想到一樣?xùn)|西能夠更好地代替印章阶冈，那就是標簽闷尿。標簽是一張便利紙，標簽上的內(nèi)容可以自由定義女坑。常見的如貨架上的商品價格標簽填具、圖書館中的書本編碼標簽、實驗室中化學(xué)材料的名稱類別標簽等等匆骗。
并且灌旧，往抽象地說绑咱，標簽并不一定是一張紙，它可以是對人和事物的屬性評價枢泰。也就是說描融，標簽具備對于抽象事物的解釋。
所以衡蚂，基于如此窿克，我完成了自我的知識認知升級，我決定用標簽來解釋注解毛甲。
注解如同標簽
回到博文開始的地方年叮，之前某新聞客戶端的評論有蓋樓的習(xí)慣，于是 “喬布斯重新定義了手機玻募、羅永浩重新定義了傻X” 就經(jīng)常極為工整地出現(xiàn)在了評論樓層中只损，并且廣大網(wǎng)友在相當(dāng)長的一段時間內(nèi)對于這種行為樂此不疲。這其實就是等同于貼標簽的行為七咧。
在某些網(wǎng)友眼中跃惫，羅永浩就成了傻X的代名詞。
廣大網(wǎng)友給羅永浩貼了一個名為“傻x”的標簽艾栋，他們并不真正了解羅永浩爆存，不知道他當(dāng)教師、砸冰箱蝗砾、辦博客的壯舉先较，但是因為“傻x”這樣的標簽存在，這有助于他們直接快速地對羅永浩這個人做出評價悼粮，然后基于此闲勺，羅永浩就可以成為茶余飯后的談資，這就是標簽的力量扣猫。
而在網(wǎng)絡(luò)的另一邊菜循，老羅靠他的人格魅力自然收獲一大批忠實的擁泵，他們對于老羅貼的又是另一種標簽苞笨。
老羅還是老羅债朵，但是由于人們對于它貼上的標簽不同，所以造成對于他的看法大相徑庭瀑凝，不喜歡他的人整天在網(wǎng)絡(luò)上評論抨擊嘲諷序芦，而崇拜欣賞他的人則會愿意掙錢購買錘子手機的發(fā)布會門票。
我無意于評價這兩種行為粤咪，我再引個例子谚中。
《奇葩說》是近年網(wǎng)絡(luò)上非常火熱的辯論節(jié)目，其中辯手陳銘被另外一個辯手馬薇薇攻擊說是————“站在宇宙中心呼喚愛”宪塔，然后貼上了一個大大的標簽————“雞湯男”磁奖，自此以后，觀眾再看到陳銘的時候某筐，首先映入腦海中便是“雞湯男”三個大字比搭，其實本身而言陳銘非常優(yōu)秀，為人師表南誊、作風(fēng)正派身诺、談吐舉止得體，但是在網(wǎng)絡(luò)中抄囚，因為娛樂至上的環(huán)境所致霉赡，人們更愿意以娛樂的心態(tài)來認知一切，于是“雞湯男”就如陳銘自己所說成了一個撕不了的標簽幔托。
我們可以抽象概括一下穴亏，標簽是對事物行為的某些角度的評價與解釋。
到這里重挑，終于可以引出本文的主角注解了嗓化。
初學(xué)者可以這樣理解注解：想像代碼具有生命，注解就是對于代碼中某些鮮活個體的貼上去的一張標簽攒驰。簡化來講蟆湖，注解如同一張標簽故爵。
在未開始學(xué)習(xí)任何注解具體語法而言玻粪，你可以把注解看成一張標簽。這有助于你快速地理解它的大致作用诬垂。如果初學(xué)者在學(xué)習(xí)過程有大腦放空的時候劲室，請不要慌張，對自己說：
注解结窘，標簽很洋。注解，標簽隧枫。
注解語法
因為平常開發(fā)少見喉磁，相信有不少的人員會認為注解的地位不高。其實同 classs 和 interface 一樣官脓，注解也屬于一種類型协怒。它是在 Java SE 5.0 版本中開始引入的概念。
注解的定義
注解通過 @interface 關(guān)鍵字進行定義卑笨。
public @interface TestAnnotation {
}
它的形式跟接口很類似孕暇，不過前面多了一個 @ 符號。上面的代碼就創(chuàng)建了一個名字為 TestAnnotaion 的注解。
你可以簡單理解為創(chuàng)建了一張名字為 TestAnnotation 的標簽妖滔。
注解的應(yīng)用
上面創(chuàng)建了一個注解隧哮，那么注解的的使用方法是什么呢。
@TestAnnotation
public class Test {
}
創(chuàng)建一個類 Test,然后在類定義的地方加上 @TestAnnotation 就可以用 TestAnnotation 注解這個類了座舍。
你可以簡單理解為將 TestAnnotation 這張標簽貼到 Test 這個類上面沮翔。
不過，要想注解能夠正常工作曲秉，還需要介紹一下一個新的概念那就是元注解鉴竭。
元注解
元注解是什么意思呢？
元注解是可以注解到注解上的注解岸浑，或者說元注解是一種基本注解搏存，但是它能夠應(yīng)用到其它的注解上面。
如果難于理解的話矢洲，你可以這樣理解璧眠。元注解也是一張標簽，但是它是一張?zhí)厥獾臉撕灦谅玻淖饔煤湍康木褪墙o其他普通的標簽進行解釋說明的责静。
元標簽有 @Retention、@Documented盖桥、@Target灾螃、@Inherited、@Repeatable 5 種揩徊。
@Retention
Retention 的英文意為保留期的意思腰鬼。當(dāng) @Retention 應(yīng)用到一個注解上的時候，它解釋說明了這個注解的存活時間塑荒。
它的取值如下：
- RetentionPolicy.SOURCE 注解只在源碼階段保留熄赡，在編譯器進行編譯時它將被丟棄忽視。
- RetentionPolicy.CLASS 注解只被保留到編譯進行的時候齿税，它并不會被加載到 JVM 中彼硫。
- RetentionPolicy.RUNTIME 注解可以保留到程序運行的時候，它會被加載進入到 JVM 中凌箕，所以在程序運行時可以獲取到它們拧篮。
[圖片上傳失敗...(image-e59a1b-1512912104552)]
我們可以這樣的方式來加深理解，@Retention 去給一張標簽解釋的時候牵舱，它指定了這張標簽張貼的時間串绩。@Retention 相當(dāng)于給一張標簽上面蓋了一張時間戳，時間戳指明了標簽張貼的時間周期仆葡。
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}
上面的代碼中赏参，我們指定 TestAnnotation 可以在程序運行周期被獲取到志笼，因此它的生命周期非常的長。
@Documented
顧名思義把篓，這個元注解肯定是和文檔有關(guān)纫溃。它的作用是能夠?qū)⒆⒔庵械脑匕?Javadoc 中去。
@Target
Target 是目標的意思韧掩，@Target 指定了注解運用的地方紊浩。
你可以這樣理解，當(dāng)一個注解被 @Target 注解時疗锐，這個注解就被限定了運用的場景坊谁。
類比到標簽，原本標簽是你想張貼到哪個地方就到哪個地方滑臊，但是因為 @Target 的存在口芍，它張貼的地方就非常具體了，比如只能張貼到方法上雇卷、類上鬓椭、方法參數(shù)上等等。@Target 有下面的取值
ElementType.ANNOTATION_TYPE 可以給一個注解進行注解
ElementType.CONSTRUCTOR 可以給構(gòu)造方法進行注解
ElementType.FIELD 可以給屬性進行注解
ElementType.LOCAL_VARIABLE 可以給局部變量進行注解
ElementType.METHOD 可以給方法進行注解
ElementType.PACKAGE 可以給一個包進行注解
ElementType.PARAMETER 可以給一個方法內(nèi)的參數(shù)進行注解
ElementType.TYPE 可以給一個類型進行注解关划，比如類小染、接口、枚舉
@Inherited
Inherited 是繼承的意思贮折，但是它并不是說注解本身可以繼承裤翩，而是說如果一個超類被 @Inherited 注解過的注解進行注解的話，那么如果它的子類沒有被任何注解應(yīng)用的話调榄，那么這個子類就繼承了超類的注解踊赠。
說的比較抽象。代碼來解釋振峻。
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}
@Test
public class A {}
public class B extends A {}
注解 Test 被 @Inherited 修飾臼疫，之后類 A 被 Test 注解择份，類 B 繼承 A,類 B 也擁有 Test 這個注解扣孟。
可以這樣理解：
老子非常有錢，所以人們給他貼了一張標簽叫做富豪荣赶。
老子的兒子長大后凤价，只要沒有和老子斷絕父子關(guān)系，雖然別人沒有給他貼標簽拔创，但是他自然也是富豪利诺。
老子的孫子長大了，自然也是富豪剩燥。
這就是人們口中戲稱的富一代慢逾，富二代立倍，富三代。雖然叫法不同侣滩，好像好多個標簽口注，但其實事情的本質(zhì)也就是他們有一張共同的標簽，也就是老子身上的那張富豪的標簽君珠。
@Repeatable
Repeatable 自然是可重復(fù)的意思寝志。@Repeatable 是 Java 1.8 才加進來的，所以算是一個新的特性策添。
什么樣的注解會多次應(yīng)用呢材部？通常是注解的值可以同時取多個。
舉個例子唯竹，一個人他既是程序員又是產(chǎn)品經(jīng)理,同時他還是個畫家乐导。
@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 后面括號中的類相當(dāng)于一個容器注解兽叮。
什么是容器注解呢？就是用來存放其它注解的地方猾愿。它本身也是一個注解鹦聪。
我們再看看代碼中的相關(guān)容器注解。
@interface Persons {
Person[] value();
}
按照規(guī)定蒂秘，它里面必須要有一個 value 的屬性泽本，屬性類型是一個被 @Repeatable 注解過的注解數(shù)組，注意它是數(shù)組姻僧。
我們可能對于 @Person(role=”PM”) 括號里面的內(nèi)容感興趣规丽，它其實就是給 Person 這個注解的 role 屬性賦值為 PM ，大家不明白正常撇贺，馬上就講到注解的屬性這一塊赌莺。
注解的屬性
注解的屬性也叫做成員變量。注解只有成員變量松嘶，沒有方法艘狭。注解的成員變量在注解的定義中以“無形參的方法”形式來聲明，其方法名定義了該成員變量的名字翠订，其返回值定義了該成員變量的類型巢音。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
int id();
String msg();
}
上面代碼定義了 TestAnnotation 這個注解中擁有 id 和 msg 兩個屬性械媒。在使用的時候如失，我們應(yīng)該給它們進行賦值。
賦值的方式是在注解的括號內(nèi)以value="" 形式劣挫，多個屬性之前用似谁，隔開傲绣。
@TestAnnotation(id=3,msg="hello annotation")
public class Test {
}
需要注意的是掠哥，在注解中定義屬性時它的類型必須是 8 種基本數(shù)據(jù)類型外加 類、接口秃诵、注解及它們的數(shù)組龙致。
注解中屬性可以有默認值，默認值需要用 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。
它可以這樣應(yīng)用嗤练。
@TestAnnotation()
public class Test {}
因為有默認值榛了，所以無需要再在 @TestAnnotation 后面的括號里面進行賦值了，這一步可以省略煞抬。
另外霜大，還有一種情況。如果一個注解內(nèi)僅僅只有一個名字為 value 的屬性時革答，應(yīng)用這個注解時可以直接接屬性值填寫到括號內(nèi)战坤。
public @interface Check {
String value();
}
上面代碼中，Check 這個注解只有 value 這個屬性残拐。所以可以這樣應(yīng)用途茫。
@Check("hi")
int a;
這和下面的效果是一樣的
@Check(value="hi")
int a;
最后，還需要注意的一種情況是一個注解沒有任何屬性溪食。比如
public @interface Perform {}
那么在應(yīng)用這個注解的時候囊卜，括號都可以省略。
@Perform
public void testMethod(){}
Java 預(yù)置的注解
學(xué)習(xí)了上面相關(guān)的知識错沃，我們已經(jīng)可以自己定義一個注解了栅组。其實 Java 語言本身已經(jīng)提供了幾個現(xiàn)成的注解。
@Deprecated
這個元素是用來標記過時的元素枢析，想必大家在日常開發(fā)中經(jīng)常碰到玉掸。編譯器在編譯階段遇到這個注解時會發(fā)出提醒警告，告訴開發(fā)者正在調(diào)用一個過時的元素比如過時的方法醒叁、過時的類司浪、過時的成員變量。
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 中分別調(diào)用它們智政。
[圖片上傳失敗...(image-2cbf5a-1512912104552)]
可以看到，say() 方法上面被一條直線劃了一條箱蝠，這其實就是編譯器識別后的提醒效果续捂。
@Override
這個大家應(yīng)該很熟悉了垦垂，提示子類要復(fù)寫父類中被 @Override 修飾的方法
@SuppressWarnings
阻止警告的意思。之前說過調(diào)用被 @Deprecated 注解的方法后牙瓢，編譯器會警告提醒劫拗，而有時候開發(fā)者會忽略這種警告，他們可以在調(diào)用的地方通過 @SuppressWarnings 達到目的矾克。
@SuppressWarnings("deprecation")
public void test1(){
Hero hero = new Hero();
hero.say();
hero.speak();
}
@SafeVarargs
參數(shù)安全類型注解页慷。它的目的是提醒開發(fā)者不要用參數(shù)做一些不安全的操作,它的存在會阻止編譯器產(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!
}
上面的代碼中酒繁，編譯階段不會報錯，但是運行時會拋出 ClassCastException 這個異常控妻，所以它雖然告訴開發(fā)者要妥善處理州袒，但是開發(fā)者自己還是搞砸了。
Java 官方文檔說弓候，未來的版本會授權(quán)編譯器對這種不安全的操作產(chǎn)生錯誤警告郎哭。
@FunctionalInterface
函數(shù)式接口注解，這個是 Java 1.8 版本引入的新特性菇存。函數(shù)式編程很火夸研，所以 Java 8 也及時添加了這個特性。
函數(shù)式接口 (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();
}
我們進行線程開發(fā)中常用的 Runnable 就是一個典型的函數(shù)式接口陈惰，上面源碼可以看到它就被 @FunctionalInterface 注解。
可能有人會疑惑毕籽，函數(shù)式接口標記有什么用抬闯，這個原因是函數(shù)式接口可以很容易轉(zhuǎn)換為 Lambda 表達式。這是另外的主題了关筒，有興趣的同學(xué)請自己搜索相關(guān)知識點學(xué)習(xí)溶握。
注解的提取
博文前面的部分講了注解的基本語法，現(xiàn)在是時候檢測我們所學(xué)的內(nèi)容了蒸播。
我通過用標簽來比作注解睡榆，前面的內(nèi)容是講怎么寫注解，然后貼到哪個地方去袍榆，而現(xiàn)在我們要做的工作就是檢閱這些標簽內(nèi)容胀屿。 形象的比喻就是你把這些注解標簽在合適的時候撕下來，然后檢閱上面的內(nèi)容信息包雀。
要想正確檢閱注解宿崭，離不開一個手段，那就是反射才写。
注解與反射葡兑。
注解通過反射獲取奖蔓。首先可以通過 Class 對象的 isAnnotationPresent() 方法判斷它是否應(yīng)用了某個注解
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}
然后通過 getAnnotation() 方法來獲取 Annotation 對象。
public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}
或者是 getAnnotations() 方法讹堤。
public Annotation[] getAnnotations() {}
前一種方法返回指定類型的注解吆鹤，后一種方法返回注解到這個元素上的所有注解。
如果獲取到的 Annotation 如果不為 null洲守，則就可以調(diào)用它們的屬性方法了疑务。比如
@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());
}
}
}
程序的運行結(jié)果是：
id:-1
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());
}
}
}
它們的結(jié)果如下：
id:-1
msg:hello
check value:hi
method testMethod annotation:Perform
需要注意的是廊镜，如果一個注解要在運行時被成功提取，那么 @Retention(RetentionPolicy.RUNTIME) 是必須的唉俗。
注解的使用場景
我相信博文講到這里大家都很熟悉了注解嗤朴，但是有不少同學(xué)肯定會問，注解到底有什么用呢虫溜？
對啊注解到底有什么用雹姊？
我們不妨將目光放到 Java 官方文檔上來。
文章開始的時候衡楞，我用標簽來類比注解吱雏。但標簽比喻只是我的手段，而不是目的瘾境。為的是讓大家在初次學(xué)習(xí)注解時能夠不被那些抽象的新概念搞懵歧杏。既然現(xiàn)在，我們已經(jīng)對注解有所了解迷守，我們不妨再仔細閱讀官方最嚴謹?shù)奈臋n犬绒。
注解是一系列元數(shù)據(jù)，它提供數(shù)據(jù)用來解釋程序代碼兑凿，但是注解并非是所解釋的代碼本身的一部分凯力。注解對于代碼的運行效果沒有直接影響。
注解有許多用處礼华，主要如下：
- 提供信息給編譯器： 編譯器可以利用注解來探測錯誤和警告信息
- 編譯階段時的處理： 軟件工具可以用來利用注解信息來生成代碼咐鹤、Html文檔或者做其它相應(yīng)處理。
- 運行時的處理： 某些注解可以在程序運行的時候接受代碼的提取
值得注意的是圣絮，注解不是代碼本身的一部分祈惶。
如果難于理解，可以這樣看。羅永浩還是羅永浩行瑞，不會因為某些人對于他“傻x”的評價而改變奸腺，標簽只是某些人對于其他事物的評價餐禁，但是標簽不會改變事物本身血久，標簽只是特定人群的手段。所以帮非，注解同樣無法改變代碼本身氧吐，注解只是某些工具的的工具。
還是回到官方文檔的解釋上末盔，注解主要針對的是編譯器和其它工具軟件(SoftWare tool)筑舅。
當(dāng)開發(fā)者使用了Annotation 修飾了類、方法陨舱、Field 等成員之后翠拣，這些 Annotation 不會自己生效，必須由開發(fā)者提供相應(yīng)的代碼來提取并處理 Annotation 信息游盲。這些處理提取和處理 Annotation 的代碼統(tǒng)稱為 APT（Annotation Processing Tool)误墓。
現(xiàn)在，我們可以給自己答案了益缎，注解有什么用谜慌？給誰用？給 編譯器或者 APT 用的莺奔。
如果欣范，你還是沒有搞清楚的話，我親自寫一個好了令哟。
親手自定義注解完成某個目的
我要寫一個測試框架恼琼，測試程序員的代碼有無明顯的異常。
—— 程序員 A : 我寫了一個類屏富，它的名字叫做 NoBug晴竞，因為它所有的方法都沒有錯誤。
—— 我：自信是好事役听，不過為了防止意外颓鲜，讓我測試一下如何？
—— 程序員 A: 怎么測試典予？
—— 我：把你寫的代碼的方法都加上 @Jiecha 這個注解就好了甜滨。
—— 程序員 A: 好的。
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
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 相應(yīng)的方法了艾扮。
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();
//用來記錄測試產(chǎn)生的 log 信息
StringBuilder log = new StringBuilder();
// 記錄異常的次數(shù)
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 ");
//記錄測試過程中既琴，發(fā)生的異常的名稱
log.append(e.getCause().getClass().getSimpleName());
log.append("\n\r");
//記錄測試過程中，發(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());
}
}
測試的結(jié)果是：
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磺箕。
這樣，通過注解我完成了我自己的目的抛虫，那就是對別人的代碼進行測試松靡。
所以，再問我注解什么時候用建椰？我只能告訴你雕欺，這取決于你想利用它干什么用。
注解應(yīng)用實例
注解運用的地方太多了棉姐，因為我是 Android 開發(fā)者屠列，所以我接觸到的具體例子有下：
JUnit
JUnit 這個是一個測試框架，典型使用方法如下：
public class ExampleUnitTest {
@Test
public void addition_isCorrect() throws Exception {
assertEquals(4, 2 + 2);
}
}
@Test 標記了要進行測試的方法 addition_isCorrect().
ButterKnife
ButterKnife 是 Android 開發(fā)中大名鼎鼎的 IOC 框架谅海，它減少了大量重復(fù)的代碼脸哀。
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 網(wǎng)絡(luò)訪問框架
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);
當(dāng)然扭吁，還有許多注解應(yīng)用的地方撞蜂，這里不一一列舉。
總結(jié)
- 如果注解難于理解侥袜，你就把它類同于標簽蝌诡，標簽為了解釋事物，注解為了解釋代碼枫吧。
- 注解的基本語法浦旱，創(chuàng)建如同接口，但是多了個 @ 符號九杂。
- 注解的元注解颁湖。
- 注解的屬性。
- 注解主要給編譯器及工具類型的軟件用的例隆。
- 注解的提取需要借助于 Java 的反射技術(shù)甥捺，反射比較慢，所以注解使用時也需要謹慎計較時間成本镀层。
Java 反射機制中另外一個比較重要的概念就是動態(tài)代理了镰禾，寫下這篇文章后，我一鼓作氣，又寫了這篇 《輕松學(xué)吴侦，Java 中的代理模式及動態(tài)代理》屋休，有興趣的同學(xué)可以一并閱讀一下。
最后致敬老羅和陳銘备韧，拿你們的事例為博文主題提供論點劫樟，只是基于技術(shù)視角，并沒有一絲惡意和冒犯之心盯蝴。
原作者：frank909
原博客鏈接：秒懂毅哗，Java 注解 （Annotation）你可以這樣學(xué)
