Java 自定義注解&通過反射獲取類、方法、屬性上的注解

反射

JAVA中的反射是運行中的程序檢查自己和軟件運行環境的能力，它可以根據它發現的進行改變。通俗的講就是反射可以在運行時根據指定的類名獲得類的信息。
 

注解的定義

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

1. /**
2. * 自定義注解
3. *
4. * @author wangh
5. *
6. */
7. public @interface TestAnnotation {
8. }

它的形式跟接口很類似，不過前面多了一個 @ 符號。上面的代碼就創建了一個名字為 TestAnnotaion 的注解。

你可以簡單理解為創建了一張名字為 TestAnnotation 的標簽。

注解的應用

上面創建了一個注解，那么注解的的使用方法是什么呢。

1. @TestAnnotation
2. public class Test {
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 相當於給一張標簽上面蓋了一張時間戳，時間戳指明了標簽張貼的時間周期。

1. @ Retention(RetentionPolicy.RUNTIME)
2. public @interface TestAnnotation {
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 注解過的注解進行注解的話，那么如果它的子類沒有被任何注解應用的話，那么這個子類就繼承了超類的注解。 
說的比較抽象。代碼來解釋。

1. @Inherited
2. @Retention(RetentionPolicy.RUNTIME)
3. @interface Test {}
4.  
5.  
6. @Test
7. public class A {}
8.  
9.  
10. public class B extends A {}

注解 Test 被 @Inherited 修飾，之后類 A 被 Test 注解，類 B 繼承 A,類 B 也擁有 Test 這個注解。

可以這樣理解：

老子非常貧窮，所以人們給他貼了一張標簽叫做窮人。

老子的兒子長大后，只要沒有和老子斷絕父子關系，雖然別人沒有給他貼標簽，但是他自然也是窮人。

老子的孫子長大了，自然也是窮人。

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

@Repeatable

Repeatable 自然是可重復的意思。@Repeatable 是 Java 1.8 才加進來的，所以算是一個新的特性。

什么樣的注解會多次應用呢？通常是注解的值可以同時取多個。

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

1. @interface Persons {
2. Person[] value();
3. }
4.  
5.  
6. @Repeatable(Persons.class)
7. @interface Person{
8. String role default "";
9. }
10.  
11.  
12. @Person(role="artist")
13. @Person(role="coder")
14. @Person(role="PM")
15. public class SuperMan{
16.  
17. }

注意上面的代碼，@Repeatable 注解了 Person。而 @Repeatable 后面括號中的類相當於一個容器注解。

什么是容器注解呢？就是用來存放其它注解的地方。它本身也是一個注解。

我們再看看代碼中的相關容器注解。

1. @ interface Persons {
2. Person[] value();
3. }

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

如果不好理解的話，可以這樣理解。Persons 是一張總的標簽，上面貼滿了 Person 這種同類型但內容不一樣的標簽。把 Persons 給一個 SuperMan 貼上，相當於同時給他貼了程序員、產品經理、畫家的標簽。

我們可能對於 @Person(role=”PM”) 括號里面的內容感興趣，它其實就是給 Person 這個注解的 role 屬性賦值為 PM ，大家不明白正常，馬上就講到注解的屬性這一塊。

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

1. @Target(ElementType.TYPE)
2. @Retention(RetentionPolicy.RUNTIME)
3. public @interface TestAnnotation {
4.  
5. int id();
6.  
7. String msg();
8.  
9. }

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

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

1. @TestAnnotation(id=3,msg="hello annotation")
2. public class Test {
3.  
4. }

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

注解中屬性可以有默認值，默認值需要用 default 關鍵值指定。比如：

1. @Target(ElementType.TYPE)
2. @Retention(RetentionPolicy.RUNTIME)
3. public @interface TestAnnotation {
4.  
5. public int id() default -1;
6.  
7. public String msg() default "Hi";
8.  
9. }

TestAnnotation 中 id 屬性默認值為 -1，msg 屬性默認值為 Hi。 
它可以這樣應用。

1. @TestAnnotation()
2. public class Test {}

因為有默認值，所以無需要再在 @TestAnnotation 后面的括號里面進行賦值了，這一步可以省略。

另外，還有一種情況。如果一個注解內僅僅只有一個名字為 value 的屬性時，應用這個注解時可以直接接屬性值填寫到括號內。

1. public @interface Check {
2. String value();
3. }

上面代碼中，Check 這個注解只有 value 這個屬性。所以可以這樣應用。

1. @ Check("hi")
2. int a;

這和下面的效果是一樣的

1. @ Check(value="hi")
2. int a;

最后，還需要注意的一種情況是一個注解沒有任何屬性。比如

public @interface Perform {}

那么在應用這個注解的時候，括號都可以省略。

1. @Perform
2. public void testMethod(){}

Java 預置的注解

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

@Deprecated
這個元素是用來標記過時的元素，想必大家在日常開發中經常碰到。編譯器在編譯階段遇到這個注解時會發出提醒警告，告訴開發者正在調用一個過時的元素比如過時的方法、過時的類、過時的成員變量。

1. public class Hero {
2.  
3. @ Deprecated
4. public void say(){
5. System. out.println("Noting has to say!");
6. }
7.  
8.  
9. public void speak(){
10. System. out.println("I have a dream!");
11. }
12.  
13.  
14. }

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

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

@Override

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

@SuppressWarnings

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

1. @SuppressWarnings("deprecation")
2. public void test1(){
3. Hero hero = new Hero();
4. hero.say();
5. hero.speak();
6. }

@SafeVarargs

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

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

上面的代碼中，編譯階段不會報錯，但是運行時會拋出 ClassCastException 這個異常，所以它雖然告訴開發者要妥善處理，但是開發者自己還是搞砸了。

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

@FunctionalInterface

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

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

比如

1. @FunctionalInterface
2. public interface Runnable {
3. /**
4. * When an object implementing interface <code>Runnable</code> is used
5. * to create a thread, starting the thread causes the object's
6. * <code>run</code> method to be called in that separately executing
7. * thread.
8. * <p>
9. * The general contract of the method <code>run</code> is that it may
10. * take any action whatsoever.
11. *
12. * @see java.lang.Thread#run()
13. */
14. public abstract void run();
15. }

我們進行線程開發中常用的 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，則就可以調用它們的屬性方法了。比如

1. @TestAnnotation()
2. public class Test {
3.  
4. public static void main(String[] args) {
5.  
6. boolean hasAnnotation = Test. class.isAnnotationPresent(TestAnnotation.class);
7.  
8. if ( hasAnnotation ) {
9. TestAnnotation testAnnotation = Test. class.getAnnotation(TestAnnotation.class);
10.  
11. System. out.println("id:"+testAnnotation.id());
12. System. out.println("msg:"+testAnnotation.msg());
13. }
14.  
15. }
16.  
17. }

程序的運行結果是：

1. id:-1
2. msg:

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

上面的例子中，只是檢閱出了注解在類上的注解，其實屬性、方法上的注解照樣是可以的。同樣還是要假手於反射。

1. @TestAnnotation(msg="hello")
2. public class Test {
3.  
4. @Check(value="hi")
5. int a;
6.  
7.  
8. @Perform
9. public void testMethod(){}
10.  
11.  
12. @SuppressWarnings("deprecation")
13. public void test1(){
14. Hero hero = new Hero();
15. hero.say();
16. hero.speak();
17. }
18.  
19.  
20. public static void main(String[] args) {
21.  
22. boolean hasAnnotation = Test. class.isAnnotationPresent(TestAnnotation.class);
23.  
24. if ( hasAnnotation ) {
25. TestAnnotation testAnnotation = Test. class.getAnnotation(TestAnnotation.class);
26. //獲取類的注解
27. System. out.println("id:"+testAnnotation.id());
28. System. out.println("msg:"+testAnnotation.msg());
29. }
30.  
31.  
32. try {
33. Field a = Test. class.getDeclaredField("a");
34. a.setAccessible( true);
35. //獲取一個成員變量上的注解
36. Check check = a.getAnnotation(Check. class);
37.  
38. if ( check != null ) {
39. System. out.println("check value:"+check.value());
40. }
41.  
42. Method testMethod = Test. class.getDeclaredMethod("testMethod");
43.  
44. if ( testMethod != null ) {
45. // 獲取方法中的注解
46. Annotation[] ans = testMethod.getAnnotations();
47. for( int i = 0;i < ans.length;i++) {
48. System. out.println("method testMethod annotation:"+ans[i].annotationType().getSimpleName());
49. }
50. }
51. } catch (NoSuchFieldException e) {
52. // TODO Auto-generated catch block
53. e.printStackTrace();
54. System. out.println(e.getMessage());
55. } catch (SecurityException e) {
56. // TODO Auto-generated catch block
57. e.printStackTrace();
58. System. out.println(e.getMessage());
59. } catch (NoSuchMethodException e) {
60. // TODO Auto-generated catch block
61. e.printStackTrace();
62. System. out.println(e.getMessage());
63. }
64.  
65.  
66.  
67. }
68.  
69. }

它們的結果如下：

1. id:-1
2. msg:hello
3. check value:hi
4. method testMethod annotation:Perform

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

注解的使用場景

注解是一系列元數據，它提供數據用來解釋程序代碼，但是注解並非是所解釋的代碼本身的一部分。注解對於代碼的運行效果沒有直接影響。

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

值得注意的是，注解不是代碼本身的一部分。

如果難於理解，可以這樣看。羅永浩還是羅永浩，不會因為某些人對於他“傻x”的評價而改變，標簽只是某些人對於其他事物的評價，但是標簽不會改變事物本身，標簽只是特定人群的手段。所以，注解同樣無法改變代碼本身，注解只是某些工具的的工具。

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

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

現在，我們可以給自己答案了，注解有什么用？給誰用？給 編譯器或者 APT 用的。

如果，你還是沒有搞清楚的話，我親自寫一個好了。

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

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

—— 程序員 A : 我寫了一個類，它的名字叫做 NoBug，因為它所有的方法都沒有錯誤。 
—— 我：自信是好事，不過為了防止意外，讓我測試一下如何？ 
—— 程序員 A: 怎么測試？ 
—— 我：把你寫的代碼的方法都加上 @Jiecha 這個注解就好了。 
—— 程序員 A: 好的。

NoBug.java

1. package ceshi;
2. import ceshi.Jiecha;
3.  
4.  
5. public class NoBug {
6.  
7. @Jiecha
8. public void suanShu(){
9. System.out.println( "1234567890");
10. }
11. @Jiecha
12. public void jiafa(){
13. System.out.println( "1+1="+1+1);
14. }
15. @Jiecha
16. public void jiefa(){
17. System.out.println( "1-1="+(1-1));
18. }
19. @Jiecha
20. public void chengfa(){
21. System.out.println( "3 x 5="+ 3*5);
22. }
23. @Jiecha
24. public void chufa(){
25. System.out.println( "6 / 0="+ 6 / 0);
26. }
27.  
28. public void ziwojieshao(){
29. System.out.println( "我寫的程序沒有 bug!");
30. }
31.  
32. }

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

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

1. package ceshi;
2.  
3. import java.lang.annotation.Retention;
4. import java.lang.annotation.RetentionPolicy;
5.  
6. @ Retention(RetentionPolicy.RUNTIME)
7. public @interface Jiecha {
8.  
9. }

然后，我再編寫一個測試類 TestTool 就可以測試 NoBug 相應的方法了。

1. package ceshi;
2.  
3. import java.lang.reflect.InvocationTargetException;
4. import java.lang.reflect.Method;
5.  
6.  
7.  
8. public class TestTool {
9.  
10. public static void main(String[] args) {
11. // TODO Auto-generated method stub
12.  
13. NoBug testobj = new NoBug();
14.  
15. Class clazz = testobj.getClass();
16.  
17. Method[] method = clazz.getDeclaredMethods();
18. //用來記錄測試產生的 log 信息
19. StringBuilder log = new StringBuilder();
20. // 記錄異常的次數
21. int errornum = 0;
22.  
23. for ( Method m: method ) {
24. // 只有被 @Jiecha 標注過的方法才進行測試
25. if ( m.isAnnotationPresent( Jiecha.class )) {
26. try {
27. m.setAccessible( true);
28. m.invoke(testobj, null);
29.  
30. } catch (Exception e) {
31. // TODO Auto-generated catch block
32. //e.printStackTrace();
33. errornum++;
34. log.append(m.getName());
35. log.append(" ");
36. log.append("has error:");
37. log.append("\n\r caused by ");
38. //記錄測試過程中，發生的異常的名稱
39. log.append(e.getCause().getClass().getSimpleName());
40. log.append("\n\r");
41. //記錄測試過程中，發生的異常的具體信息
42. log.append(e.getCause().getMessage());
43. log.append("\n\r");
44. }
45. }
46. }
47.  
48.  
49. log.append(clazz.getSimpleName());
50. log.append(" has ");
51. log.append(errornum);
52. log.append(" error.");
53.  
54. // 生成測試報告
55. System.out.println( log.toString());
56.  
57. }
58.  
59. }

測試結果是：

1. 1234567890
2. 1+1=11
3. 1-1=0
4. 3 x 5=15
5. chufa has error:
6.  
7. caused by ArithmeticException
8.  
9. / by zero
10.  
11. NoBug has 1 error.

1. 提示 NoBug 類中的 chufa() 這個方法有異常，這個異常名稱叫做 ArithmeticException，原因是運算過程中進行了除 0 的操作。
2.  
3. 所以，NoBug 這個類有 Bug。
4.  
5. 這樣，通過注解我完成了我自己的目的，那就是對別人的代碼進行測試。
6.  
7. 所以，再問我注解什么時候用？我只能告訴你，這取決於你想利用它干什么用。

總結

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

demo

https://download.csdn.net/download/qq_28016751/10756012