1、Butterknife是什么?
Butterknife是一个依托Java的注解机制来实现辅助代码生成的框架
2、Butterknife的优势
1、强大的绑定功能和Click事件处理功能,简化代码,提升开发效率
2、方便的处理Adapter里的ViewHolder绑定问题
3、运行时不会影响APP效率,使用配置方便
4、代码清晰,可读性强
3、Butterknife可绑定的类型
直接看源代码:butterknife/butterknife-annotations/src/main/java/butterknife/
1、BindArray:绑定String里面的array数组
@BindArray(R.array.city)
String[] citys;
2、BindBitmap:bitmap图像ID注解
@BindBitmap(R.drawable.splash)
Bitmap splash_bitmap;
3、BindBool:布尔类型值ID注解
@BindBool(R.bool.check)
boolean isCheck;
4、BindColor:颜色值ID注解
@BindColor(R.color.colorBlack)
int black;
5、BindDimen:可绑定 int (像素尺寸), float (具体大小值)
@BindDimen(R.dimen.space)
float space;
6、BindDrawable:drawable图像ID注解
@BindDrawable(R.drawable.graphic)
Drawable graphic;
7、BindFloat:float类型dimen资源ID注解
Android 在xml中配置 float 和 integer 值
@BindFloat(R.dimen.image_ratio)
float imageRatio;
8、BindInt:int类型dimen资源ID注解
@BindInt(R.integer.columns)
int columns;
9、BindString:字符串数组ID注解
@BindString(R.string.app_name)
String appName;
10、BindView:控件ID注解
@BindView(R.id.button)
public Button button;
11、BindViews:多个控件ID注解
@BindViews({R.id.button1, R.id.button2, R.id.button3})
public List<Button> buttonList;
12、支持各种事件监听绑定:OnCheckedChanged、OnClick、OnEditorAction、OnFocusChange、OnItemClick、OnItemLongClick、OnItemSelected、OnLongClick、OnPageChange、OnTextChanged、OnTouch
4、Butterknife的用法
具体看这两篇文章就够了,这里就不再赘述:
butterknife
Field and method binding for Android views
5、Butterknife的工作流程 - 编译期
<b>1、Java编译器编译代码之前要先来个预处理,这时候编译器会对classpath下面下图所示配置的注解处理器进行调用:</b>
让我们看下Butterknife是怎么做的:
@AutoService(Processor.class)
public final class ButterKnifeProcessor extends AbstractProcessor {
// 省略内部实现...
}
看看上图,有没有注意到那个文件夹是红色?是的,它是自动生成的,而负责生成这个配置的家伙就是AutoService,这是google的一个开源组件,只需要为注解处理器增加 @AutoService
注解就可以,这里就不过多介绍,有兴趣的自行查看。
简而言之:注解处理器为我们打开了一扇门,让我们可以在Java编译器编译代码之前执行一段我们的代码,当然这代码也不一定就是要生成别的代码了,你可以去检查那些被注解标注的代码的命名是否规范(周志明大神的 《深入理解 Java 虚拟机》一书当中有这个例子);
<b>2、注解处理器(AbstractProcess):解析所有包含了 ButterKnife 注解的类</b>
让我们看下Butterknife是怎么做的:
ButterKnifeProcessor
充当了解析所有包含了ButterKnife注解的处理器角色,其中process
方法是触发注解解析的入口,它主要做以下两件事情:
@Override
public boolean process(Set<? extends TypeElement> elements, RoundEnvironment env) {
// 1、解析所有包含了Butterknife注解的类,然后生成以 TypeElement 为 key ,BindingSet 为 value 的 Map;
Map<TypeElement, BindingSet> bindingMap = findAndParseTargets(env);
for (Map.Entry<TypeElement, BindingSet> entry : bindingMap.entrySet()) {
TypeElement typeElement = entry.getKey();
BindingSet binding = entry.getValue();
// 2、根据生成的 Map ,遍历后使用JavaPoet生成相应的Java文件。
JavaFile javaFile = binding.brewJava(sdk);
try {
javaFile.writeTo(filer);
} catch (IOException e) {
error(typeElement, "Unable to write binding for type %s: %s", typeElement, e.getMessage());
}
}
return false;
}
<b>3、代码生成(JavaPoet):根据解析结果,使用 JavaPoet 生成相应的Java文件</b>
对ButterKnife而言,它做的事情便是根据注解处理器解析后的结果生成XXXActivity_ViewBinding.java
,该java文件内容负责绑定Activity
中的View
控件、绑定数据以及设置监听器,在后面的 运行期间 会讲到。
想要了解JavaPoet的更多用法,请移步 javapoet——让你从重复无聊的代码中解放出来
6、Butterknife的工作流程 - 运行期
相比于编译期,运行期间的逻辑简单了许多:
运行时调用Butterknife的入口在于 ButterKnife.bind(this)
方法:
@NonNull @UiThread
public static Unbinder bind(@NonNull Object target, @NonNull Dialog source) {
View sourceView = source.getWindow().getDecorView();
return createBinding(target, sourceView);
}
private static Unbinder createBinding(@NonNull Object target, @NonNull View source) {
Class<?> targetClass = target.getClass();
Constructor<? extends Unbinder> constructor = findBindingConstructorForClass(targetClass);
// 省略...代码
return constructor.newInstance(target, source);
// 省略...代码
}
@Nullable @CheckResult @UiThread
private static Constructor<? extends Unbinder> findBindingConstructorForClass(Class<?> cls) {
Constructor<? extends Unbinder> bindingCtor = BINDINGS.get(cls);
// 省略...代码
String clsName = cls.getName();
// 省略...代码
try {
// 加载编译期间生成的XXXActivity _ViewBinding.java文件,利用反射调用其构造方法并返回实例化后的对象
Class<?> bindingClass = cls.getClassLoader().loadClass(clsName + "_ViewBinding");
bindingCtor = (Constructor<? extends Unbinder>) bindingClass.getConstructor(cls, View.class);
} catch (ClassNotFoundException e) {
if (debug) Log.d(TAG, "Not found. Trying superclass " + cls.getSuperclass().getName());
// 支持继承关系
bindingCtor = findBindingConstructorForClass(cls.getSuperclass());
} catch (NoSuchMethodException e) {
throw new RuntimeException("Unable to find binding constructor for " + clsName, e);
}
BINDINGS.put(cls, bindingCtor);
return bindingCtor;
}
浓缩以上代码,我们可以理解为 ButterKnife.bind(this)
等价于如下代码:
@NonNull @UiThread
public static Unbinder bind(@NonNull Object target, @NonNull Dialog source) {
View sourceView = source.getWindow().getDecorView();
return new XXXActivity_ViewBinding(target, sourceView);
}
XXXActivity_ViewBinding
类持有XXXActivity对象,并且在其构造方法中,将会触发Activity中View控件的绑定。
注:虽然这里使用了反射,但源码中将 XXXActivity_ViewBinding
类的对象bindingCtor
缓存到Map对象 BINDINGS
中,避免重复加载类,提升性能。
7、Butterknife是怎样支持library 工程的?
如果你细心的话会发现在官方的sample-library
中,注解的值均是由R2来引用的,如下图:
R2的使用
如果非library工程,则仍然引用系统生成的R文件。所以可以猜测:<b>R2的诞生是为library工程量身打造的</b>(从8.2.0版本起开始支持 library 工程)。
首先分析下为什么library工程不直接引用R?我们尝试一下将R2改成R,编译器将会报错 Attribute value must be constant
,如下图所示:
也就是说 BindView
注解的属性必须是常量。但是在 library 工程中 R.id.title
的值为变量,如下图所示,并没有 final
修饰符:
R中的属性为变量
如何解决此问题?既然R不能满足要求,那就自己构建一个R2,由R复制而来,并且将其属性都修改为以 public static final
来修饰的常量。为了让使用者对整个过程无感知,因此使用 gradle 插件来解决这个需求,这也是 butterknife-gradle-plugin 工程的由来。
根据R文件生成的R2文件
butterknife-gradle-plugin 有两个重要的第三方依赖,分别是 javaparser
和 javapoet
,前者用于解析 Java 文件,也就是解析 R 文件,后者则用于将解析结果生成 R2 文件。感兴趣的同学可以去看看整个butterknife-gradle-plugin插件工程的源代码。
PS:本篇文章只是对Butterknife的原理做了初步的梳理,让大家对它的执行流程有个更清晰明了的认识,对于如何处理注解的逻辑没有过多介绍,如果有兴趣想对它的实现逻辑做进一步的学习,请点击文章下方的参考文案链接,相信那里会帮到大家更多...
参考文案:
深入理解 ButterKnife,让你的程序学会写代码
ButterKnife源码分析
拆 JakeWharton 系列之 ButterKnife
网友评论