Java 注解（Annotation）你能够这样学

时间 2019-12-20

原文原文链接

注解如同标签

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

注解语法

　　由于日常开发少见，相信有很多的人员会认为注解的地位不高。其实同 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 种。app

@Retention

Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间。
它的取值以下：
RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
RetentionPolicy.RUNTIME 注解能够保留到程序运行的时候，它会被加载进入到 JVM 中，因此在程序运行时能够获取到它们。
咱们能够这样的方式来加深理解，@Retention 去给一张标签解释的时候，它指定了这张标签张贴的时间。@Retention 至关于给一张标签上面盖了一张时间戳，时间戳指明了标签张贴的时间周期。框架

@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}

上面的代码中，咱们指定 TestAnnotation 能够在程序运行周期被获取到，所以它的生命周期很是的长。ide

@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

Java 注解 （Annotation）你能够这样学