【Java】Java学习 =＞【注解】

简介

Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。注解是元数据的一种形式，提供有关于程序但不属于程序本身的数据。注解对它们注解的代码的操作没有直接影响。

注解声明

Java中所有的注解，默认实现 Annotation 接口：

package java.lang.annotation;
public interface Annotation {
    
    

    boolean equals(Object obj);
    
    int hashCode();
    
    String toString();
    
    Class<? extends Annotation> annotationType();
}

与声明一个"Class"不同的是，注解的声明使用@interface关键字。一个注解的声明如下：

public @interface MyInerface{
    
    
}

元注解

在定义注解时，注解类也能够使用其他的注解声明。对注解类型进行注解的注解类，我们称之为 metaannotation（元注解）。元注解一共有4个。
一般的，我们在定义自定义注解时，需要指定的元注解有两个：

@Documented
用于被javadoc工具提取成文档，

@Inherited
表示允许子类继承父类中定义的注解。

@Target
标记另一个注解，以限制可以应用注解的 Java 元素类型。目标注解指定以下元素类型之一作为其值：

ElementType.ANNOTATION_TYPE 可以应用于注解类型。
ElementType.CONSTRUCTOR 可以应用于构造函数。
ElementType.FIELD 可以应用于字段或属性。
ElementType.LOCAL_VARIABLE 可以应用于局部变量。
ElementType.METHOD 可以应用于方法级注解。
ElementType.PACKAGE 可以应用于包声明。
ElementType.PARAMETER 可以应用于方法的参数。
ElementType.TYPE 可以应用于类的任何元素。

@Retention
指定标记注解的存储方式：

RetentionPolicy.SOURCE 标记的注解仅保留在源级别中，并被编译器忽略。
RetentionPolicy.CLASS 标记的注解在编译时由编译器保留，但 Java 虚拟机(JVM)会忽略。
RetentionPolicy.RUNTIME 标记的注解由 JVM 保留，因此运行时环境可以使用它。

//@Target(ElementType.TYPE) 只能在类上标记该注解
@Target({
    
    ElementType.TYPE,ElementType.FIELD}) // 允许在类与类属性上标记该注解
@Retention(RetentionPolicy.SOURCE) //注解保留在源码中
public @interface MyInerface{
    
    

}

注解时传递参数

在上文元注解中，允许在使用注解时传递参数。我们也能让自定义注解的主体包含 annotation type element (注解类型元素) 声明，它们看起来很像方法，可以定义可选的默认值。

@Target({
    
    ElementType.TYPE,ElementType.FIELD})
@Retention(RetentionPolicy.SOURCE)
public @interface MyInerface{
    
    

    String value(); //无默认值
    
    int age() default 1; //有默认值
    
}

注意：在使用注解时，如果定义的注解中的类型元素无默认值，则必须进行传值。

@MyInerface("啊啊啊啊啊啊") //如果只存在value元素需要传值的情况，则可以省略:元素名=
@MyInerface(value="啊啊啊啊啊啊",age = 114514)
int i;

注解应用场景

按照@Retention 元注解定义的注解存储方式，注解可以被在三种场景下使用：

SOURCE

RetentionPolicy.SOURCE ，作用于源码级别的注解，可提供给IDE语法检查、APT等场景使用。
在类中使用 SOURCE 级别的注解，其编译之后的class中会被丢弃。

CLASS
定义为 CLASS 的注解，会保留在class文件中，但是会被虚拟机忽略(即无法在运行期反射获取注解)。此时完全符合此种注解的应用场景为字节码操作。如：AspectJ、热修复Roubust中应用此场景。

RUNTIME
注解保留至运行期，意味着我们能够在运行期间结合反射技术获取注解中的所有信息。

APT注解处理器

APT全称为：“Anotation Processor Tools”，意为注解处理器。顾名思义，其用于处理注解。编写好的Java源文件，需要经过 javac 的编译，翻译为虚拟机能够加载解析的字节码Class文件。注解处理器是 javac 自带的一个工具，用来在编译时期扫描处理注解信息。你可以为某些注解注册自己的注解处理器。 注册的注解处理器由 javac调起，并将注解信息传递给注解处理器进行处理。
注解处理器是对注解应用最为广泛的场景。在Glide、EventBus3、Butterknifer、Tinker、ARouter等等常用框架中都有注解处理器的身影。但是这些框架中对注解的定义并不是SOURCE 级别，更多的是 CLASS 级别。