ButterKnife源码解析

ButterKnife(https://github.com/JakeWharton/butterknife)是一款android平台的依赖注入框架,通过该工具可以实现View、OnClickListener的注入,省去了findViewById、setOnClickListener的过程。使用方法如下:

img_f9d4d30aa5818bf36de41fd4da9113f9.png

通过@BindView注解实现findViewById的功能,完成View注入;通过@OnClick完成OnClickListener点击事件的注入,给ID对应的View设置点击事件和响应函数。关于注解的定义和解析可以参照这篇文章:Java注解。ButterKnife使用的就是编译时解析注解的技术,在编译时对注解进行解析,生成中间文件,在ButterKnife.bind时引用注解编译器生成的中间文件,完成依赖注入。

注解的定义

img_cdfda2760245995bb0a43e4741570a5b.png
BindView注解定义

BindView注解定义中使用了元注解@Retention(CLASS)定义了该注解只保留到编译期间,运行时会丢弃;@Target(FIELD)表示该注解只能用在成员变量上面。

img_f1e549f10c8d0394c4ded719943ad19a.png
OnClick注解

OnClick注解中@Target(METHOD)表示该注解只能用于方法上;

img_a1a9d2a00166802f3a7b6ae254faeabe.png
ListenerClass

ListenerClass是一个@Target(ANNOTATION_TYPE)类型的注解,表示ListenerClass只能用在注解上;且@Retention(RUNTIME)表示该注解可以保留到JVM中,也就是运行时能够通过反射来获取。

注解的解析

下面对@BindView和@OnClick两种注解的解析进行讲解。编译时注解的解析:

 编译时 Annotation 指 @Retention 为 CLASS 的 Annotation,由编译器自动解析。需要做的

    a. 自定义类集成自 AbstractProcessor(编译器在编译时自动查找所有继承自 AbstractProcessor 的类,然后调用他们的 process 方法去处理)

    b. 重写其中的 process 函数

ButterKnife实现了ButterKnifeProcessor来进行编译时注解的解析:

img_2fd33b55a3fd046572d2b9d016ff4bb2.png
ButterKnifeProcessor

ButterKnifeProcessor.process()函数如下:

img_d3cc0680a4171336f8fe09f003d23064.png
ButterKnifeProcessor.process

process函数先调用findAndParseTargets生成bindingMap,然后通过binding.brewJava老生成Java文件。findAndParseTargets的实现如下(这里只关注@BindView和@OnClick):

img_4e9678dcb2307208deca71091b20fe32.png
findAndParseTargets

其中调用parseBindView对注解为@BindView的Field进行解析;findAndParseListener对@OnClick之类的Listener注解进行解析。parseBindView代码如下:

img_e6aa543ec32df36ef9ec984e6827bf53.png
parseBindView

parseBindView的主要工作是创建了BindingSet.Builder。getOrCreateBindingBuilder()如下:

img_6759ee75a70c74ecdc7f64d3c3b636e3.png
getOrCreateBindingBuilder

getOrCreateBindingBuilder内部调用了BindingSet.newBuilder。

img_b8a95070f1f82fefb50e5756d830d210.png
BindingSet.newBuilder

newBuilder生成了Builder对象,Builder对象定义了生成的Java文件名、mView所属对象的类型等。Builder对象生产后,parseBindView就根据@BindView注解信息生成FieldViewBinding对象,之后调用了Builder.build()函数;@BindView的解析已经完成后,最后通过BindingSet.brewJava来生成中间文件。@BindView在生成文件对应了如下:

img_f74fd582108c2e1b1707319fa54c2f95.png
addViewBinding

生成的中间文件如下所示:

img_5e8818d56c9737d35b5684ccb72970f5.png
中间文件

可以看到,中间文件里完成了对Target中成员变量的注入。

那么中间文件又是在什么时候被调用的呢?答案就是ButterKnife.bind(this)

img_11cb3dede303ba2de64d025e3a995f45.png

bind函数根据调用的类名查找其对应的className_ViewBinding的类名,然后反射调用其构造函数。

至此,ButterKnife的@BindView的运行流程就是这样。

优秀的个人博客,低调大师

微信关注我们

原文链接:https://yq.aliyun.com/articles/638359

转载内容版权归作者及来源网站所有!

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

相关文章

发表评论

资源下载

更多资源
优质分享Android(本站安卓app)

优质分享Android(本站安卓app)

近一个月的开发和优化,本站点的第一个app全新上线。该app采用极致压缩,本体才4.36MB。系统里面做了大量数据访问、缓存优化。方便用户在手机上查看文章。后续会推出HarmonyOS的适配版本。

Mario,低调大师唯一一个Java游戏作品

Mario,低调大师唯一一个Java游戏作品

马里奥是站在游戏界顶峰的超人气多面角色。马里奥靠吃蘑菇成长,特征是大鼻子、头戴帽子、身穿背带裤,还留着胡子。与他的双胞胎兄弟路易基一起,长年担任任天堂的招牌角色。

Apache Tomcat7、8、9(Java Web服务器)

Apache Tomcat7、8、9(Java Web服务器)

Tomcat是Apache 软件基金会(Apache Software Foundation)的Jakarta 项目中的一个核心项目,由Apache、Sun 和其他一些公司及个人共同开发而成。因为Tomcat 技术先进、性能稳定,而且免费,因而深受Java 爱好者的喜爱并得到了部分软件开发商的认可,成为目前比较流行的Web 应用服务器。

Java Development Kit(Java开发工具)

Java Development Kit(Java开发工具)

JDK是 Java 语言的软件开发工具包,主要用于移动设备、嵌入式设备上的java应用程序。JDK是整个java开发的核心,它包含了JAVA的运行环境(JVM+Java系统类库)和JAVA工具。