Android开发之注解与反射的应用

注解

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

注解声明

声明一个注解类型

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

package java.lang.annotation;

public interface Annotation {
    boolean equals(Object var1);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

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

public @interface brett{//自定义注解好像要用小写字母，大写字母编译会报错

}

元注解

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

@Target

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

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

@Retention

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

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

@Retention 三个值中 SOURCE < CLASS < RUNTIME，即CLASS包含了SOURCE，RUNTIME包含SOURCE、CLASS。
另外还有@Documented 与 @Inherited 元注解，前者用于被javadoc工具提取成文档，后者表示允许子类继承父类中定义的注解。

package com.brett.myapplication;

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

/**
 * @author dell
 */
@Documented //被javadoc工具提取成文档
@Inherited //允许子类继承父类中定义的注解
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface brett{

}

注解类型元素

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

@Documented
@Inherited
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface brett{
    String name(); //无默认值
    int age() default  0; //有默认值
}
//注意：在使用注解时，如果定义的注解中的类型元素无默认值，在使用该注解时则必须进行传值。

注解应用场景

SOURCE

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


可以明显地看出，编译成class文件之后，brett注解没有了。

在Android开发中， support-annotations 与 androidx.annotation 中均有提供 @IntDef、@DrawableResId 等注解，此注解的定义如下：

@Retention(SOURCE)
@Target({ANNOTATION_TYPE})
public @interface IntDef {
    /** Defines the allowed constants for this element */
    int[] value() default {};

    /** Defines whether the constants can be used as a flag, or just as an enum (the default) */
    boolean flag() default false;

    /**
     * Whether any other values are allowed. Normally this is
     * not the case, but this allows you to specify a set of
     * expected constants, which helps code completion in the IDE
     * and documentation generation and so on, but without
     * flagging compilation warnings if other values are specified.
     */
    boolean open() default false;
}

Java中Enum(枚举)的实质是特殊单例的静态成员变量，在运行期所有枚举类作为单例，全部加载到内存中。比常量多5到10倍的内存占用。
此注解的意义在于能够取代枚举，实现如方法入参限制。
如：我们定义方法 test ，此方法接收参数 teacher 需要在：Lance、Alvin中选择一个。如果使用枚举能够实现为:

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

    }

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

public static final int A = 1;
public static final int B = 2;
public void test(int teacher) {
}

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

public static final int A = 1;
public static final int B = 2;
@IntDef(value = {A, B}) //限定为A，B
@Target(ElementType.PARAMETER) //作用于参数的注解
@Retention(RetentionPolicy.SOURCE) //源码级别注解
public @interface Teacher {
}
public void test(@Teacher int teacher) {
}

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

APT注解处理器
APT全称为：“Anotation Processor Tools”，意为注解处理器。顾名思义，其用于处理注解。编写好的Java源文件，需要经过 javac 的编译，翻译为虚拟机能够加载解析的字节码Class文件。注解处理器是 javac 自带的一个工具，用来在编译时期扫描处理注解信息。你可以为某些注解注册自己的注解处理器。 注册的注解处理器由 javac调起，并将注解信息传递给注解处理器进行处理。
APT可以在代码编译期间对注解进行处理，并且生成Java文件，减少手动的代码输入。注解我们平时用到的比较多的可能会是运行时注解，比如大名鼎鼎的retrofit就是用运行时注解，通过动态代理来生成网络请求。

由上图可知，注解处理器有可能会被执行多次，这是为什么呢？
因为java编译过程:词法分析、语法分析、填充符号表、注解处理器处理注解、语义分析、解语法糖、生成字节码。
注解处理器可以增删改抽象语法树的任意元素。执行到注解处理器，都会重新执行词法分析、语法分析、填充符号表步，直到注解处理器不再对语法树进行修改为止，每一次的循环过程都称为一次Round。
process方法第一个参数set集合是要处理的注解集合，如果这个集合为null了，就不需要处理了。

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

CLASS

定义为 CLASS的注解，会保留在class文件中，但是会被虚拟机忽略(即无法在运行期反射获取注解)。此时完全符合此种注解的应用场景为字节码操作。如：AspectJ、热修复Roubust中应用此场景。
所谓字节码操作即为，直接修改字节码Class文件以达到修改代码执行逻辑的目的。在程序中有多处需要进行是否登录的判断。
如果我们使用普通的编程方式，需要在代码中进行 if-else 的判断，也许存在十个判断点，则需要在每个判断点加入此项判断。此时，我们可以借助AOP(面向切面)编程思想，将程序中所有功能点划分为： 需要登录 与 无需登录
两种类型，即两个切面。对于切面的区分即可采用注解。

RUNTIME

注解保留至运行期，意味着我们能够在运行期间结合反射技术获取注解中的所有信息,从而完成不同的逻辑判定。
可以参考此案例:反射+注解+动态代理综合使用