Butterknife深入剖析,自己实现Butterknife

Butterknife深入剖析,自己实现Butterknife


1科技快讯

昨晚10点整,在回家的路上浪,突然接到微信公众平台的推送,内容是微信小程序开放公测啦,小兴趣的同学可以去微信公众平台申请资格啦,不过开发完成后需要提交审核,公测期间暂不能发布。

相关阅读:微信小程序要这样去解读


ButterKnife我相信,对大部分做Android开发的人都不陌生,这个是供职于Square公司的JakeWharton大神开发的,目前github的star为12449 。使用这个库,在AS中搭配Android ButterKnife Zelezny插件,简直是开发神器,从此摆脱繁琐的findViewById(int),也不用自己手动@bind(int) ,直接用插件生成即可。这种采用注解DI组件的方式,在Spring中很常见,起初也是在Spring中兴起的 。今天我们就一探究竟,自己实现一个butterknife (有不会用的,请自行Google)。


ButterKnife地址:

https://github.com/JakeWharton/butterknife


今天的源码和UML图开源地址:

https://github.com/JakeWharton/butterknife


实现原理Butterknife深入剖析,自己实现Butterknife1

这里需要开发者对注解有一定的了解或者掌握。


对ButterKnife有过了解人 , 注入字段的方式是使用注解@Bind(int),但首先我们需要在Activity声明注入ButterKnife.bind(Activity) 。我们知道,注解分为好几类, 有在源码生效的注解,有在类文件生成时生效的注解,有在运行时生效的注解。分别为RetentionPolicy.SOURCE,RetentionPolicy.CLASS,RetentionPolicy.RUNTIME ,其中以RetentionPolicy.RUNTIME最为消耗性能。而ButterKnife使用的则是编译器时期注入,在使用的时候,需要配置:


classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'


这个配置说明,在编译的时候,进行注解处理。要对注解进行处理,则需要继承AbstractProcessor,在如下方法中进行注解处理:

boolean process(Set<? extends TypeElement>, RoundEnvironment)。

Butterknife深入剖析,自己实现Butterknife

知晓了注解可以在编译的时候进行处理,那么我们就可以得到注解的字段属性与所在类 ,进而生成注入文件,生成一个注入类的内部类,再进行字段处理 , 编译之后就会合并到注入类中,达到植入新代码段的目的。例如:

@VInjector(R.id.tv_show)

TextView tvShow;

我们就可以得到tvShow这个变量与R.id.tv_show这个id的值,然后进行模式化处理:


injectObject.tvShow = injectObject.findViewById(R.id.tv_show); 

再将代码以内部类的心事加入到组件所在的类中 , 完成一次DI(注入) 。


今天的项目的流程和步骤如下:

① 首先创建一个视图注解
② 创建一个注解处理器,用来得到注解的属性与所属类
③ 解析注解,分离组合Class与属性
④ 组合Class与属性,生成新的Java File


下面是APT生成的Java File , 以及模式代码:

Butterknife深入剖析,自己实现Butterknife


项目UML图Butterknife深入剖析,自己实现Butterknife1


(这里我插一句,逝我同学每次的文章都会配UML图,非常好。)

Butterknife深入剖析,自己实现Butterknife


具体实现Butterknife深入剖析,自己实现Butterknife1


一 , 创建注解 , 对视图进行注解,R.id.xxx , 所以注解类型是int类型

Butterknife深入剖析,自己实现Butterknife

二, 注解处理器  关于注解处理器配置,上面已经做了说明

Butterknife深入剖析,自己实现Butterknife

对得到的注解进行处理 , 主要是进行注解类型与属性进行分离合并处理,因为一个类有多个属性,所以采用map集合,进行存储,数据结构为:Map<String, List<VariableElement>>

Butterknife深入剖析,自己实现Butterknife

三、生成Java File , 根据获取的属性与类,创建一个注入类的内部类

Butterknife深入剖析,自己实现Butterknife

结语Butterknife深入剖析,自己实现Butterknife1

ButterKnife类型的注解框架,其主要核心就是编译时期注入, 如果是采用运行时注解的话,那性能肯定影响很大,国内有些DI框架就是采用的运行时注解,所以性能上会有所损伤 。原以为很高深的东西,其实剖析过原理之后,也就渐渐明白了,不再视其为高深莫测,我们自己也可以实现同等的功能。


程序员最好的学习方式就是,学习别人的代码,特别是像jakeWharton这样的大神的代码,值得研究与学习 , 然后模仿之。