Android组件化系列之编译期注解手写注解、注解处理器、及注解工作流程

前言

为了熟悉组件化通信内部的实现原理，最终完成手写组件化通信，今天我们就需要了解注解、注解处理器他们是如何工作的，因为组件化通信就是利用注解和注解处理器帮助我们完成路由表、路由信息等代码的生成工作。简单说，注解就是一个标记，用来告诉注解处理器凡是用我这个注解标记过的类/属性/方法，这些地方是需要你来帮我做一些事情的，例如生成一些代码。举个通俗的例子，例如流水线上有一些残次品的手机，这时我可以给这些有着不同缺陷的手机分别贴上标签（注解），有的贴上屏幕划伤的标签、有的贴上无法开机的标签、有的贴上手机异常发热的标签等等各类标签（注解），那么我们工程师（注解处理器）就可以针对这些不同的标签，做一些特殊处理、加工。

参考博客：https://www.jianshu.com/p/7af58e8e3e18

https://blog.csdn.net/binbinqq86/article/details/79610980

介绍

APT(Annotation Processing Tool)即注解处理器，是一种处理注解的工具，确切的说它是javac的一个工具，它用来在编译时扫描和处理注解。注解处理器以Java代码(或者编译过的字节码)作为输入，生成.java文件作为输出。简单来说就是在编译期，通过注解生成.java文件。

注解的特性

• 注解方法不能带有参数；

• 注解方法返回值类型限定为：基本类型、String、Enums、Annotation或者是这些类型的数组；

• 注解方法可以有默认值；

• 注解本身能够包含元注解，元注解被用来注解其它注解。

作用

使用APT的优点就是方便、简单，可以少写很多重复的代码。用过ButterKnife、Dagger、EventBus等注解框架的同学就能感受到，利用这些框架可以少写很多代码，只要写一些注解就可以了。其实，他们不过是通过注解，生成了一些代码。

目标

通过APT实现一个功能，通过对View变量的注解，实现View的绑定（类似于ButterKnife中的@BindView）

创建项目

• 创建Android Module命名为app 依赖 下面三个module

• 创建Java library Module命名为 module_annotation

• 创建Java library Module命名为 module_processor

• 创建Android library Module 命名为module_library依赖 module_annotation、auto-service

结构如下

功能主要分为三个部分

• module_annotation：自定义注解，存放@BindView

• module_processor：注解处理器，根据module_annotation中的注解，在编译期生成xxxActivity_ViewBinding.java代码

• module_library：工具类，调用xxxActivity_ViewBinding.java中的方法，实现View的绑定。

关系如下

一：module_annotation -- 自定义注解

• 创建注解类BindView

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.FIELD)
public @interface BindView {
    int value();
}

• @Retention(RetentionPolicy.CLASS)：表示编译时注解

• @Target(ElementType.FIELD)：表示注解范围为类成员（构造方法、方法、成员变量）

• @Retention： 定义被保留的时间长短 RetentionPoicy.SOURCE、RetentionPoicy.CLASS、RetentionPoicy.RUNTIME

• @Target： 定义所修饰的对象范围 TYPE、FIELD、METHOD、PARAMETER、CONSTRUCTOR、LOCAL_VARIABLE等

这里定义了运行时注解BindView，其中value()用于获取对应View的id。

二：module_processor -- 注解处理器 (重点部分)

（1）在Module中添加依赖

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'com.google.auto.service:auto-service:1.0-rc6'
    annotationProcessor 'com.google.auto.service:auto-service:1.0-rc6'
    implementation 'com.squareup:javapoet:1.10.0'
    implementation project(':module_annotation')
}

auto-service库可以帮我们去生成META-INF等信息。这里重点说明下，需要手动引入annotationProcessor，否则高版本的gradle无法生成META-INF文件，具体可看这篇文章

介绍下依赖库auto-service

在使用注解处理器需要先声明，步骤：

• 需要在 processors 库的 main 目录下新建 resources 资源文件夹；

• 在 resources文件夹下建立 META-INF/services 目录文件夹；

• 在 META-INF/services 目录文件夹下创建 javax.annotation.processing.Processor 文件；

• 在 javax.annotation.processing.Processor 文件写入注解处理器的全称，包括包路径；

这样声明下来也太麻烦了？这就是用引入auto-service的原因。

通过auto-service中的@AutoService可以自动生成AutoService注解处理器是Google开发的，用来生成 META-INF/services/javax.annotation.processing.Processor 文件

（2）创建BindViewProcessor

下面来看具体注解处理器怎么去写，首先就是要继承AbstractProcessor，在类的顶部加入注解：@AutoService(Processor.class)，主要是用来自动生成 META-INF 信息。然后覆盖其中的几个方法，分别是：

• public synchronized void init(ProcessingEnvironment processingEnvironment)

• public SourceVersion getSupportedSourceVersion()

• public Set getSupportedAnnotationTypes()

• public boolean process(Set set, RoundEnvironment roundEnvironment)

其中init方法用来初始化一些变量信息，如下：

• Filer mFileUtils; 跟文件相关的辅助类，生成JavaSourceCode.

• Elements mElementUtils; 跟元素相关的辅助类，帮助我们去获取一些元素相关的信息。

• Messager mMessager; 跟日志相关的辅助类。

@AutoService(Processor.class)
public class BindViewProcessor extends AbstractProcessor {

    private Messager mMessager;
    private Elements mElementUtils;
    private Map mProxyMap = new HashMap();

    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        mMessager = processingEnv.getMessager();
        mElementUtils = processingEnv.getElementUtils();
    }

    @Override
    public Set getSupportedAnnotationTypes() {
        HashSet supportTypes = new LinkedHashSet();
        supportTypes.add(BindView.class.getCanonicalName());
        return supportTypes;
    }

    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }

    @Override
    public boolean process(Set