神秘的Java注解

Posted 2022-04-07 goodmonth

注解基础知识点

定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

作用分类：

①编写文档：通过代码里标识的元数据生成文档【生成文档doc文档】

② 代码分析：通过代码里标识的元数据对代码进行分析【使用反射】

③编译检查：通过代码里标识的元数据让编译器能够实现基本的编译检查【Override】

 

---

 　　　　

　　　　　　　　　　　　　　　　　　　　　　　　　　　　

 

ˋ( ° ▽、° ) 

  注解语法

其实同 classs 和 interface 一样，注解也属于一种类型。它是在 Java SE 5.0 版本中开始引入的概念。

注解的定义

注解通过 @interface 关键字进行定义。

 

1 public @interface Execute 
2 
3 

它的形式跟接口很类似，不过前面多了一个 @ 符号。上面的代码就创建了一个名字为 Execute的注解。

你可以简单理解为创建了一张名字为 Execute的标签。

注解的应用

@Execute
public class Test 
    

创建一个类 Test,然后在类定义的地方加上 @Execute就可以用 Execute注解这个类了。

你可以简单理解为将 Execute这张标签贴到 Test 这个类上面。

不过，要想注解能够正常工作，还需要介绍一下一个新的概念那就是元注解。

 

元注解

元注解是什么意思呢？

元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，但是它能够应用到其它的注解上面。

如果难于理解的话，你可以这样理解。元注解也是一张标签，但是它是一张特殊的标签，它的作用和目的就是给其他普通的标签进行解释说明的。

元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

@Retention

 Retention字面上是“保留”的意思。它解释说明了这个注解的的存活时间。

它的取值如下：
- RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
- RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
- RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。

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;

最后，还需要注意的一种情况是一个注解没有任何属性。比如

1 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() 方法判断它是否应用了某个注解

1 public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) 

然后通过 getAnnotation() 方法来获取 Annotation 对象。

1 public <A extends Annotation> A getAnnotation(Class<A> annotationClass) 

或者是 getAnnotations() 方法。

1 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) 是必须的。

 

参考

https://blog.csdn.net/shengzhu1/article/details/81271409