手撕ButterKnife

思维导图

使用方法

最新版本具体信息根据ButterKnife的官网来进行查找。

  1. 导入包。在app下的build.gradle的dependencies中进行引入,当然高版本也容易出现问题。
implementation 'com.jakewharton:butterknife:10.2.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:10.2.1'
  1. 项目中进行使用。根据官网中给出的使用方式来使用即可，下方只给出一种使用
class ExampleActivity extends Activity {
  // 通过BindView的一个
  @BindView(R.id.title) TextView title;

  @Override public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.simple_activity);
    ButterKnife.bind(this);
  }
}

通过上述的@BindView的一个注解，将布局中一个控件和引用进行相关联的绑定操作。这样的操作还有很多

ButterKnife中的注解 对应Java代码
@BindView findViewById()
@BindString getResources().getString()
@OnClick view.setOnClickListener(new View.OnClickListener() {...})

不得不承认，ButterKnife在一定的程度上会提高我的开发效率，但是他到底是怎么运作呢？

源码分析

在使用ButterKnife的时候其实我们是否注意到一个问题，我们一定需要写一个这样的一段代码。

ButterKnife.bind(this);

如果不写会出现下方这样的错误。

    @BindView(R.id.view) View view;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
//        判断写和不写时的区别
//        ButterKnife.bind(this);
    }

    @Override
    protected void onResume() {
        super.onResume();
        view.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {

            }
        });
    }
报错信息

我们能够发现没有加入这句的话的代码出现对象为空的情况，那我们也就能明白ButterKnife的入口其实就是我们必须要写的这一段代码了。

对ButterKnife.bind(this)进行追溯

public static Unbinder bind(@NonNull Activity target) {
    // DecoView是Window中一个变量，是根布局视图的载体
    // 详细需要查看Window的唯一子类PhoneWindow
    // Activity和Window绑定，获取当前的根视图
    View sourceView = target.getWindow().getDecorView();
    return bind(target, sourceView); // 1
  }

// 由注释1调用的函数
public static Unbinder bind(@NonNull Object target, @NonNull View source) {
    Class<?> targetClass = target.getClass();
    // 去寻找一个构造函数
    Constructor<? extends Unbinder> constructor = findBindingConstructorForClass(targetClass); // 2

    if (constructor == null) {
      // 直接返回为空
      return Unbinder.EMPTY;
    }

    //noinspection TryWithIdenticalCatches Resolves to API 19+ only type.
    try {
      return constructor.newInstance(target, source); // 3
    } catch (IllegalAccessException e) {
      // 一些错误处理
    }
  }

先经过上述代码中的注释2，也就是使去构造一个对象。如果没有找到，就直接返回为空；如果找到构造方法了，就进行构造（使用的ClassLoader来加载，也就是反射机制）。那么主要任务还是注释3通过newInstance函数来完成一个Unbinder对象的创建。

public T newInstance(Object ... initargs)
        throws InstantiationException, IllegalAccessException,
               IllegalArgumentException, InvocationTargetException
    {
        if (serializationClass == null) {
            return newInstance0(initargs);
        } else {
            return (T) newInstanceFromSerialization(serializationCtor, serializationClass);
        }
    }

这里的返回值竟然是一个泛型，说明我们之前有说落了什么？回头看看，其实我们就知道了Constructor<? extends Unbinder> constructor = findBindingConstructorForClass(targetClass);这段函数中传入的泛型正是继承自Unbinder的，所以我们的泛型返回值也就确定了。

加载文件长相

看看我们通过这个ButterKnife生成的代码是长什么样的。

public class MainActivity_ViewBinding implements Unbinder {
  private MainActivity target;

  @UiThread
  public MainActivity_ViewBinding(MainActivity target) {
    this(target, target.getWindow().getDecorView());
  }
  // 绑定，这里存在两个函数是不是似曾相识呢？
  @UiThread
  public MainActivity_ViewBinding(MainActivity target, View source) {
    this.target = target;
    // 通过变量来调用他内部的一个变量
    target.view = Utils.findRequiredView(source, R.id.view, "field 'view'");
  }
  
  // 解绑
  @Override
  @CallSuper
  public void unbind() {
    MainActivity target = this.target;
    if (target == null) throw new IllegalStateException("Bindings already cleared.");
    this.target = null;
    target.view = null;
  }
}

在这里其实我们已经明白了，为什么我们的变量只能是public或者不加修饰符的原因了。

但是我们并不只是来看这个的，我们要知道注释的功能是如何实现的？我们看到了一个我们定义的view变量，做了一个Utils.findRequiredView(source, R.id.view, "field 'view'");的操作，我们姑且进去看看好了。

public static View findRequiredView(View source, @IdRes int id, String who) {
    // 我看到了啥??????????????????????
    View view = source.findViewById(id);
    if (view != null) {
      return view;
    }
    String name = getResourceEntryName(source, id);
  }

原来他的寻找原理还是通过findViewById()来完成整个的定位操作的，那ButterKnife的神奇之处也就不再神奇了。

为了验证我们的想法，我对@OnClick的注解做了一个测试。下方贴出ButterKnife中给出的答案。

  @UiThread
  public MainActivity_ViewBinding(MainActivity target, View source) {
    viewSource = source;
    source.setOnClickListener(new DebouncingOnClickListener() {
      @Override
      public void doClick(View p0) {
        target.start();
      }
    });
  }

