Butterknife你需要知道的那些事

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 有两个重要的第三方依赖,分别是 javaparserjavapoet ,前者用于解析 Java 文件,也就是解析 R 文件,后者则用于将解析结果生成 R2 文件。感兴趣的同学可以去看看整个butterknife-gradle-plugin插件工程的源代码。

PS:本篇文章只是对Butterknife的原理做了初步的梳理,让大家对它的执行流程有个更清晰明了的认识,对于如何处理注解的逻辑没有过多介绍,如果有兴趣想对它的实现逻辑做进一步的学习,请点击文章下方的参考文案链接,相信那里会帮到大家更多...

参考文案:
深入理解 ButterKnife,让你的程序学会写代码
ButterKnife源码分析
拆 JakeWharton 系列之 ButterKnife

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,919评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,567评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,316评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,294评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,318评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,245评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,120评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,964评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,376评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,592评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,764评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,460评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,070评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,697评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,846评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,819评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,665评论 2 354

推荐阅读更多精彩内容