作者博客
http://www.jianshu.com/u/9fa7fc2f3733
文章目录
1
前言
JakeWharton 是 Android 大神,同时也是开源狂魔。他开源的项目特点是小而美,且应用广泛,比如 butterknife、RxBinding、hugo 等,本文从受众最广泛,star 最多的 ButterKnife 讲起。
2
你将获得什么?
通过阅读 ButterKnife 源码和本文,你将收获:
3
ButterKnife 简介
ButterKnife 使用注解的方式来替代繁琐的 findViewById 和注册监听器时大量的匿名内部类写法。
本文正对 8.5.1 版本的源码进行分析,自从 8.2.0 起已经支持 library 工程。github 地址为:https://github.com/JakeWharton/butterknife/releases/tag/8.5.1 。
4
ButterKnife 总览
阅读源码切忌只见树木不见森林,因此先从大局上分析下这个项目。
组件依赖关系
ButterKnife 共7个组件,他们的依赖关系如下图所示(其中,butterknife-integration-test 工程不做介绍):
如果项目是 library ,还将引入第三个依赖
为什么需要这三个依赖,他们的作用分别是什么,下文将一一介绍。
整体流程
将整个流程拆分成编译期间和运行期间,就不难理解 ButterKnife 的运行机制。伴随而来的几个问题:
5
android-apt(Annotation Processing Tool)
首先来解决第一个问题,编译期间和注解处理,通过这两个关键词,我们可以联想到的技术方案是: APT(Annotation Processing Tool),即注解处理工具。在该方案中,通常有个必备的三件套,分别是注解处理器 Processor,注册注解处理器 AutoService 和代码生成工具 JavaPoet。
三件套之注解处理器
ButterKnife 一切皆注解,因此首先需要个处理器来解析注解。 ButterKnifeProcessor 充当了该角色,其中 process 方法是触发注解解析的入口,所有的神奇的事情从这里发生。
process 方法中主要做两件事情,分别是:
findAndParseTargets(env) 中解析注解的代码非常冗长,依次对 @BindArray 、@BindColor、@BindString、@BindView 等注解进行解析,解析结果存放在 bindingMap中。
这里重点关注下 bindingMap 的键值对。key 值为 TypeElement 对象 ,可以简单的理解为被解析的类本身,而 value 值为 BindingSet 对象,该对象存放了解析结果,根据该结果,JavaPoet 将生成不同的 Java 文件,以官方 sample 为例,其映射关系如下:
Processor 是为三件套之一。
小插曲之 UT
在介绍余下二件套之前,先插播个小插曲,关于单元测试。
在阅读源码过程中,debug 断点工具往往可以帮助我们事半功倍,运行时的 debug 比较好处理,但是类似于 ButterKnife 这种需要在编译期间处理逻辑的代码应该如何进行 debug ?
单元测试可以把代码独立成一个单元,并且可以隔离对上下文、对环境的依赖(比如 Robolectric 对 Android 的 mock)。一个优秀的有态度的开源框架,往往都配备了齐全的单元测试,ButterKnife 也不例外。
butterknife 子组件中配备了大量的单元测试,这些单元测试是为 ButterKnifeProcessor量身打造的。比如 ExtendActivityTest 中的 views() 对 Activity 包含@BindView 的注解时的处理做了单元测试,运行 UT 后,可以随意断点,如下图:
建议读者用这种方式来理解 butterknife-compiler 中的源码。
三件套之注册注解处理器
定义完注解处理器后,还需要告诉编译器该注解处理器的信息,需在 src/main/resource/META-INF/service 目录下增加 javax.annotation.processing.Processor文件,并将注解处理器的类名配置在该文件中。
整个过程比较繁琐,Google 为我们提供了更便利的工具:AutoService(https://github.com/google/auto/tree/master/service),此时只需要为注解处理器增加 @AutoService 注解就可以了,如下:
AutoService 是为 android-apt 三件套之二。
三件套之 Java 诗人
最后介绍下三件套中最诗情画意的一个工具—— JavaPoet(https://github.com/square/javapoet)。她提供了笔墨纸砚,让我们像写诗一样写一个 Java 类。
了解 JavaPoet ,最好的方式便是看官方文档。简而言之,当我们写一个类时,其实是有固定结构的,JavaPoet 提供了生成这些结构的 api,举例如下:
JavaPoet 提供了很多 Builder,这便是我们手中的笔墨纸砚。
有了浪漫的 Java 诗人之后,可以做很多充满想象力的事情。以 ButterKnife 而言,他做的事情便是将注解处理器解析后的结果(实际上就是上文提到的 BindingSet 对象)生成 Activity_ViewBinding.java,该对象负责绑定 Activity 中的 View 控件以及设置监听器等。
举例如下,假设有如下 ActivIty
经过 JavaPoet 处理后,将生成如下文件:
那么 JavaPoet 是如何处理的?实际上 ButterKnife 会将上文提到的 BindingSet 转换成类似于下文所示的代码:
完整代码:PoetAboutButterKnife.java(https://gist.github.com/geniusmart/ff787a347c0c86153d51c56eaef037f4) ,这是个单元测试,可直接运行,运行后可以在控制台看到生成的 Java 类。
最后总结下这三件套的协作流程,如下图:
6
运行期间
接下来我们来分析下运行期间发生的事情,相比于编译期间,运行期间的逻辑简单了许多。
运行时的入口在于 ButterKnife.bind(this),追溯源码发现,最终将会执行以下逻辑:
也就是说 ButterKnife.bind(this) 等价于如下代码:
SimpleActivity_ViewBinding 持有Activity对象,并且在其构造器中,将会触发Activity 中 view 控件的绑定。
注:虽然这里使用了反射,但源码中将 Class.forName 的结果缓存起来后再通过 newInstance 创建实例,避免重复加载类,提升性能。
编译期间和运行期间相辅相成,这便是 android-apt 的普遍套路。
7
支持 library
编译时和运行时的问题解决了,还有最后一个问题:由 R 生成 R2 的意义是什么?
如果你细心的话会发现在官方的 sample-library 中,注解的值均是由 R2 来引用的,如下图:
如果非 library 工程,则仍然引用系统生成的 R 文件。所以可以猜测:R2 的诞生是为 library 工程量身打造的。
其实 ButterKinife 在 8.2.0 版本之前,并不支持 library 工程的使用。在 Android 组件化、模块化需求这么迫切的今天,如果不支持 library 工程实在可惜。JakeWharton 在2016年07月10日解决了此问题。
首先分析下为什么 library 工程不直接引用 R?当我们把 R2 改成 R 之后,编译器将会报错:Attribute value must be constant ,如下图:
也就是说 BindView 注解的属性必须是常量。但是在 library 工程中 R.id.title 的值为变量,如下图(注:并没有 final 修饰符):
如何解决此问题?既然 R 不能满足要求,那就自己构建一个 R2,由 R 复制而来,并且将其属性都修改为 public static final 来修饰的常量。为了让使用者对整个过程无感知,因此使用 gradle 插件来解决这个需求,这也是 butterknife-gradle-plugin 工程的由来。
butterknife-gradle-plugin 有两个重要的第三方依赖,分别是 javaparser 和 javapoet ,前者用于解析 Java 文件,也就是解析 R 文件,后者在前文中已经浓彩重墨,用于将解析结果生成 R2 文件。
整个插件工程的源码并不难理解,在生成 R2 文件时,要将属性定义成 public static final ,在源码中我们可以看到此逻辑,在 FinalRClassBuilder.addResourceField() 中 :
butterknife 插件在 processResources 的 Task 中执行,该任务通常用来完成文件的 copy。有关插件的知识笔者将在接下来的另外一篇关于 hugo 的源码解析中介绍。
8
有态度的 Lint 检查
生成了 R2 文件后,会产生一个问题:该文件仅是为注解而用的,对开发者并没有任何约束力,怎么防止开发者误用?如:
int id = R2.id.footer;
如果写代码是应付工作,如果工作是绩效驱动,这类问题完全不需要考虑。但是,作为优秀的、有态度的、有情怀的开源框架,JakeWharton 和 ButterKnife 给了我们榜样,为了解决这个问题,butterknife-lint 工程应运而生。
从工程名来看,不难理解这工程的意义:一个静态代码检查工具,用来验证非法的 R2 引用。一旦在我们的业务项目里不小心引用了 R2 文件,当执行 Lint 后,将会有如下图的提示信息:
追求完美的 JakeWharton ,有态度的 ButterKnife !
9
总结
轮子天天有,但是好轮子并不常见。轮子的创意、价值、技术选型、单元测试以及追求完美的态度是衡量一个优秀轮子的维度。ButterKnife 完美地诠释了这一切。
参考文章
http://blog.stablekernel.com/the-10-step-guide-to-annotation-processing-in-android-studio https://github.com/google/auto/tree/master/service https://github.com/square/javapoet