Android APT系列 - 十分钟让你的 AS 动态生成代码

前言

前天看了公司的路由框架源码后,打算自己手撸一套路由框架,决定不用反射,而用 Apt 来做,因为大名鼎鼎的 ButterKnife/Dragger 都是用 Apt 来实现,到底要看看有哪些好玩的地方.

在这一篇文章中,我们使用 APT 来实现按钮的点击控制,也算是路由框架的一个铺垫,手撸代码已上传至 Github.

项目 Github 地址

https://github.com/maokai1229/FastClick

相关链接

仿照 ButterKnife 的 Android 注解实例

Android 编译时注解-提升

Android编译时注解APT实战

详细介绍编译时注解的使用方法

APT 原理

APT 就是借助 Javax 的注解库,在编译阶段扫描代码,将自定义注解的元素传入到注解处理器的 process() 方法中,然后生成我们想要的代码.比如生成 Java 文件.

生成代码原理很简单,就是用一个 StringBuilder 拼接字符串,然后通过工具类生成 Java 文件

构建过程分析

1. 构建工程,划份代码生成模块/Apt 调用模块
2. 继承 AbstarctProcessor ,重写 process 方法
3. Build 代码生成模块打 jar 包
4. Apt 调用模块导入该 jar 包
5. Apt 调用模块将生成的代码注入源代码

关于 Apt 的几个问题

• 为什么 ButterKnife 注解方法的修饰符不能是 private?

之前我也遇到过这一问题,在接触了 Apt 后迎刃而解,这是因为 Apt 技术会在同一个包中自动生成代码,并且在使用时注入到源代码中,在同一个包, private 修饰的方法对 apt 来说是不可见的.

• Apt 生成的代码在什么时候介入?

BufferKnife 以及我们今天要手撸的 FastClick,它们都是跟随 Activity/View 初始化,在 setContentView 方法被执行后,我们会通过 FastClick.init() 方法,在该方法将Apt生成的方法注入源代码.

• 为什么需要单独创建一个 Java 库模块?

这是因为 Apt 相关的代码被放在一个叫做 Javax 的库中,而我们的 Android 库无法使用到 Javax 包,除非去网上下载一个 jar 文件作为我们的库文件.所以我们需要单独创建,刚好将模块功能隔离开,该模块只负责使用 Apt 生成代码.

• 使用 Apt 和使用反射有什么区别?

Apt 是基于编译时注解,
之前我们使用反射加注解是基于运行时注解,但是这种方式会在运行阶段做耗时的遍历操作,因此性能问题也一直被人们诟病; Apt 也需要用到反射来创建对象,但是不包含耗时操作.所以在性能上有它的优势.