Java 注解

2021-01-05 本文已影响0人 wuchao226

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

了解注解前先看看元数据的概念

1.元数据概念

元数据是关于数据的数据。在编程语言上下文中，元数据是添加到程序元素如方法、字段、类和包上的额外信息。对数据进行说明描述的数据。

2.元数据的作用

一般来说，元数据可以用于创建文档（根据程序元素上的注释创建文档），跟踪代码中的依赖性（可声明方法是重载，依赖父类的方法），执行编译时检查（可声明是否编译期检测），代码分析。
如下：
1）编写文档：通过代码里标识的元数据生成文档　　
2）代码分析：通过代码里标识的元数据对代码进行分析　　
3）编译检查：通过代码里标识的元数据让编译器能实现基本的编译检查

关于注解（Annotation）的作用，其实就是上述元数据的作用。

注意：Annotation 能被用来为程序元素（类、方法、成员变量等）设置元素据。Annotaion 不影响程序代码的执行，无论增加、删除 Annotation，代码都始终如一地执行。如果希望让程序中的 Annotation 起一定的作用，只有通过解析工具或编译工具对 Annotation 中的信息进行解析和处理。

注解声明

声明一个注解类型

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 Study{ }

元注解

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

另外还有 @Documented 与 @Inherited 元注解，前者用于被 javadoc 工具提取成文档，后者表示允许子类继承父类中定义的注解。

1. @Target

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

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

2. @Retention

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

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

@Retention 三个值中 SOURCE < CLASS < RUNTIME，即 CLASS 包含了SOURCE，RUNTIME 包含 SOURCE、CLASS。下文会介绍他们不同的应用场景。

例子：

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

注解类型元素

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

@Target({ElementType.TYPE,ElementType.FIELD}) 
@Retention(RetentionPolicy.SOURCE) 
public @interface Study { 
    String value(); // 无默认值 
    int age() default 1; // 有默认值 
}

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

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

注解应用场景

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

1. SOURCE

RetentionPolicy.SOURCE ，作用于源码级别的注解，可提供给 IDE 语法检查、APT 等场景使用。

在类中使用 SOURCE 级别的注解，其编译之后的 class 中会被丢弃。

IDE语法检查
在 Android 开发中， support-annotations 与 androidx.annotation) 中均有提供 @IntDef 注解，此注解的定义如下：

@Retention(SOURCE) //源码级别注解 
@Target({ANNOTATION_TYPE}) 
public @interface IntDef { 
    int[] value() default {}; 
    boolean flag() default false;
    boolean open() default false; 
}

Java 中 Enum(枚举)的实质是特殊单例的静态成员变量，在运行期所有枚举类作为单例，全部加载到内存中。比常量多5到10倍的内存占用。

此注解的意义在于能够取代枚举，实现如方法入参限制。

如：我们定义方法 test ，此方法接收参数 teacher 需要在：Lance、Alvin 中选择一个。如果使用枚举能够实现为:

public enum Teacher{ 
    LANCE,
    ALVIN 
}
public void test(Teacher teacher) {
}

而现在为了进行内存优化，我们现在不再使用枚举，则方法定义为：

public static final int LANCE = 1;
public static final int ALVIN = 2;
public void test(int teacher) {
}

然而此时，调用 test 方法由于采用基本数据类型 int，将无法进行类型限定。此时使用 @IntDef 增加自定义注解：

public static final int LANCE = 1; 
public static final int ALVIN = 2; 

@IntDef(value = {LANCE, ALVIN}) //限定为LANCE，ALVIN 
@Target(ElementType.PARAMETER) //作用于参数的注解
@Retention(RetentionPolicy.SOURCE) //源码级别注解
public @interface Teacher { 

}

public void test(@Teacher int teacher) {
 
}

此时，我们再去调用 test 方法，如果传递的参数不是 LANCE 或者 ALVIN 则会显示 Inspection 警告(编译不会报错)。

可以修改此类语法检查级别：

