一、概述
APT(Annotation Processing Tool)即注解处理器，他是javac的一个工具，用来在编译期时扫描和处理注解，在开发中可以自定义注解，并通过APT搞一些事情，例如在Android中的ButterKnife，EventBus都使用了APT。
二、APT基本使用
来一个简单的例子，我在Activity中加上自定义注解，通过APT查看哪些Activity使用了这个自定义注解。
事前准备：两个Java Libary，一个用来存放注解，另一个用来存放注解处理器。
- apt_annotation：用来存放注解。
- apt_processor：用来存放注解处理器。
2.1 创建注解
APT是注解处理器，所以我们需要创建一个自定义注解。先在Android Studio中创建一个Java Libary(apt_annotation)用来存放注解。并在其中自定义一个注解，名为TestAnnotation。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}
2.2 创建注解处理器
在Android Studio中再创建一个Java Libary，用来存放注解处理器。build.grale文件中添加如下依赖：
dependencies {
//依赖上注解module
implementation project(":apt_annotation")
//谷歌提供的自动注册服务
implementation 'com.google.auto.service:auto-service:1.0-rc4'
annotationProcessor 'com.google.auto.service:auto-service:1.0-rc4'
//生成java代码库
implementation 'com.squareup:javapoet:1.10.0'
}
然后再来创建我们的注解处理器代码如下：
//必须添加
@AutoService(Processor.class)
//需要处理的注解 = getSupportedAnnotationTypes()方法
@SupportedAnnotationTypes({"com.example.apt_annotation.TestAnnotation"})
//编译版本 = getSupportedSourceVersion()
@SupportedSourceVersion(SourceVersion.RELEASE_8)
//必须继承AbstractProcessor
public class TestProcessor extends AbstractProcessor {
//日志控制
private Messager mMessager;
//存储Activity列表
private List<String> activityList;
//输出
private Filer filer;
@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
super.init(processingEnv);
//初始化
mMessager = processingEnv.getMessager();
activityList = new ArrayList<>();
filer = processingEnv.getFiler();
}
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
return false;
}
}
这个类上有三个注解：
- @AutoService(Processor.class) 常规操作，必须添加。
- @SupportedAnnotationTypes({"com.example.apt_annotation.TestAnnotation"}) 支持处理的注解的全类名，也可以通过重写getSupportedAnnotationTypes()方法来设置。
- @SupportedSourceVersion(SourceVersion.RELEASE_8) 编译版本，可以通过重写getSupportedSourceVersion()方法来设置。
三个变量：
- mMessager：Messager对象，用来控制日志输出。
- activityList：用来存储标记了注解的类。
- filer：Filer对象，在动态生成类文件时会用到。
接下来的重点就是在process方法中，这里来写注解的处理逻辑，代码如下：
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
if (annotations.isEmpty()){
return false;
}
mMessager.printMessage(Diagnostic.Kind.NOTE,"Process...");
activityList.clear();
//获取使用了TestAnnotation注解的类
Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(TestAnnotation.class);
for (Element element : elements) {
//强转成TypeElement
TypeElement typeElement = (TypeElement) element;
//获取全类名
String fullName = typeElement.getQualifiedName().toString();
//打印一下全类名
mMessager.printMessage(Diagnostic.Kind.NOTE,fullName);
//把类名加到list
activityList.add(fullName);
}
mMessager.printMessage(Diagnostic.Kind.NOTE,"Finish...");
return true;
}
到这里自定义和自定义注解都写完了，
先在app模块下依赖这两个Libary：
implementation project(":apt_annotation")
annotationProcessor project(":apt_processor")
接着来验证一下，我在我的MainActivity上添加TestAnnotation注解，看看mMessager会不会把类名打印出来。
成功打印，大功告成。你以为这就完了？不不不，还差点。虽然我们拿到了标记了TestAnnotation注解的类，但是我们怎么调用呢？继续往下看。
2.3 使用JavaPoet动态生成类
javapoet是square提供的一个库，就是用来生成java代码的。没有用过的朋友可以看一下官方文档，这里就不着重介绍了。
前面我们通过注解处理器拿到了使用了注解的类，接下来通过JavaPoet来动态生成java文件，并在里面提供获取标记了注解的类名的方法，代码如下：
//动态生成文件 public MyUtils{}
TypeSpec typeSpec = TypeSpec.classBuilder("MyUtils")
.addModifiers(Modifier.PUBLIC)
.addMethod(createGetListFun())//添加方法
.build();
//设置路径
JavaFile javaFile = JavaFile.builder("com.example.apt",typeSpec).build();
try {
javaFile.writeTo(filer);
} catch (IOException e) {
e.printStackTrace();
}
//创建方法
private MethodSpec createGetListFun(){
ClassName className = ClassName.get("java.util","ArrayList");
//返回值类型
TypeName typeName = ParameterizedTypeName.get(List.class,String.class);
//生成方法 public static typeName getList (){ 方法体 }
MethodSpec.Builder builder = MethodSpec.methodBuilder("getList")
.addModifiers(Modifier.PUBLIC,Modifier.STATIC)
.returns(typeName);
//添加方法体
builder.addStatement("$T result = new $T<>()",typeName,className);
for (String s : activityList) {
builder.addStatement("result.add(\"" + s + "\")");
}
builder.addStatement("return result");
return builder.build();
}
至此动态生成代码已经码好，我们编译一下看看有没有生成对应的类。
可以看到，在build目录下成功生成了名为MyUtils的类以及对应的方法，我们可以直接通过MyUtils.getList()来调用，也可以通过Java反射来调用。
通过反射来调用：
try {
Class<?> classz = Class.forName("com.example.apt.MyUtils");
Method method = classz.getDeclaredMethod("getList");
method.setAccessible(true);
List<String> list =(List<String>) method.invoke(null);
for (String s : list) {
Log.e("====",s);
}
} catch (Exception e) {
e.printStackTrace();
}
输出：com.example.codeduan.Activity.MainActivity
这里才算大功告成啦。
三、总结
本文介绍了APT注解处理器的简单使用，通过自定义注解+APT+JavaPoet实现了处理注解和动态生成类，最后并使用反射调用类的方法。这基本上就是一个简单的例子。为了巩固一下，看完的你可以试着写一个类似于黄油刀的View绑定的例子。快撸起袖子试试吧。有不懂的地方可以一起交流哦。
