Java注解详解

Java注解定义

Java注解又称Java标注，是在 JDK5 时引入的新特性，注解（也被称为元数据）。

Java注解它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。

Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。

Java注解应用

1.生成文档这是最常见的，也是java 最早提供的注解;

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

3.跟踪代码依赖性，实现替代配置文件功能，比较常见的是spring 2.5 开始的基于注解配置,作用就是减少配置;

4.在反射的 Class, Method, Field 等函数中，有许多于 Annotation 相关的接口,可以在反射中解析并使用 Annotation。

Java注解分类

1、JAVA自带的标准注解

@Override（标记一个实际上并没有覆写父类的方法时，java 编译器会告警）、

@Deprecated（用于标明被修饰的类或类成员、类方法已经废弃、过时，不建议使用。）

@SuppressWarnings（用于关闭对类、方法、成员编译时产生的特定警告）等，使用这些注解后编译器就会进行检查。用来

2、元注解

元注解是用于定义注解的注解，包括@Retention、@Target、@Inherited（表示自动继承注解类型。 如果注解类型声明中存在 @Inherited 元注解，则注解所修饰类的所有子类都将会继承此注解。）、@Documented（生成文档信息的时候保留注解，对类作辅助说明）、@Repeatable 等。
元注解也是Java自带的标准注解，只不过用于修饰注解，比较特殊。

@Target

用于描述注解的使用范围（即：被描述的注解可以用在什么地方）

@Documented

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.ANNOTATION_TYPE)

public @interface Target {

    ElementType[] value();

}

 ElementType 是一个枚举类型，它定义了被 @Target 修饰的注解可以应用的范围：

Target类型	作用
ElementType.TYPE	应用于类、接口(包括注解类型)、枚举
ElementType.CONSTRUCTOR	应用于构造函数
ElementType.PARAMETER	应用于方法的参数
ElementType.FIELD	应用于字段或属性联网架构
ElementType.METHOD	应用于方法
ElementType.PACKAGE	应用于包
ElementType.LOCAL_VARIABLE	应用于局部变量
ElementType.TYPE_PARAMETER	1.8版本新增，应用于类型变量
ElementType.TYPE_USE	1.8版本新增，应用于任何使用类型的语句中

@Retention

用来定义该注解在哪一个级别可用，在源代码中(SOURCE)、类文件中(CLASS)或者运行时(RUNTIME)。后续将从注解的应用场景把retention拓展一下。

@Documented
@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.ANNOTATION_TYPE)

public @interface Retention {

    RetentionPolicy value();

}

public enum RetentionPolicy {

    //此注解类型的信息只会记录在源文件中，编译时将被编译器丢弃，也就是说
    //不会保存在编译好的类信息中
    SOURCE,

    //编译器将注解记录在类文件中，但不会加载到JVM中。如果一个注解声明没指定范围，则系统
    //默认值就是Class
    CLASS,

    //注解信息会保留在源文件、类文件中，在执行的时也加载到Java的JVM中，因此可以反射性的读取。
    RUNTIME

}

3、自定义注解
用户可以根据自己的需求定义注解。通常用注解代替枚举，枚举类占用内存比较多（12字节头+成员占用的字节  8字节对齐，如果枚举）。

public @interface 注解名称 {
  	public 属性类型 属性名() default 默认值 ;
}

自定义注解的默认值可以省略不写;

自定义默认是公开的, 可以省略public修饰符

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Book {
    String value();
    double price() default 100;
    String[] authors();
}

@Book(value = "动物世界", authors = {"杨阳洋", "朱朱助"})
public class AnnotationDemo {
}

 注解的应用场景

根据注解的保留级别不同，对注解的使用自然存在不同场景。由注解的三个不同保留级别可知，注解作用于源码、字节码与运行时枚举一些案例。

级别	技术	说明
源码RetentionPolicy.SOURCE	IDE语法检查 APT	在编译期能够获取注解与注解声明的类包括类中所有成员信息，一般用于生成额外的辅助类
字节码 RetentionPolicy.CLASS	字节码增强	在编译出Class后，通过修改Class数据以实现修改代码逻辑目的。对于是否需要修改的区分或者修改为不同逻辑的判断可以使用注解。
运行时 RetentionPolicy.RUNTIME	反射	在程序运行期间，通过反射技术动态获取注解与其元素，从而完成不同的逻辑判定。

