ButterKnife阅读笔记

简述

在Android开发中,很多时候可能都要写一些模板代码,比方说最常见的findViewById,而ButterKnife就是用于降低手写的工作量的。
通过编译期的注解方式,生成新的文件,然后在使用的时候从该文件中自动调用findViewById来实现手动的效果。
这样的做法有好处当然也有坏处,坏处可能就是会增加方法数、使用的时候用到了反射构建预先写好的类、降低编译的速度,好处简单说就是降低手动的工作量,至于要不要使用,这个就看情况定了。
下面讲一下ButterKnife的基本实现流程,因为篇幅有限,只讲findViewByID类型

BindView

用于绑定view的id的注解

@Retention(CLASS)//编译期注解,不会保留到运行时
@Target(FIELD)//作用对象为参数
public @interface BindView {
  //当前绑定对象的id
  @IdRes int value();
}

这个其实就是说明了通过编译期的注解,预先定义好了一个视图对象和id的关联关系

    @BindView(R.id.tv_text)
    TextView tvText;

这个实际上就是说明tvText的id是R.id.tv_text,而R.id.tv_text实际上就是一个int值,这个可以在R文件中看到

编译期处理

因为代码有点多,这里不细讲代码,主要讲述一下流程:
1.通过实现AbstractProcessor来进行编译期对于注解的处理
2.获得当前ButterKnife所有支持的注解元素
3.检查注解的作用域是否合理,通过该注解获得当前参数、注解的id等属性
4.将每一个满足条件的注解对象放入集合当中
5.为每一个有ButterKnife注解的类都重新写一个java文件,其中里面通过之前收集的集合中的数据进行写入,主要是默认写入class.view(注解的参数对象) = targetView.findViewById(注解的id值),那么在后期进行bind的时候调用该新写的类即可实现自动的效果

ClassName bindingClassName = ClassName.get(packageName, className + "_ViewBinding");

这里可以看到实际上生成的辅助类就是在当前有ButterKnife注解的类_ViewBinding,比方说当前为AActivity,那么自动生成的类就是AActivity_ViewBinding

运行时处理

以一个例子说明,假设当前处理的类为MainActivity,其中有一个

@BindView(R.id.tv_text)
TextView tvText;

在运行时,说明编译已经完成,这个时候辅助类已经生成,接下来要做的就是调用该辅助类

ButterKnife.bind(this);

通过默认提供的bind方法即可实现这个效果,具体看一下实现细节

  public static Unbinder bind(@NonNull Activity target) {
    //获取当前Activity对应的Window的DecorView
    View sourceView = target.getWindow().getDecorView();
    return createBinding(target, sourceView);
  }

  private static Unbinder createBinding(@NonNull Object target, @NonNull View source) {
    Class<?> targetClass = target.getClass();
    if (debug) Log.d(TAG, "Looking up binding for " + targetClass.getName());
    Constructor<? extends Unbinder> constructor = findBindingConstructorForClass(targetClass);

    if (constructor == null) {
      return Unbinder.EMPTY;
    }

    //noinspection TryWithIdenticalCatches Resolves to API 19+ only type.
    try {
      //这里仅仅是调用构造函数生成新的Unbinder对象
      return constructor.newInstance(target, source);
    } catch (IllegalAccessException e) {
      throw new RuntimeException("Unable to invoke " + constructor, e);
    } catch (InstantiationException e) {
      throw new RuntimeException("Unable to invoke " + constructor, e);
    } catch (InvocationTargetException e) {
      Throwable cause = e.getCause();
      if (cause instanceof RuntimeException) {
        throw (RuntimeException) cause;
      }
      if (cause instanceof Error) {
        throw (Error) cause;
      }
      throw new RuntimeException("Unable to create binding instance.", cause);
    }
  }

可以看到这里是通过反射的方法创建了一个对象,当然到这里可以猜到其实就是反射构建以前编译期生成的辅助类。

  private static Constructor<? extends Unbinder> findBindingConstructorForClass(Class<?> cls) {
    //尝试从缓存中获取对应的构造函数,这里只有解析过某一个cls的情况下才有值
    Constructor<? extends Unbinder> bindingCtor = BINDINGS.get(cls);
    if (bindingCtor != null) {
      if (debug) Log.d(TAG, "HIT: Cached in binding map.");
      return bindingCtor;
    }
    String clsName = cls.getName();
    if (clsName.startsWith("android.") || clsName.startsWith("java.")) {//过滤Java和Android的内部类
      if (debug) Log.d(TAG, "MISS: Reached framework class. Abandoning search.");
      return null;
    }
    try {
      //通过ClassLoader读取名称为MainActivity_ViewBinding的类(一个例子)
      //其中这个文件是在编译期间的ButterKnifeProcessor中生成的
      Class<?> bindingClass = cls.getClassLoader().loadClass(clsName + "_ViewBinding");
      //noinspection unchecked
      //获取指定的构造函数,其中有两个Class参数(target,view)
      bindingCtor = (Constructor<? extends Unbinder>) bindingClass.getConstructor(cls, View.class);
      if (debug) Log.d(TAG, "HIT: Loaded binding class and constructor.");
    } 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;
  }

这里有一些优化手段先不提,主要是看到通过ClassLoader来加载clsName + "_ViewBinding"的类,这里其实就是MainActivity_ViewBinding,这个就是编译期生成的类。
然后最终在MainActivity_ViewBinding(Activity a, View v)这个方法中完成了预定义的一系列findViewById操作

插件

如果说已经决定使用ButterKnife的话,那么添加页面化插件的话在使用上就更加方便,它可以自动生成注解、id和view的代码

实例.png

然后在对应的Activity代码中,alt+insert(我用的快捷键,这个其实就是AS导航栏上面Code里面的Generate)中打开选项,里面就有ButterKnife的选项,后面就简单了。

总结

从使用的层面来说,ButterKnife确实比较方便,特别是有的页面view特别多的情况下,不过从代码的角度上面来说,如果更加考虑编译的速度和方法数的话,也许自己封装findViewByID是一种更加合适的方案,这个就根据自己的需求来决定。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,099评论 25 707
  • 俗话说的好“不想偷懒的程序员,不是好程序员”,我们在日常开发android的过程中,在前端activity或者fr...
    蛋西阅读 4,966评论 0 14
  • 什么是注解注解分类注解作用分类 元注解 Java内置注解 自定义注解自定义注解实现及使用编译时注解注解处理器注解处...
    Mr槑阅读 1,075评论 0 3
  • 低头族啊低头族, 快来看看蓝天白云飘,太阳开口笑 低头族啊低头族, 快来看看大海鱼儿游,船儿乐悠悠 低头族啊低头族...
    沐木酱阅读 624评论 0 1
  • 今天,小黑兔不想去跑步了,小白兔把他带到操场,让他看一群蚂蚁辛勤的劳动。小黑兔心想:这是要我别偷懒,坚持下去的意思...
    jederik阅读 135评论 0 0