Java 註解 （Annotation）你可以這樣學
這處圖片引自老羅的部落格。為了避免不必要的麻煩，首先宣告我個人比較尊敬老羅的。至於為什麼放這張圖，自然是為本篇博文服務，接下來我自會說明。好了，可以開始今天的博文了。
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 {
}- 1
- 2
- 3
建立一個類 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 {
}- 1
- 2
- 3
上面的程式碼中，我們指定 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 {}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
註解 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{
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
注意上面的程式碼，@Repeatable 註解了 Person。而 @Repeatable 後面括號中的類相當於一個容器註解。
什麼是容器註解呢？就是用來存放其它註解的地方。它本身也是一個註解。
我們再看看程式碼中的相關容器註解。
@interface Persons {
Person[] value();
}- 1
- 2
- 3
按照規定，它裡面必須要有一個 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();
}- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
上面程式碼定義了 TestAnnotation 這個註解中擁有 id 和 msg 兩個屬性。在使用的時候，我們應該給它們進行賦值。
賦值的方式是在註解的括號內以 value=”” 形式，多個屬性之前用 ，隔開。
@TestAnnotation(id=3,msg="hello annotation")
public class Test {
}- 1
- 2
- 3
- 4
需要注意的是，在註解中定義屬性時它的型別必須是 8 種基本資料型別外加 類、介面、註解及它們的陣列。
註解中屬性可以有預設值，預設值需要用 default 關鍵值指定。比如：
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
public int id() default -1;
public String msg() default "Hi";
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
TestAnnotation 中 id 屬性預設值為 -1，msg 屬性預設值為 Hi。
它可以這樣應用。
@TestAnnotation()
public class Test {}- 1
- 2
因為有預設值，所以無需要再在 @TestAnnotation 後面的括號裡面進行賦值了，這一步可以省略。
另外，還有一種情況。如果一個註解內僅僅只有一個名字為 value 的屬性時，應用這個註解時可以直接接屬性值填寫到括號內。
public @interface Check {
String value();
}- 1
- 2
- 3
上面程式碼中，Check 這個註解只有 value 這個屬性。所以可以這樣應用。
@Check("hi")
int a;- 1
- 2
這和下面的效果是一樣的
@Check(value="hi")
int a;- 1
- 2
最後，還需要注意的一種情況是一個註解沒有任何屬性。比如
public @interface Perform {}
- 1
- 2
那麼在應用這個註解的時候，括號都可以省略。
@Perform
public void testMethod(){}- 1
- 2
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!");
}
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
定義了一個 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();
}- 1
- 2
- 3
- 4
- 5
- 6
@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!
}- 1
- 2
- 3
- 4
- 5
- 6
- 7
上面的程式碼中，編譯階段不會報錯，但是執行時會丟擲 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();
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
我們進行執行緒開發中常用的 Runnable 就是一個典型的函式式介面，上面原始碼可以看到它就被 @FunctionalInterface 註解。
可能有人會疑惑，函式式介面標記有什麼用，這個原因是函式式介面可以很容易轉換為 Lambda 表示式。這是另外的主題了，有興趣的同學請自己搜尋相關知識點學習。
註解的提取
博文前面的部分講了註解的基本語法，現在是時候檢測我們所學的內容了。
我通過用標籤來比作註解，前面的內容是講怎麼寫註解，然後貼到哪個地方去，而現在我們要做的工作就是檢閱這些標籤內容。 形象的比喻就是你把這些註解標籤在合適的時候撕下來，然後檢閱上面的內容資訊。
要想正確檢閱註解，離不開一個手段，那就是反射。
註解與反射。
註解通過反射獲取。首先可以通過 Class 物件的 isAnnotationPresent() 方法判斷它是否應用了某個註解
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}
- 1
- 2
然後通過 getAnnotation() 方法來獲取 Annotation 物件。
public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}
- 1
- 2
或者是 getAnnotations() 方法。
public Annotation[] getAnnotations() {}- 1
- 2
前一種方法返回指定型別的註解，後一種方法返回註解到這個元素上的所有註解。
如果獲取到的 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());
}
}
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
程式的執行結果是：
id:-1
msg:
- 1
- 2
- 3
這個正是 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());
}
}
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56