APT在Android多个开源框架像Dagger2、Butterknife 等依赖注入的框架中都有用到,文章也自己项目接入ARouter时完成的一个开源库RouterWrapper留个记录。
注解
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface SimpleAnnotation {
}
以上是一个注解的定义,需要关注两个’元注解’
@Retention()
@Target()
@Retetion()注解三个值的区别
值 | 保留 |
---|---|
RetetionPolicy.SOURCE | 注解只在源文件中保留,被编译器编译之前抛弃 |
RetetionPolicy.CLASS | 注解在class文件中保留,被VM抛弃 |
RetetionPolicy.RUNTIME | 注解在VM依然保留,可以被反射读取 |
对于一个编译时处理而不需要运行时反射获取的注解 对应的就是RetetionPolicy.CLASS了
@Target() 元注解 辨识这个注解可以注解在什么上面 上面的Element.TYPE表示这个注解可以注解在 class interface enum 声明上,其他的值就不累述了。
AndroidStudio中创建声明注解处理器
1、创建JavaLibrary 模块(ps:不是AndroidLibrary AndroidLibrary没有引入Javax的包)
2、定义处理器
在新建的JavaLibrary模块下新建处理器
继承于AbstractProcessor类
注意@AutoService
这个注解
对于打包一个完整的注解处理器来说不只是打包处理器源码还包括处理器的声明如下图
具体的声明如下 构建META-INF/services 目录创建javax.annotation.processing.Processor文件里吧自己之前定义注解处理器完整类名 …累…
这样重复的操作 引入Google的一个库搞定了
implementation 'com.google.auto.service:auto-service:1.0-rc3'
然后在自己需要声明的注解处理器类上 加上@AutoService(Processor.class)
就OK了
接上文自定义的注解处理器继承于 AbstractProcessor
主要的几个重载方法
init
方法中可以初始化日志获取一些待用的工具
getSupportedSourceVersion
方法中指定支持的版本
getSupportedAnnotationTypes
指明需要处理 注解(返回类全称)
getSupportedOptions
指明参数声明 这个参数声明对应的是
android {
defaultConfig {
javaCompileOptions {
annotationProcessorOptions {
arguments = [ optionsOutputPackageName:"参数值"]
}
}
}
}
process
函数…这个就如其名开始你的脑洞… 很值得注意的是函数的返回值 在多个注解处理器getSupportedAnnotationTypes
声明处理相同注解 那么在列表前注解处理器的 process
函数返回true 那么后面的注解处理器将会获取该注解元素为空 。`
刚开始接触这部分往往是找不到支持自己思路的函数…
这时候看优秀的开源实例效果挺好…
对自己注解处理器的debug 传送门
参考
http://www.importnew.com/15246.html