RetentionPolicy.SOURCE：

IDE语法检查：@ColorRes,@DrawableRes等用于方法传值时类型检查；在实际开发场景时会由于业务需要会定义一些限定范围的注解，用@IntDef限定取值范围

APT（annotation processor tools）：运行在java编译阶段，没有字节码处理或反射需求的话一般注解范围定义成@RetentionPolicy.SOURCE就行了，框架比如arouter（apt+javapoet）、ButterKnife(apt+javapoet)、eventbus(apt)都是用的apt。

.java -》 javac -》.class

采集注解信息-》收集element-》注解处理器

java编译器（javac）将java源码编译成字节码的过程中会去解析源码，采集注解信息，调用注解处理器进行处理。所以只要保存到源码级别

注解处理器是java编译器调起执行，所以创建的时候要创建成java library。

具体用法参考Android APT从入门到实战_lvkaixuan的博客-CSDN博客

但是有一点需要注意 ，注解处理器在gradle版本5.几以上 的注册需要手动注册(5.0以上autoService不兼容，5.0以下可以用AutoService注册)，要像activity在manifest中注册一样，注解处理器（继承abstract Processor）也要注册（main -》resources -》META-INF.services -》javax.annotation.processing.Processor 中添加注解处理器的全类名）

RetentionPolicy.CLASS：

字节码增强主要是ASM字节码插桩，后面开一篇介绍。

RetentionPolicy.RUNTIME：

把注解的保留时定义为RUNTIME级别，就可以通过反射获取注解相关的各种信息，完成不同的实现。

先了解一下注解解析的知识：

与注解解析相关的接口:

Annotation: 注解的顶级接口，注解都是Annotation类型的对象

AnnotatedElement: 注解的元素接口, 该接口定义了与注解解析相关的解析方法

注解的方法如下:

所有反射的类成分Class, Method , Field , Constructor，都实现了AnnotatedElement接口他们都拥有解析注解的能力

方法	说明
getDeclaredAnnotations()	获得当前对象上使用的所有注解，返回注解数组。
getDeclaredAnnotation(Class annotationClass)	根据注解类型获得对应注解对象
isAnnotationPresent(Class annotationClass)	判断当前对象是否使用了指定的注解，如果使用了则返回true，否则false

解析注解的技巧:

注解在哪个成分上，我们就先拿哪个成分对象。

比如注解作用成员方法，则要获得该成员方法对应的Method对象，再来拿上面的注解

比如注解作用在类上，则要该类的Class对象，再来拿上面的注解

比如注解作用在成员变量上，则要获得该成员变量对应的Field对象，再来拿上面的注解

看个注解与反射集合完成View的IOC注入示例吧 

定义个注解，因为要用反射所以保留为runtime

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface InjectView {
    @IdRes int value();
}

编写工具类，过程看注释

public class InjectUtils {

    public static void injectView(Activity activity) {
        Class cls = activity.getClass();

        //获得此类所有的成员
        Field[] declaredFields = cls.getDeclaredFields();
        for (Field filed : declaredFields) {
            //判断属性是否被InjectView注解声明
            if (filed.isAnnotationPresent(InjectView.class)) {
                InjectView injectView = filed.getAnnotation(InjectView.class);
                //获得了注解中设置的id
                int id = injectView.value();
                View view = activity.findViewById(id);
                //反射设置 属性的值
                filed.setAccessible(true);
                //设置访问权限，允许操作private的属性
                try {
                    //反射赋值
                    filed.set(activity, view);
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

使用

public class AnnotationActivity extends AppCompatActivity {
    @InjectView(R.id.tv)
    private TextView tv;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_annotation);
        //使用
        InjectUtils.injectView(this);
    }
}

所以如果有多个控件要fvb是不是省事儿了点。替代了findViewById操作了。

字节码增强的写完再把链接捣腾过来～