Java 注解 （Annotation）你可以这样学

注解如同标签

　　初学者可以这样理解注解：想像代码具有生命，注解就是对于代码中某些鲜活个体的贴上去的一张标签。简化来讲，注解如同一张标签。在未开始学习任何注解具体语法而言，你可以把注解看成一张标签。这有助于你快速地理解它的大致作用。如果初学者在学习过程有大脑放空的时候，请不要慌张，对自己说：注解，标签。注解，标签。

注解语法

　　因为平常开发少见，相信有不少的人员会认为注解的地位不高。其实同 classs 和 interface 一样，注解也属于一种类型。它是在 java se 5.0 版本中开始引入的概念。注解的定义
注解通过 @interface关键字进行定义。

1 public @interface testannotation {
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 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。
说的比较抽象。代码来解释。

1 @inherited
2 @retention(retentionpolicy.runtime)
3 @interface test {}
4 @test
5 public class a {}
6 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 后面括号中的类相当于一个容器注解。
什么是容器注解呢？就是用来存放其它注解的地方。它本身也是一个注解。
我们再看看代码中的相关容器注解。

@interface persons {
    person[]  value();
}

 

按照规定，它里面必须要有一个 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="" 形式，多个属性之前用 ，隔开。

@testannotation(id=3,msg="hello annotation")
public class test {

}

 

需要注意的是，在注解中定义属性时它的类型必须是 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。
它可以这样应用。

@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
这个元素是用来标记过时的元素，想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告，告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。

 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 达到目的。

@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) 就是一个具有一个方法的普通接口。
比如

 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 }
程序的运行结果是：
　　id:-1
　　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 }
70 
 它们的结果如下
 id:-1
 msg:hello
 check value:hi
 method testmethod annotation:perform

 

需要注意的是，如果一个注解要在运行时被成功提取，那么 @retention(retentionpolicy.runtime) 是必须的。

注解的使用场景

我相信博文讲到这里大家都很熟悉了注解，但是有不少同学肯定会问，注解到底有什么用呢？
对啊注解到底有什么用？
我们不妨将目光放到 java 官方文档上来。
文章开始的时候，我用标签来类比注解。但标签比喻只是我的手段，而不是目的。为的是让大家在初次学习注解时能够不被那些抽象的新概念搞懵。既然现在，我们已经对注解有所了解，我们不妨再仔细阅读官方最严谨的文档。
注解是一系列元数据，它提供数据用来解释程序代码，但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。
注解有许多用处，主要如下：
提供信息给编译器： 编译器可以利用注解来探测错误和警告信息
编译阶段时的处理： 软件工具可以用来利用注解信息来生成代码、html文档或者做其它相应处理。
运行时的处理： 某些注解可以在程序运行的时候接受代码的提取
值得注意的是，注解不是代码本身的一部分。

如果难于理解，可以这样看。标签只是某些人对于其他事物的评价，但是标签不会改变事物本身，标签只是特定人群的手段。所以，注解同样无法改变代码本身，注解只是某些工具的工具。
还是回到官方文档的解释上，注解主要针对的是编译器和其它工具软件(software tool)。
当开发者使用了annotation 修饰了类、方法、field 等成员之后，这些 annotation 不会自己生效，必须由开发者提供相应的代码来提取并处理 annotation 信息。这些处理提取和处理 annotation 的代码统称为 apt（annotation processing tool)。

现在，我们可以给自己答案了，注解有什么用？给谁用？给 编译器或者 apt 用的。
如果，你还是没有搞清楚的话，我亲自写一个好了。
亲手自定义注解完成某个目的
我要写一个测试框架，测试程序员的代码有无明显的异常。
—— 程序员 a : 我写了一个类，它的名字叫做 nobug，因为它所有的方法都没有错误。
—— 我：自信是好事，不过为了防止意外，让我测试一下如何？
—— 程序员 a: 怎么测试？
—— 我：把你写的代码的方法都加上 @jiecha 这个注解就好了。
—— 程序员 a: 好的。

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

 

上面的代码，有些方法上面运用了 @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 }
　　测试的结果是：
　　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。
这样，通过注解我完成了我自己的目的，那就是对别人的代码进行测试。
所以，再问我注解什么时候用？我只能告诉你，这取决于你想利用它干什么用。

总结
如果注解难于理解，你就把它类同于标签，标签为了解释事物，注解为了解释代码。
注解的基本语法，创建如同接口，但是多了个 @ 符号。
注解的元注解。
注解的属性。
注解主要给编译器及工具类型的软件用的。
注解的提取需要借助于 java 的反射技术，反射比较慢，所以注解使用时也需要谨慎计较时间成本。



原文：https://blog.csdn.net/briblue/article/details/73824058