java processor_Java annotation processor学习

之前没有接触过 Annotation Processor(注解处理器)这个概念，当研究Butterknife框架实现机制时，发现Annotation Processor是Butterknife框架实现机制的核心要点。原来代码本身能生成代码，我之前还停留在程序运行阶段利用反射去读取注解再进行处理的阶段，有了Annotation Processor之后，我们就能在编译时根据注解动态生成代码，执行与注解关联的逻辑，可以有效避免反射的性能问题，非常高大上。

Annotation(注解)分类：

按照运行机制，注解分三类：

源码注解(RetentionPolicy.SOURCE): 注解只在源码中存在，编译成.class文件就不存在了。

编译时注解(RetentionPolicy.CLASS)：注解在.class文件里面存在。

运行时注解(RetentionPolicy.RUNTIME)：在运行阶段还起作用，甚至会影响运行逻辑的注解 。

上面三类中，Annotation Processor处理的对象主要针对 编译时注解

Annotation Processor是什么？

它是一个工具，包含在javac中，Java5之后才有(因为Annotation也是Java5才有的)，但Java6中才有API供使用。

Annotation Processor的作用？

编译时扫描和处理注解(主要是编译时注解)。一个注解的注解处理器，以Java代码(或者编译过的字节码)作为输入，生成文件(一般是.java文件)作为输出。

通过Annotation Processor，我们获取到注解，然后再生成相关Java代码，注意：注解处理器不能更新手写的Java代码，比如在一个类中增加方法。新生成Java代码会与手写的代码一样，会被javac编译。

如何使用Annotation Processor?

第一步：实现处理函数

JDK提供了javax.annotation.processing.AbstractProcessor来处理注解，这是一个抽象类，需要实现其中几个方法。

public synchronized void init(ProcessingEnvironment var1);

它会被注解处理工具调用，并输入ProcessingEnvironment 参数。ProcessingEnvironment 提供很多有用的工具类，比如Elements、Types、Filer等

public Set getSupportedAnnotationTypes();

必须指定，返回值是一个字符串的集合，包含本处理器想要处理的注解类型的合法全称。即你在这里定义你的注解处理器处理哪些注解

public SourceVersion getSupportedSourceVersion();

用来指定使用的Java版本，一般返回 SourceVersion.latestSupported();

public abstract boolean process(Set extends TypeElement> var1, RoundEnvironment var2);

这里实现主要的处理逻辑，利用init函数里得到的工具类Elements、Types、 Filer 等来处理注解，并自动生成代码。

在这里除了可以调用JDK里的api外，还可以使用很多第三方库，因为javac会启动一个完整Java虚拟机来运行注解处理器。

第二步：注册Annotation Processor

实现好AbstractProcessor之后，比如名叫MyProcessor，需要将MyProcessor注册到javac中。首先需要将MyProcessor打包成jar，比如叫MyProcessor.jar，在这个jar中，你需要打包一个特定的文件javax.annotation.processing.Processor到META-INF/services路径下

javax.annotation.processing.Processor这个文件里的内容是我们实现的Annotation Processor的列表,比如：

com.example.MyProcessor1

com.example.MyProcessor2

这说明我们可以实现不止一个Annotation Processor。

最后把MyProcessor.jar放到你的builpath中，javac会自动检查和读取javax.annotation.processing.Processor中的内容，并且注册MyProcessor作为注解处理器。

如何生成META-INF等目录以及javax.annotation.processing.Processor文件？

第一种方式：手工编写生成。

创建resources 源文件夹 、然后在里面创建META-INF/services/javax.annotation.processing.Processor文件，这个文件写处理器的类完整路径。

第二种方式：利用google提供的AutoService注解处理器，等于说我们的注解处理器需要被AutoService注解处理器先进行处理。使用方式(针对Android Studio里的grandle配置)：

1.注解处理器模块的build.gradle文件中引入

compile 'com.google.auto.service:auto-service:1.0-rc2'

2.在public class MyProcessor上面使作注解：@AutoService(Processor.class)

如何将MyProcessor.jar放到builpath中？

需要将Annotation Processor所在的工程单独成一个java标准工程

1.使用android-apt Gradle插件：apply plugin: 'com.neenbedankt.android-apt'

其有两个作用：

a.允许配置只在编译时作为注解处理器的依赖，而不添加到最后的APK或library(因为运行时用不到，没必要增加apk的体积)

b.设置源路径，使注解处理器生成的代码能被Android Studio正确的引用

2.在dependencies里 用apt替代compile来引用处理器模块

apt project(':annotation-comprocesser')

工具类Elements、Types、Filer等的使用

作用：Elements是处理Element的工具类,Element代表程序的元素，例如包、类或者方法，可以理解成源代码;TypeElement代表的是源代码中的类型元素，例如类、域、方法等;从TypeElement中能获取类的名字，但是你获取不到类的信息，例如它的父类，这个需要从TypeMirror获取，而TypeMirror需要调用Element的asType()函数

使用步骤：

在process(Set extends TypeElement> annotations, RoundEnvironment roundEnv)函数中

1.利用roundEnv.getElementsAnnotatedWith(xxx.class)可以得到xxx注解标注的Element集合

Element表示一个程序元素，比如类本身、类的变量、方法等，这个Element集合中将所有类中的元素都列出来了，为了方便生成java代码，需要要将Element集合按照类进行分类，以便生成操作该类的类

2.通过Element的getEnclosingElement()函数，可以获取该元素最外层的元素，比如方法，其肯定属于某个类，故其最外层的元素就是类，此元素用TypeElement表示，再通过TypeElement的getQualifiedName()就能拿到类全名

如果我们只想获取特定类型上的注解元素，比如只想要标准在class上的元素，可以用Element的getKind()函数来获取元素的类型(比如返回ElementKind.CLASS表示该元素是类)来过滤，比如这样：

// 检查被注解为@Factory的元素是否是一个类

if (annotatedElement.getKind() != ElementKind.CLASS) {

...

}

Elements的getPackageOf(Element type)能得到包信息

3.如果我们知道一个Element是ElementKind.CLASS或ElementKind.Field，可以强转成TypeElement，然后用TypeElement的getAnnotation(xxx.class)取出注解的实例信息，这些信息是使用注解时，相当于传入的实参

4.注解所在类拿到了，注解的信息也拿到了，被注解的元素也拿到了，最后我们可以通过这些信息产生新的文件了。

5.生成代码。可以使用第三方库Javapoet来加快生成速度，或者直接使用FileWriter

如果要生成java的源码，需要用到Filer

需要注意的问题

1.注解处理过程是一个有序的循环过程，因为生成的新的文件中也有可能包含需要被处理的注解， 虽然需要经过多轮处理，但不能重载或者重新创建已经生成的源代码，所以最后生成文件后，需要将为了生成文件而保存的缓存清除，避免第二轮又调用process去试图重复生成文件而导致异常

2.为什么要单独将Annotation Processor打包成一个jar，因为Annotation Processor模块只是为了编译，在运行时不需要，为了使最后的程序不过于臃肿，而且apk中.dex文件也有65k个方法的限制，同时Annotation Processor是可以包含其它库的，所以要避免将其打包进去。

3.Annotation Processor是发生在类型擦除(type erasure)之前的，所以它可以做很多复杂的事情