上一篇讲述了ButterKnife是通过AnnotationProcessor来讲代码中的注解@BindView转换成MainActivity_ViewBinding.java文件的。那AnnotationProcessor是怎么编写、运行的呢。这篇将进行讲解。
一、简介
AnnotationProcessor是一个在编译期用来扫描代码和处理注解的工具。它可以用来处理我们自己声明的注解,并将处理过的java文件作为输出。生成的java文件可以被javac编译并生成相应的class文件参与运行。二、AnnotationProcessor
AnnotationProcessor具体依赖于AbstractProcessor来实现。任何注解处理器都要都要继承这个类。继承之后需要实现四个方法@AutoService(Processor.class)
public class WzkBinderProcessor extends AbstractProcessor {
@Override
public synchronized void init(ProcessingEnvironment processingEnvironment) {
super.init(processingEnvironment);
//该方法会被注解处理工具调用,其中的processingEnvironment中会提供很多有用的类:Elements, Types and Filer
}
@Override
public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
//该方法相当于java应用程序的main()方法。这里会扫描、编译、处理我们的自定义的注解
return false;
}
@Override
public Set<String> getSupportedAnnotationTypes() {
//返回该注解处理程序能够处理的注解。
return super.getSupportedAnnotationTypes();
}
@Override
public SourceVersion getSupportedSourceVersion() {
//支持的版本。默认为返回SourceVersion.latestSupported()
//return super.getSupportedSourceVersion();
return SourceVersion.latestSupported();
}
}
其中代码注释已经解释了4个方法的作用。那我们的主要代码就在process方法中进行。
三、实现binderView
首先添加如下依赖:annotationProcessor "com.google.auto.service:auto-service:1.0-rc4"
compileOnly "com.google.auto.service:auto-service:1.0-rc4"
AutoService会自动在META-INF文件夹下生成Processor配置信息文件,该文件里就是实现该服务接口的具体实现类。而当外部程序装配这个模块的时候,
就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名,并装载实例化,完成模块的注入。
基于这样一个约定就能很好的找到服务接口的实现类,而不需要再代码里制定,方便快捷。
生成java的库有javaWriter和javaopt两个,当然也可以啥都不用,自己实现一个写java文件的工具。
我这里用的是javawriter。
代码在github上已经上传,地址是:
https://github.com/haidaodashushu/AnnonationProcessorTest
关于AnnotationProcessor介绍可以参考该链接:
http://hannesdorfmann.com/annotation-processing/annotationprocessing101
后续再补充代码讲解,如果对github上的代码有疑问,欢迎留言。