capt 全称 Class Annotation Processor Tool,是作者基于 ASMAndroid Transform API 打造的 Android 平台的字节码的注解处理工具。

起源

apt

capt 的灵感有很大一部分来自于 apt。作为一个 Android 开发者,虽然 apt 已经足够强大,但是有个缺陷一直是我们的痛点:只支持源码

Android 日常开发中,大量的依赖了第三方库如 AAR / JAR,而他们是已经编译成了 class 字节码,而 apt 仅支持源码级别的注解处理,因为我们不得不通过很多曲折的方式来实现原本简单的逻辑。

举个例子:阿里开源的 ARouter,在早期只有 apt 的版本中对模块化的处理是通过显式的添加模块参数来实现的,在新版中也通过注册 Android Transform API 在打包过程中修改部分字节码打到目的。

Lancet

Lancet 是作者在早些时候在 eleme 开源的 Android AOP 框架,就是基于 Transform API 来实现的。由于 GitHub eleme 组织的废弃,在几个月前作者创建了独立的 Lancet 项目并规划 Lancet2 的开发。在思考的过程中,觉得仅仅是 Lancet2 还不够酷,有以下几个原因:

  1. 注解是固定的几种,使用很受限制
  2. 无论是 Lancet2 还是 Lancet1 都有大量重复的代码,浪费在主流程的无关逻辑上

于是作者萌生了一个想法,我们能不能做一个工具,只做注解处理和代码转换的分发逻辑,具体的业务逻辑由插件完成。

说干就干,于是 capt 诞生了。

capt

相比 apt,capt 除了提供注解处理之外,还允许多个插件链式地修改每个类的字节码。
同时 capt 有以下几大特性:

完全同步的 Variant

annotationProcessor类似, capt 会为每个SourceSet / BuildType / ProductFlavor创建对应的Configuration,你可以用如下的方式,根据不同的构建类型,来使用不同的 capt 插件:

dependencies {
    capt project(":xx")
    capt "xx:xx:1.0"
    capt files("...")
    releaseCapt ...
    androidTestCapt ...
}

Application & Library

capt 同时支持 Android Application 和 Library 的注解处理和注入代码:

  • Application: 所有的 runtime class
  • Library: 仅该 Library 自身

APK & AndroidTest

capt 支持打普通 APK 和 AndroidTest 时注入:

  • APK: 打普通 APK 时会传递所有的 APK 中的类
  • AndroidTest: AndroidTest 打包时只会传递所有 androidTest 目录下的类

灵活的参数

capt 会为每个注册的插件创建一个 Gradle Extension 对象,可以传入任意形式的参数,在插件的生命周期传递给插件,同时每个 Extension 也会内置插件的公共参数,如优先级(可覆盖插件中声明的默认优先级)、作用域(Assemble | AndroidTest)等。

极致的增量更新

capt 会针对每个 Variant 有自身的缓存,记录类图、插件和插件的修改的类等元信息。

注解处理

capt 会解析类图,分析类图中类的的变化(添加、修改、删除),因此 capt 要求所有的插件注解处理器都要支持增量解析,因此 capt 对打包时间的影响很小。并且性能一直是 cpat 持续追求的目标

当然有得有失,因为在增量模式下,含有注解的类没有发生变化是不会传递到注解处理器中的,因此需要每个插件自己去实现本地缓存的逻辑。

类转换

capt 遵循最小原则,因此类转换有3步:

  1. capt 会询问每个插件需要哪些类(全量、增量、无),以及是否解析额外的类
  2. 如果上次构建过程中的插件被移除(移除插件不会打断增量构建流程,增加会),capt 会额外添加被移除插件修改过的类
  3. 最后 capt 会汇总上面的信息,并据此来分发类的转换流程。

丰富的 API

capt 在插件的生命周期会提供丰富的 API,如类结构图、上下文、甚至于ClassLoader,让每个插件的奇思妙想都能够实现。如果有更多更好的想法也可以提 Issue & PR 哦。

对 ASM 的高度支持

capt 允许在类转换前对 ClassReader 和 ClassWriter 请求额外的标志位,从而提供了最大的灵活性,同时默认都为 0 以期最佳性能。

并且 capt 为 ClassWriter.COMPUTE_FRAME 生成了独特的 ClassLoader,开发者不再需要纠结于代码中的计算栈帧信息的问题。

未来规划

  • 基于 capt 开发 Lancet2
  • 持续优化性能
  • 更多丰富的 API

开源地址

https://github.com/CoffeePartner/capt

如果觉得 capt 还不错,请给 capt 一个 Star!
欢迎 Issue & PR。