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 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 findBindingConstructorForClass(Class cls) {
    //尝试从缓存中获取对应的构造函数，这里只有解析过某一个cls的情况下才有值
    Constructor 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) 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是一种更加合适的方案，这个就根据自己的需求来决定。