annotationProcessor 自动生成代码(下)
annotationProcessor 自动生成代码(下)
摘要
在annotationProcessor 自动生成代码(上)中，我们介绍了如何通过注解和javapoet生成一个简单的HelloWorld.java。AbstractProcessor可以做的事还有很多，我们不可能一一列举。我们最重要的是明白，AbstractProcessor的运行时机、可操作范围和能提供给我们的东西。
运行时机
/**
* The use of this method is obsolete in type processors. The method is
* called during declaration annotation processing phase only.
* It registers the names of elements to process.
*/
@Override
public final boolean process(Set<? extends TypeElement> annotations,
RoundEnvironment roundEnv) {
for (TypeElement elem : ElementFilter.typesIn(roundEnv.getRootElements())) {
elements.add(elem.getQualifiedName());
}
return false;
}如上面的注释所见，仅在声明注释处理阶段期间调用该方法。也就是说，它是编译期生效的。
如图所示，注解抽象语法树，是在生成字节码之前。所以，我们可以在process中生成Java类，从理解上来讲，是可行的。
可操作范围
AbstractProcessor是在编译期执行的，同时，它通常处于一个纯Java module中，我们无法依赖Android的相关组件。所以在process过程中，我们无法使用Android的资源、或是直接使用Android的类。
process过程中，我们只能使用JDK中的类，和一些纯Java依赖。比如方便我们生成Java代码的——JavaPoet。
提供的东西
Set<? extends TypeElement> annotations
process给我们的第一个参数是annotations，是我们项目中，所有注解的集合。注解的类型，我们使用TypeElement表示。
TypeElement是Element的子类，我们通过它获取注解的名称、参数等等。
RoundEnvironment
package javax.annotation.processing;
import java.lang.annotation.Annotation;
import java.util.Set;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
public interface RoundEnvironment {
boolean processingOver();
boolean errorRaised();
Set<? extends Element> getRootElements();
Set<? extends Element> getElementsAnnotatedWith(TypeElement var1);
Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> var1);
}RoundEnvironment的定义比较简单，它为我们提供了一系列通过注解获取Element的方法。我们获取了Element也就是获取了被注解的类、属性或者方法。
ProcessingEnvironment
ProcessingEnvironment在init方法中可以获取。
通过getFiler方法，我们可以获取Filer。如上面的文档，Filer可以用来创建新源、类或辅助文件。
有了以上三个类，我们就具有了自动生成代码的完备条件。
- annotations 获取注解集合
- RoundEnvironment 获取被注解的类
- ProcessingEnvironment 用于生成代码
JavaPoet
在上一篇中，我们使用JavaPoet来帮助我们生成Java代码。
JavaPoet为我们提供了方法、类、类注释等标准格式代码的创建方式。下面是一段示例，其中MethodSpec是方法块，TypeSpec是类型块，JavaFile是Java文件。
/**
* @param packageName
* @param clazz
* @param extraComment
*/
private void createClass(String packageName , TypeElement clazz , String extraComment){
// create init & destroy
MethodSpec initMethod = MethodSpec.methodBuilder("init")
.addModifiers(Modifier.PUBLIC)
.returns(void.class)
.build();
MethodSpec destroyMethod = MethodSpec.methodBuilder("destroy")
.addModifiers(Modifier.PUBLIC)
.returns(void.class)
.build();
// create interface type
ClassName interfaceName = ClassName.get(packageName, "IPlugin");
TypeSpec cls = TypeSpec.classBuilder(clazz.getSimpleName().toString() + "Impl")
.addModifiers(Modifier.PUBLIC , Modifier.FINAL)
.addMethod(initMethod)
.addMethod(destroyMethod)
.addSuperinterface(interfaceName)
.build();
JavaFile javaFile = JavaFile.builder(packageName, cls)
.addFileComment(extraComment)
.addFileComment(" This codes are generated automatically. Do not modify!")
.build();
// write to file
try {
javaFile.writeTo(filer);
} catch (IOException e) {
e.printStackTrace();
}
}以上，就是AbstractProcessor的基本使用，如有问题，欢迎指正。
腾讯云开发者
