- 配置
// As-3.4.1及其以上 + gradle5.1.1-all + auto-service:1.0-rc4
api 'com.google.auto.service:auto-service:1.0-rc4'
annotationProcessor 'com.google.auto.service:auto-service:1.0-rc4'
java项目避免输出乱码,增加配置
// java控制台输出中文乱码
tasks.withType(JavaCompile) {
options.encoding = "UTF-8"
}
- 继承AbstractProcessor,重写init和实现process方法
- 增加@AutoService(Processor.class)注解
- 配置注解
- SupportedAnnotationTypes 设置要处理的注解类型
- SupportedSourceVersion 设置jdk编译版本
- SupportedOptions 设置接收的参数
- 从init方法中初始化基本工具类实例
// 初始化
/*操作Element的工具类(类,函数,属性,都属于Element)*/
elementUtils = processingEnvironment.getElementUtils();
/*类类型工具,用于操作TypeMirror的工具类*/
typeUtils = processingEnvironment.getTypeUtils();
/*用于打印日志*/
messager = processingEnvironment.getMessager();
/*用于生成文件*/
filer = processingEnvironment.getFiler();
//获取参数,传递参数后文介绍
Map<String, String> options = processingEnv.getOptions();
if (options.size() == 0 || !options.containsKey("eventBusIndex")) {
messager.printMessage(Diagnostic.Kind.NOTE, "需要传递一个类索引类的全类名");
return;
}
eventBusIndexClassName = options.get("eventBusIndex");
-
在process方法中处理Element
- roundEnv.getElementsAnnotatedWith(Subscribe.class) 获取Subscribe注解的所有元素
- element.getKind() 获取该元素类型,是类,函数或者字段等
- element.getModifiers() 获取修饰符
- executableElement.getReturnType() 获取返回值
- executableElement.getParameters() 获取参数
- executableElement.getEnclosingElement() 获取该函数的所属的类元素
executableElement表示这是一个可执行的元素即方法
- elementUtils.getTypeElement("全类名") 根据字符串获取类的类型用于javapoet自动生成文件的类型
- TypeName 某个属性或者参数的类型,一般的可以使用ClassName.get获取,可传递class,TypeElement,TypeMirror等,复合型的类型,例如含有泛型的可以使用ParameterizedTypeName.get获取,例如Map<T1,T2>,第一个参数就传递ClassName.get(Map.class),T1,T2依次传递即可。
- 生成一个类,应该用倒序的方式去写,先把类的结构搭建起,然后需要什么再添加什么,例如:
JavaFile.builder(packageName, typeSpec).build().writeTo(filer);
这就是生成一个类的方法,但是这里需要传入报名和TypeSpec,所以就去创建一个typeSpec,这是一个类结构的封装对象。TypeSpec typeSpec = TypeSpec.classBuilder(className).build()
这句话就能生成一个类结构的封装对象,className就是类名,然后我们可以通过TypeSpec的builder去添加很多关于类的所有东西,最后再build:- 实现一个接口使用
addSuperinterface
或者继承一个类使用superclass
当然都需要传递接口或者要继承的类的类型 - 同样可以添加类的修饰符
addModifiers
,可传递多个 - 可以添加字段
addField
,添加的字段可以创建一个FieldType,需要字段名,类型以及修饰符,例如:
FieldSpec.builder(/*字段类型,参考上文的TypeName*/fieldType, /*字段名*/"info", /*修饰符*/ Modifier.PRIVATE, Modifier.STATIC, Modifier.FINAL) .build();
- 静态代码块
addStaticBlock
,可以创建一个CodeBlock.builder(),然后内部的每一行代码都可以通过add添加,但是需要注意,使用add添加的代码不会自动添加分号 - 添加方法
addMethod
,可以创建一个 MethodSpec.methodBuilder("方法名")来添加,可以添加方法修饰符(addModifiers),方法参数(addParameter),方法返回值(returns),方法体(addStatement或者addCode,前者每句结尾会自动添加分号,后者不会)。 - 然后在添加的过程中还有一个重要的知识点就是format的占位符
$N
用来表示变量名$S
用来表示字符串$T
用来表示类$L
用来表示枚举的值然后每一个占位符都需要一个值来填充,例如要生成
info = new HashMap<Class<?>, String>();
这样一句话就可以:addStatement(/*format*/"$N = new $T<$T, $T>()" /*对应值*/ "info",ClassName.get(HashMap.class), ClassName.get(Class.class),ClassName.get(String.class) )
这样生成出来就是上边那句话了,
$N
和$S
的传值都是字符串,显示出来前者会去掉引号变成一个变量,后者就是字符串显示。