Annotation注解原理解析

---

title: Annotation注解原理解析
date: 2021-04-13 09:56:01
tags: Spring

---

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-AR3MaaAl-1619608269643)(https://i.loli.net/2021/04/14/Cs7POcIkXZ5iqpj.jpg)]

最近在看源码的过程中，了解到了各种的注解，也了解到了注解能够给我们带来的方便的体验。但是在学习的过程中，仍然对其中的有些内容不是太理解。

例如：在自定义了一个注解之后，注解底层是如何工作的，它是如何把注解的内容添加到定义的注解的方法中进行执行的。带着这些问题，下面将详细的进行介绍

1.什么是注解？

Annotation是在java5中引入的新的特征，中文名叫做注解。它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。为程序的元素（类、方法、成员变量）加上更直观更明了的说明，这些说明信息是与程序的业务逻辑无关，并且供指定的工具或框架使用。Annontation像一种修饰符一样，应用于包、类型、构造方法、方法、成员变量、参数及本地变量的声明语句中。

2.注解的作用

1、生成文档。这是最常见的，也是java 最早提供的注解。常用的有@param @return 等

2、跟踪代码依赖性，运行时动态处理，获取信息，实现替代配置文件功能。比如Dagger 2 依赖注入，未来java 开发，将大量注解配置，具有很大用处;

3、在编译时进行格式检查。如@override 放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出。

3.自定义注解介绍

1）Annotation 型定义为@interface, 所有的Annotation 会自动继承java.lang.Annotation这一接口,并且不能再去继承别的类或是接口.
2）参数成员只能用public 或默认(default) 这两个访问权修饰
3）参数成员只能用基本类型byte、short、char、int、long、float、double、boolean八种基本数据类型和String、Enum、Class、annotations等数据类型，以及这一些类型的数组.
4）要获取类方法和字段的注解信息，必须通过Java的反射技术来获取 Annotation 对象，因为你除此之外没有别的获取注解对象的方法
5）注解也可以没有定义成员,，不过这样注解就没啥用了

关于自定义注解，主要用到以下的四个元注解：

annotation提供了四种元注解，这四种元注解专门用来注解其他的注解。

@Documented: 注解是否包含在JavaDoc中；

@Retention：什么时候使用该注解；

@Target：注解用于什么地方；

@Inherited：是否允许子类继承该注解；

下面将详细的介绍各自的取值：

1.）@Retention – 定义该注解的生命周期
● RetentionPolicy.SOURCE : 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。
● RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式
● RetentionPolicy.RUNTIME : 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

2.）Target – 表示该注解用于什么地方。默认值为任何元素，表示该注解用于什么地方。可用的ElementType 参数包括
● ElementType.CONSTRUCTOR: 用于描述构造器
● ElementType.FIELD: 成员变量、对象、属性（包括enum实例）
● ElementType.LOCAL_VARIABLE: 用于描述局部变量
● ElementType.METHOD: 用于描述方法
● ElementType.PACKAGE: 用于描述包
● ElementType.PARAMETER: 用于描述参数
● ElementType.TYPE: 用于描述类、接口(包括注解类型) 或enum声明

3.)@Documented – 一个简单的Annotations 标记注解，表示是否将注解信息添加在java 文档中。

4.)@Inherited – 定义该注释和子类的关系
@Inherited 元注解是一个标记注解，@Inherited 阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited 修饰的annotation 类型被用于一个class，则这个annotation 将被用于该class 的子类。

4.自定义注解实现

1.定义一个TestAnnotation的自定义注解。

package com.example.all.ga;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @Author: luokai
 * @Date: 2021/4/13
 */
//作用于方法和字段
@Target(value={ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    String name();
    int age() default 18;
    String[] favour();
}

2.在Test类的字段、方法等地方声明的地方分别使用TestAnnotation注解：

package com.example.all.ga;

/**
 * @Author: luokai
 * @Date: 2021/4/13
 */
@TestAnnotation(name = "Test", age = 20, favour = {"music", "sports"})
public class Test {
    //用于注解字段
    @TestAnnotation(name = "Testfield", age = 20, favour = {"music", "sports"})
    private int testField;

    //用于注解字段
    @TestAnnotation(name = "Testfield", age = 18, favour = {"basketball", "sports"})
    private int testField2;
    //用于注解方法1
    @TestAnnotation(name = "Testmethod", age = 20, favour = {"music", "sports"})
    public void testMethod(){
        System.out.println("testMethod");
    }

    @TestAnnotation(name = "Testmethod", age = 20, favour = {"music", "sports"})
    public void testMethod2(){
        System.out.println("testMethod");
    }

}

3.通过反射的方式提取相关的注解的信息

package com.example.all.ga;

import java.lang.reflect.Field;
import java.lang.reflect.Method;

/**
 * @Author: luokai
 * @Date: 2021/4/13
 */
public class MainTest {
    public static void main(String[] args) {
        //获取当前测试类的class类
        Class<Test> clazz = Test.class;
        //获取当前测试类的所有字段
        Field[] fields = clazz.getDeclaredFields();
        //遍历 数组中的全部字段
        for(Field field : fields){
            //打印测试是否获取到了所有的字段
            System.out.println(field);
            TestAnnotation testannotation = field.getAnnotation(TestAnnotation.class);
            if(testannotation != null){
                System.out.println("field"+field.getName()+"value"+testannotation);
            }

        }
        //获取Test测试类的所有的方法 包括public protect private default
        Method[] methods = clazz.getDeclaredMethods();
        for(Method method : methods){
            System.out.println(method);
            TestAnnotation annotation = method.getAnnotation(TestAnnotation.class);
            if(annotation != null){
                System.out.println("method"+method.getName()+"value"+annotation);
            }
        }



    }
}

/**
测试输出
 * private int com.example.all.ga.Test.testField
 * fieldtestFieldvalue@com.example.all.ga.TestAnnotation(age=20, name=Testfield, favour=[music, sports])
 * private int com.example.all.ga.Test.testField2
 * fieldtestField2value@com.example.all.ga.TestAnnotation(age=18, name=Testfield, favour=[basketball, sports])
 * public void com.example.all.ga.Test.testMethod2()
 * methodtestMethod2value@com.example.all.ga.TestAnnotation(age=20, name=Testmethod, favour=[music, sports])
 * public void com.example.all.ga.Test.testMethod()
 * methodtestMethodvalue@com.example.all.ga.TestAnnotation(age=20, name=Testmethod, favour=[music, sports])
 *
 * Process finished with exit code 0
 */

看到这里，有的人可能会觉得比较清楚它是怎么工作的了，但是可能还有人有疑问，他到底底层是如何实现的呢，其如何通过代理来实现的。

总结：注解本质是一个继承了Annotation的特殊接口，其具体实现类是Java运行时生成的动态代理类。通过代理对象调用自定义注解（接口）的方法，会最终调用AnnotationInvocationHandler的invoke方法。该方法会从memberValues这个Map中索引出对应的值。而memberValues的来源是Java常量池。换成人话就是说，TestAnnotation会在运行时，JVM会以动态代理的方式实例化一个动态代理的对象，然后通过动态代理的对象来调用相应的方法和属性，从而来实现属性值的获取。

对于这一块的详细的介绍，可以参考文章(https://blog.csdn.net/lylwo317/article/details/52163304)，说的比较清楚。

我们下次再见。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-N8iklkXT-1619608269645)(https://i.loli.net/2021/04/14/CWkZPjzVdrbaY4K.jpg)]