以上注解均为 SOURCE 级别，本身 IDEA/AS 就是由Java开发的，工具实现了对Java语法的检查，借助注解能对被注解的特定语法进行额外检查。

APT注解处理器

APT全称为："Anotation Processor Tools"，意为注解处理器。顾名思义，其用于处理注解。编写好的 Java 源文件，需要经过 javac 的编译，翻译为虚拟机能够加载解析的字节码 Class 文件。注解处理器是 javac 自带的一个工具，用来在编译时期扫描处理注解信息。你可以为某些注解注册自己的注解处理器。注册的注解处理器由 javac 调起，并将注解信息传递给注解处理器进行处理。

注解处理器是对注解应用最为广泛的场景。在 Glide、EventBus3、Butterknifer、Tinker、ARouter 等等常用框架中都有注解处理器的身影。这些框架中对注解的定义并不是 SOURCE 级别，更多的是 CLASS 级别，别忘了：CLASS 包含了 SOURCE，RUNTIME 包含 SOURCE、CLASS。

`注解处理器中process方法为什么会执行多次？`

// 注解处理器：
@Override
public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {

    Messager messager = processingEnv.getMessager();
    messager.printMessage(Diagnostic.Kind.NOTE,"oooooooooooo"+"1111111111111111111"+System.currentTimeMillis());
    return true;
}

java编译过程:词法分析、语法分析、填充符号表、注解处理器处理注解、语义分析、解语法糖、生成字节码。

注解处理器可以增删改抽象语法树的任意元素。执行到注解处理器，都会重新执行词法分析、语法分析、填充符号表步，直到注解处理器不再对语法树进行修改为止，每一次的循环过程都称为一次Round。

process第一个参数set集合是要处理的注解集合，如果这个集合为null了，就不需要处理了。写代码就这样去做。
if(!set.isEmpty()){
//…执行处理
}
apt自身的功能很简单，就起到一个触发器的作用。

2. CLASS

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

所谓字节码操作即为，直接修改字节码 Class 文件以达到修改代码执行逻辑的目的。在程序中有多处需要进行是否登录的判断。

如果我们使用普通的编程方式，需要在代码中进行 if-else 的判断，也许存在十个判断点，则需要在每个判断点加入此项判断。此时，我们可以借助AOP(面向切面)编程思想，将程序中所有功能点划分为：需要登录与无需登录两种类型，即两个切面。对于切面的区分即可采用注解。

//Java源码 
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.CLASS) 
public @interface Login { 
}

@Login 
public void jumpA(){ 
  startActivity(new Intent(this,AActivity.class)); 
}

public void jumpB(){ 
  startActivity(new Intent(this,BActivity.class));
}

在上诉代码中， jumpA 方法需要具备登录身份。而 Login 注解的定义被设置为 CLASS 。因此我们能够在该类所编译的字节码中获得到方法注解 Login 。在操作字节码时，就能够根据方法是否具备该注解来修改class中该方法的内容加入 if-else 的代码段：

//Class字节码 
@Login 
public void jumpA() { 
  if (this.isLogin) { 
     this.startActivity(new Intent(this, LoginActivity.class)); 
  } else { 
     this.startActivity(new Intent(this, AActivity.class));
  } 
}

public void jumpB() { 
  startActivity(new Intent(this,BActivity.class)); 
}

注解能够设置类型元素(参数)，结合参数能实现更为丰富的场景，如：运行期权限判定等。

字节码增强技术相当于是一把打开运行时JVM的钥匙，利用它可以动态地对运行中的程序做修改，也可以跟踪JVM运行中程序的状态。此外，我们平时使用的动态代理、AOP也与字节码增强密切相关，它们实质上还是利用各种手段生成或修改符合规范的字节码文件。综上所述，掌握字节码增强后可以高效地定位并快速修复一些棘手的问题（如线上性能问题、方法出现不可控的出入参需要紧急加日志等问题），也可以在开发中减少冗余代码，大大提高开发效率。
字节码增强技术探索

3. RUNTIME

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