(SUB)Spring如何自定义注解

什么是注解

_Annontation_是Java5开始引入的新特征，中文名称叫注解。它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。为程序的元素（类、方法、成员变量）加上更直观更明了的说明，这些说明信息是与程序的业务逻辑无关，并且供指定的工具或框架使用。

Annotation是一种应用于类、方法、参数、变量、构造器及包声明中的特殊修饰符。它是一种由JSR-175标准选择用来描述元数据的一种工具。

用途

1、生成文档。这是最常见的，也是java 最早提供的注解。常用的有@param @return 等
2、跟踪代码依赖性，实现替代配置文件功能。比如Dagger 2 依赖注入，未来java 开发，将大量注解配置，具有很大用处;
3、在编译时进行格式检查。如@override 放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出。

为什么要有注解

使用Annotation之前，XML被广泛的应用于描述元数据。大量配置导致XML的维护越来越糟糕了。他们希望使用一些和代码紧耦合的东西，而不是像XML那样和代码是松耦合的(在某些情况下甚至是完全分离的)代码描述。XML配置其实就是为了分离代码和配置而引入的。因此两者各有利弊：

假如你想为应用设置很多的常量或参数，这种情况下，XML是一个很好的选择，因为它不会同特定的代码相连。如果你想把某个方法声明为服务，那么使用Annotation会更好一些，因为这种情况下需要注解和方法紧密耦合起来，开发人员也必须认识到这点。

另一个很重要的因素是Annotation定义了一种标准的描述元数据的方式。在这之前，开发人员通常使用他们自己的方式定义元数据。例如，使用标记interfaces，注释，transient关键字等等。每个程序员按照自己的方式定义元数据，而不像Annotation这种标准的方式。

目前，许多框架将XML和Annotation两种方式结合使用，平衡两者之间的利弊。

元注解

java 5.0开始，java.lang.annotation 提供了四种元注解，专门注解其他的注解（在自定义注解的时候，需要使用到元注解）：
   @Documented – 注解是否将包含在JavaDoc中
   @Retention – 什么时候使用该注解
   @Target – 注解用于什么地方
   @Inherited – 是否允许子类继承该注解

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

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

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

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

注解的原理：

举例：

注解：

public @interface Test {
    String value() default "注解";
}

通过idea的查看类继承关系的功能，可以看到@Test继承了Annotation 接口注解处理器(Annotation 可以在jdk包里面找到，它是所有注解的父接口)

注解验证类：

@Test("验证")
public class AnnotationTest {
    psvm() {
        Test test = AnnotionTest.class.getDeclaredAnnotation(Test.class)
        sout(test.value)
    }
}

注解处理器

这个是注解使用的核心了，前面我们说了那么多注解相关的，那到底java是如何去处理这些注解的呢

从getAnnotation进去可以看到java.lang.class实现了AnnotatedElement方法

Test t = AnnotationTest.class.getAnnotation(Test.class);

public final class Class<T> implements java.io.Serializable,
                              GenericDeclaration,
                              Type,
                              AnnotatedElement

java.lang.reflect.AnnotatedElement 接口是所有程序元素（Class、Method和Constructor）的父接口，所以程序通过反射获取了某个类的AnnotatedElement对象之后，程序就可以调用该对象的如下四个个方法来访问Annotation信息：

　　方法1：<T extends Annotation> T getAnnotation(Class<T> annotationClass): 返回改程序元素上存在的、指定类型的注解，如果该类型注解不存在，则返回null。
　　方法2：Annotation[] getAnnotations():返回该程序元素上存在的所有注解。
　    方法3：boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注解，存在则返回true，否则返回false.
　　方法4：Annotation[] getDeclaredAnnotations()：返回直接存在于此元素上的所有注释。与此接口中的其他方法不同，该方法将忽略继承的注释。（如果没有注释直接存在于此元素上，则返回长度为零的一个数组。）该方法的调用者可以随意修改返回的数组；这不会对其他调用者返回的数组产生任何影响

注解本质

调用AnnotationTest.class.getDeclaredAnnotation(Test.class)方法获取到注解的实例，然后调用其实例test.value()方法。

在字节码中 ，可以看到调用的指令为 INVOKEINTERFACE指令，如下因此注解为接口：一个继承自Annotation的接口。 里面每一个属性，其实就是接口的一个抽象方法。

注解何时实例化，如何实例化

通过 AnnotationTest.class.getDeclaredAnnotation(Test.class); 获取实例

返回的实例名称 是$Proxy1, 很明显是一个代理对象。

->
里面还有一个叫AnnotationInvocationHandler的类：

可见实现了InvaocationHandler，通过jdk动态代理获取到代理类实例

->

分析流程
java.lang.Class#getDeclaredAnnotation 第一步 获取注解
java.lang.Class#createAnnotationData 第二步 创建注解实例
sun.reflect.annotation.AnnotationParser#parseAnnotations 第三步 解析注解

这一步有个关键点

方法getRawAnnotations() 获取原始批注 也是native方法。

还有一个方法getConstantPool() 获取常量池 也是native方法

然后经过sun.reflect.annotation.AnnotationParser#parseAnnotation2
这个类的加工转换

因此，注解是将参数信息存储到了class文件的常量池里面，在创建实例的时候，会通过getConstantPool()获取出来，是一个byte[]流，需要进行转换。

->

创建实例

在sun.reflect.annotation.AnnotationParser#annotationForMap中：

该方法返回的入参， 里面有整个Test这个注解类的信息 ，这一步就获取了注解里面的值，最终存储在memberDefaults 这个hashmap里面。

 在这里 jdk动态代理的newProxyInstance方法返回的代理对象（使用Proxy的newProxyInstance方法，传入接口 和InvocationHandler的一个实例(也就是 AnotationInvocationHandler ) ，最后返回一个实例）

 ->

期间，在创建代理对象之前，解析注解时候 从该注解类的常量池中取出注解的信息，包括之前写到注解中的参数，然后将这些信息在创建 AnnotationInvocationHandler时候 ，传入进去 作为构造函数的参数。

->

 当调用该代理实例的获取值的方法时，就会调用执行AnotationInvocationHandler里面的逻辑，将之前存入的注解信息 取出来。

常见标准的Annotation

Override

      java.lang.Override 是一个标记类型注解，它被用作标注方法。它说明了被标注的方法重载了父类的方法，起到了断言的作用。如果我们使用了这种注解在一个没有覆盖父类方法的方法时，java 编译器将以一个编译错误来警示。

Deprecated

     Deprecated 也是一种标记类型注解。当一个类型或者类型成员使用@Deprecated 修饰的话，编译器将不鼓励使用这个被标注的程序元素。所以使用这种修饰具有一定的“延续性”：如果我们在代码中通过继承或者覆盖的方式使用了这个过时的类型或者成员，虽然继承或者覆盖后的类型或者成员并不是被声明为@Deprecated，但编译器仍然要报警。

SuppressWarnings

     SuppressWarning 不是一个标记类型注解。它有一个类型为String[] 的成员，这个成员的值为被禁止的警告名。对于javac 编译器来讲，被-Xlint 选项有效的警告名也同样对@SuppressWarings 有效，同时编译器忽略掉无法识别的警告名。

自定义注解