简介
APT，就是Annotation Processing Tool 的简称，简单来说就是通过编码来动态得到解析Annotation的工具。一般分为两类：
1.运行时注解：比如大名鼎鼎的retrofit就是用运行时注解，通过动态代理来生成网络请求
2.编译时注解：比如Dagger2, ButterKnife, EventBus3
代码实现
这里我们要实现一个怎样的功能呢？第一个就是给我们的activity添加一个@Flag，然后当我们编译的时候就会生成一个java main函数。第二个就是我简易版的butterknife。2个注解都是写在用一个插件中。好了下面直接开始。
Annotation module
首先我们创建一个my_annotation的java module，这个项目只放我们的注解文件，不涉及到注解处理等其他逻辑，关于注解处理我们会新建一个module来处理。项目结构如下：
image.png
其中build.gradle中基本不用修改，保持默认的配置就可以，如下：
image.png
Flag注解
image.png
就是这么简单，关于注解中元注解的解释请参考我的另一篇文章：元注解简介
关于注解module就到这了。
注解处理 module
首先我们创建一个my_compiler的java module。项目结构如下：
image.png
build.gradle的配置如下：
image.png
简单解释下几个dependencies
auto-service:这是google推出的方便我们编写annotation插件，在没有这个这个库之前，我们需要对我们的插件做很多的配置才能使用，有了这个库以后就方便多了，下文会看到怎么用，这里就不介绍了。官网
javapoet:这是方便我们在编译时动态生成class文件的，下文也会有具体怎么使用，这里不做过多解释。官网
关于上面2个库大家感兴趣可以去查找相关资料进行进一步了解。下面我们看下真正的注解处理类：
/**
* @author Jin
*/
//来自auto-service 只要添加这个注解以后就不需要做其他配置，现在已经可以在项目中直接使用了
@AutoService(Processor.class)
public class FlagAnnotationProcessor extends AbstractProcessor {
/**
* getSupportedSourceVersion()方法返回 Java 版本 默认为Java6
*
* @return Java 版本
*/
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
}
/**
* 返回要处理的注解的结合 这里只处理RouterAnnotion类型的注解
*
* @return
*/
@Override
public Set<String> getSupportedAnnotationTypes() {
LinkedHashSet<String> types = new LinkedHashSet<>();
types.add(Flag.class.getCanonicalName());
return types;
}
/**
* 注解的具体处理类
*
* @param annotations
* @param roundEnv
* @return
*/
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
//来自javapoet 动态生成方法
MethodSpec main = MethodSpec.methodBuilder("main")
.addModifiers(Modifier.PUBLIC, Modifier.STATIC)
.returns(void.class)
.addParameter(String[].class, "args")
.addStatement("$T.out.println($S)", System.class, "Hello, JavaPoet!")
.build();
//来自javapoet 动态生成类
TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
.addModifiers(Modifier.PUBLIC, Modifier.FINAL)
.addMethod(main)
.build();
//来自javapoet 动态生成文件
JavaFile javaFile = JavaFile.builder("com.jin.helloworld", helloWorld)
.build();
try {
javaFile.writeTo(processingEnv.getFiler());
} catch (IOException e) {
e.printStackTrace();
}
return true;
}
}
注解处理类已经写好了，下面我们看下怎么关联到我们的项目中。
注解使用
image.png
AndroidStudio3.0使用annotationProcessor来处理注解。
image.png
添加我们的@Flag注解。ok。大功告成，下面重新编译（rebuild project）一下我们的项目，就会在build目录下看到自动生成的代码了。
image.png
你可能会说，生成一个HelloWorld main函数并木有什么卵用啊，是的，但是你起码掌握了最基本的关于Annotation项目的创建、编译、使用了是不是，麻雀虽小但是五脏俱全啊。
下面进入我们的另一个demo，简易版butterknife。
简易版butterknife
下面我直接添上注解和处理代码(相关解释会在注释中)：
image.png
image.png
DIAnnotationProcessor
@AutoService(Processor.class)
public class DIAnnotationProcessor extends AbstractProcessor {
private Filer mFiler;
private Elements elementUtils;
/**
* init()方法可以初始化拿到一些使用的工具，
* 比如文件相关的辅助类 Filer;元素相关的辅助类Elements;日志相关的辅助类Messager;
*
* @param processingEnv
*/
@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
super.init(processingEnv);
mFiler = processingEnv.getFiler();
elementUtils = processingEnv.getElementUtils();
}
/**
* getSupportedSourceVersion()方法返回 Java 版本 默认为Java6
*
* @return Java 版本
*/
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
}
/**
* 返回要处理的注解的结合 这里只处理RouterAnnotion类型的注解
*
* @return
*/
@Override
public Set<String> getSupportedAnnotationTypes() {
LinkedHashSet<String> types = new LinkedHashSet<>();
types.add(BindActivity.class.getCanonicalName());
return types;
}
/**
* 注解的具体处理类
*
* @param annotations
* @param roundEnv
* @return
*/
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
System.out.println("DIAnnotationProcessor");
//得到所有被Bind添加注解的类
Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(BindActivity.class);
for (Element element : elements) {
//强制转换成TypeElement 判断是否是Class
TypeElement typeElement = (TypeElement) element;
//得到typeElement类中所有成员变量和成员方法
List<? extends Element> members = elementUtils.getAllMembers(typeElement);
MethodSpec.Builder bindViewMethodSpecBuilder = MethodSpec.methodBuilder("bindView")
.addModifiers(Modifier.PUBLIC, Modifier.STATIC)
.returns(TypeName.VOID)
.addParameter(ClassName.get(typeElement.asType()), "activity");
for (Element item : members) {
BindMyView bindView = item.getAnnotation(BindMyView.class);
if (bindView == null) {
continue;
}
bindViewMethodSpecBuilder.addStatement(String.format("activity.%s = (%s) activity.findViewById(%s)", item.getSimpleName(), ClassName.get(item.asType()).toString(), bindView.value()));
}
TypeSpec typeSpec = TypeSpec.classBuilder("DI" + element.getSimpleName())
.superclass(TypeName.get(typeElement.asType()))
.addModifiers(Modifier.PUBLIC, Modifier.FINAL)
.addMethod(bindViewMethodSpecBuilder.build())
.build();
JavaFile javaFile = JavaFile.builder(getPackageName(typeElement), typeSpec).build();
try {
javaFile.writeTo(processingEnv.getFiler());
} catch (IOException e) {
e.printStackTrace();
}
}
return true;
}
private String getPackageName(TypeElement type) {
return elementUtils.getPackageOf(type).getQualifiedName().toString();
}
}
DI Annotation使用
image.png
注意此时一定要先rebuild project生成如下文件
image.png
然后在我们的代码中写上
image.png
这里ButterKnife.bind(this)是用来对比，请大家注意， DIMainActivity.bindView(this)才是我们直接生成的文件。
调试（AndroidStudio3.0）已解决
如果过你也像我一样按照网上的教程操作，但是始终报错：Unable to open debugger port (localhost:5006): java.net.ConnectException "Connection refused: connect"
配置如下：
image.png
上面的配置代码记得在全局的gradle.properties中添加 该文件一般位于C:\Users\Jin.gradle下 如果没有亲手动创建
image.png
控制台输入：gradlew --daemon
然后
image.png
点击调试
网友评论