APT(Annotation Processing Tool) 注解编译时工具。现在越来越多的框架使用apt技术来实现或重写,如Dagger2、ButterKnight、ARouter。APT技术可以简单理解为在编译时通过处理注解来实现部分代码逻辑,动态生成java class文件,供我们使用。
APT系列:
APT的使用1(apt的接入)
APT的使用2(实现findViewById功能)
下面通过一个简单的apt接入实例来了解apt的基本用法
1. 新建一个名为lib的java library
lib的build.gradle
apply plugin: 'java-library'
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
}
sourceCompatibility = "1.7"
targetCompatibility = "1.7"
添加一个注解类,如@Test
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface Test {
String path();
}
2. 新建一个名为apt-lib的java library,来实现处理注解的逻辑
apt-lib的build.gradle
apply plugin: 'java-library'
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
implementation project(':lib')
implementation 'com.google.auto.service:auto-service:1.0-rc4'
implementation 'com.squareup:javapoet:1.11.1'
}
sourceCompatibility = "1.7"
targetCompatibility = "1.7"
其中com.google.auto.service:auto-service:1.0-rc4是google开源的用于注册Processor的工具库,com.squareup:javapoet:1.11.1是一个开源的生产class文件的库。
实现一个简单的处理注解的processor类
@AutoService(Processor.class)
@SupportedSourceVersion(SourceVersion.RELEASE_7)
@SupportedAnnotationTypes({"com.example.lib.Test"})
public class MyProcessor extends AbstractProcessor {
@Override
public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
// 生成一个main方法,带参数,并声称语句,传入参数
MethodSpec main = MethodSpec.methodBuilder("main")
.addModifiers(Modifier.PUBLIC, Modifier.STATIC)
.addParameter(String[].class,"args")
.addStatement("$T.out.println($L)",System.class, "args[0]")
.build();
// 生成一个类、接口,添加一个方法给它
TypeSpec typeSpec = TypeSpec.classBuilder("HelloWord")
.addModifiers(Modifier.PUBLIC,
Modifier.FINAL).addMethod(main).build();
// 生成java文件,传入类、包名等信息
JavaFile file = JavaFile.builder("com.jason.test", typeSpec).build();
try {
// 写到我们的环境中去
file.writeTo(processingEnv.getFiler());
} catch (IOException e) {
e.printStackTrace();
}
return true;
}
}
上述代码中的 $L,$T 代表不同的字面量类型,具体参考这里
3.在app中配置依赖
打开app的build.gradle文件配置如下:
dependencies {
xxx...
compile project(':lib') // 引入lib
annotationProcessor project(':apt-lib') // 指定使用apt处理我们的apt-lib库
}
注意:上述操作在gradle版本3.0.1及以上,如果低于这个版本,在根build.gradle文件中添加
// 在根build.gradle文件添加
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
// 在app的build.gralde中添加
apply plugin: 'com.neenbedankt.android-apt'
然后点击rebuild,就会在目录(app/build/generated/source/apt/debug/包名/Test)下生成我们的HelloWord文件了,名字在MyProcessor中指定了,可以很灵活的指定。
4.在app中使用注解类@Test
在项目编译期,annotationProcessor project(':TestCompiler')
这里会处理项目中的Processor类。最后也可以在项目中操作Processor里生成的HelloWorld类。
@Test(path = "main")
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
HelloWord hw = new HelloWord();
hw.main(new String[]{"我是一个processor"});
}
}
#APT的运行方式、时机及注意点#
根据sun官方的解释,APT是一个命令行工具,它对源代码文件进行检测并找出其中的RetentionPolicy为CLASS的annotation,然后使用annotation processor来处理,这个annotation processor使用一套反射api并支持JSR175规范。
APT在编译时自动查找左右继承自AbstractProcessor的类,然后调用他们的process方法,相当于在编译过程中执行代码。
在Android Studio中找不到AbstractProcessor类是因为android.jar默认不包含javax的包,所以我们需要新建一个Module,指定为java library,然后在其中实现我们的processor。
@SupportedAnnotationTypes({"com.example.lib.Test"})通过这段代码指定要处理的注解类;@SupportedSourceVersion(SourceVersion.RELEASE_7)通过这段代码,指定编译的版本,这种通过注解指定编译版本和类型的方式是从Java1.7才有的。对于之前的版本是通过重写AbstractProcessor中的方法来指定的。