和我们写的方式还是一模一样的。那我们的好奇心来了，他是如何实现这个代码的输出的，这也是我们整个ButterKnife的核心工作了。

文件生成过程

其实在最开始的导包的时候，我们就应该注意到的一个问题，因为我们导入的ButterKnife并不是只有一个库，而我们上面的那个库的工作明显是一个调用的过程。那猜测一下另外一个库的作用会不会是生成的作用呢？

annotationProcessor 'com.jakewharton:butterknife-compiler:10.2.1'

这里我们要经历一个测试，他是通过ButterKinife.bind(this);触发的还是@BindView这一类的注解来进行触发的？
测试之后，能够发现ButterKinife.bind(this);删除，对我们的使用完全没有影响，但是删去全部的@BindView的注解后，文件没了！！！
这也就说明了文件生成的触发的方式来自于了注解。而注解所在的包的位置正是库com.jakewharton:butterknife-compiler中。但是到底是哪个文件呢？我们只好一个个看过去了。

文件也不多，那我们可以一个个看了。首先我们要明确一个目标，当然这是我的一个猜测，他应该要对注解进行一个收集，然后再进行一个源码的生成，而且这个文件中，可能会出现几个如下的特征：
（1）输出的时候会出现一个后缀"_ViewBinding"。
（2）文件路径应该会出现对我们自己的包一个名字获取，也就是获取包名/getPackageName()等获取函数。
（3）编译时就要调用的一个注解

在ButterKnifeProcessor中我们发现了一个注解@AutoService(Processor.class)说明了这个文件，而这个注解就是为了编译时进行加载的，那我们也就找到了我们的目标了。

  • init()函数是他的一个入口。
@Override public synchronized void init(ProcessingEnvironment env) {
    super.init(env);

    String sdk = env.getOptions().get(OPTION_SDK_INT);
    if (sdk != null) {
      try {
        this.sdk = Integer.parseInt(sdk);
      } catch (NumberFormatException e) {
        env.getMessager()
            .printMessage(Kind.WARNING, "Unable to parse supplied minSdk option '"
                + sdk
                + "'. Falling back to API 1 support.");
      }
    }

    debuggable = !"false".equals(env.getOptions().get(OPTION_DEBUGGABLE));

    typeUtils = env.getTypeUtils();
    filer = env.getFiler();
    try {
      trees = Trees.instance(processingEnv);
    } catch (IllegalArgumentException ignored) {
    }
  }
  • process()函数是一个执行过程，主要就是一个文件的输出。
@Override public boolean process(Set<? extends TypeElement> elements, RoundEnvironment env) {
    // 调用一些parseXXX的函数，来获取注解并生成相对应的数据
    Map<TypeElement, BindingSet> bindingMap = findAndParseTargets(env);

    for (Map.Entry<TypeElement, BindingSet> entry : bindingMap.entrySet()) {
      TypeElement typeElement = entry.getKey();
      BindingSet binding = entry.getValue();

      // 这个文件中会出现相对应的文件操作方式
      // 比如上述的一些猜测_ViewBinding后缀的文件创建
      // 获取包名等一系列操作了。
      JavaFile javaFile = binding.brewJava(sdk, debuggable);
      try {
        javaFile.writeTo(filer);
      } catch (IOException e) {
        error(typeElement, "Unable to write binding for type %s: %s", typeElement, e.getMessage());
      }
    }

    return false;
  }

那这里我们也就完全的解释清楚了文件是怎么进行生成的。具体的生成过程还是需要去查看butterknife.compiler包下的BindingSet文件。

总结

在这里就能解决我们的思考的问题了，其实文章中已经解决了大部分的问题，剩下最后一个反射的问题，在这里做一个解答。

private static Constructor<? extends Unbinder> findBindingConstructorForClass(Class<?> cls) {
    Constructor<? extends Unbinder> bindingCtor = BINDINGS.get(cls);
    if (bindingCtor != null || BINDINGS.containsKey(cls)) {
      if (debug) Log.d(TAG, "HIT: Cached in binding map.");
      return bindingCtor;
    }
    // 。。。。通过反射机制创建。
    BINDINGS.put(cls, bindingCtor);
    return bindingCtor;
}

这是ButterKnife中一段代码，贴出他的意思很明确，其实就是为了说明会出现反射机制，对性能也确实有一定的消耗，但是这种消耗并不大，因为他做了一个缓冲的机制，也就保障我们的性能还是能够做到较大的缓存的。从编码效率提高的角度来看，这种性能代价并不大。

以上就是我的学习成果，如果有什么我没有思考到的地方或是文章内存在错误，欢迎与我分享。

相关文章推荐：
手撕OkHttp
手撕AsyncTask
HandlerThread那些事儿
手撕Handler

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 205,033评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 87,725评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 151,473评论 0赞 338
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,846评论 1赞 277
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,848评论 5赞 368
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,691评论 1赞 282
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,053评论 3赞 399
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,700评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 42,856评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2赞 323
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1赞 333
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,430评论 4赞 321
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,034评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2赞 352
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2赞 343