ButterKnife框架原理

作者: 白瓦力 | 来源:发表于2016-03-13 14:22 被阅读389次

    原文: http://bxbxbai.github.io/2016/03/12/how-butterknife-works/

    大部分Android开发应该都知道@JakeWharton 大神的ButterKnife注解库,使用这个库我们可以不用写很多无聊的findViewById()setOnClickListener()等代码

    ButterKnife项目的主页在这里:http://jakewharton.github.io/butterknife/ 简单介绍一下使用方法:

    public class ExampleActivity extends Activity {
        @Bind(R.id.title) EditText titleView;
        @Bind(R.id.subtitle) EditText subtitleView;
    
        @Override protected void onCreate(Bundle savedInstanceState) {
           super.onCreate(savedInstanceState);
           setContentView(R.layout.example_activity);
           ButterKnife.bind(this);
         }
    }
    

    但是这个库是如何工作的呢?可能很多人都觉得ButterKnife在bind(this)方法执行的时候通过反射获取ExampleActivity中所有的带有@Bind注解的属性并且获得注解中的R.id.xxx值,最后还是通过反射拿到Activity.findViewById()方法获取View,并赋值给ExampleActivity中的某个属性

    这是一个注解库的实现方式,比较原始,一个很大的缺点就是在Activity运行时大量使用反射会影响App的运行性能,造成卡顿以及生成很多临时Java对象更容易触发GC

    ButterKnife显然没有使用这种方式,它用了Java Annotation Processing技术,就是在Java代码编译成Java字节码的时候就已经处理了@Bind@OnClick(ButterKnife还支持很多其他的注解)这些注解了

    Java Annotation Processing

    Annotation processing 是javac中用于编译时扫描和解析Java注解的工具

    你可以你定义注解,并且自己定义解析器来处理它们。Annotation processing是在编译阶段执行的,它的原理就是读入Java源代码,解析注解,然后生成新的Java代码。新生成的Java代码最后被编译成Java字节码,注解解析器(Annotation Processor)不能改变读入的Java 类,比如不能加入或删除Java方法

    下图是Java 编译代码的整个过程,可以帮助我们很好理解注解解析的过程:

    java_compiler.png

    ButterKnife 工作流程

    当你编译你的Android工程时,ButterKnife工程中ButterKnifeProcessor类的process()方法会执行以下操作:

    • 开始它会扫描Java代码中所有的ButterKnife注解@Bind@OnClick@OnItemClicked
    • 当它发现一个类中含有任何一个注解时,ButterKnifeProcessor会帮你生成一个Java类,名字类似<className>$$ViewBinder,这个新生成的类实现了ViewBinder<T>接口
    • 这个ViewBinder类中包含了所有对应的代码,比如@Bind注解对应findViewById(), @OnClick对应了view.setOnClickListener()等等
    • 最后当Activity启动ButterKnife.bind(this)执行时,ButterKnife会去加载对应的ViewBinder类调用它们的bind()方法

    一个栗子

    一段Java代码:

    class ExampleActivity extends Activity {
        @Bind(R.id.user) EditText username;
        @Bind(R.id.pass) EditText password;
        
        @Override public void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.simple_activity);
            ButterKnife.bind(this);
            // TODO Use fields…
        }
        
        @OnClick(R.id.submit) void submit() {
        // TODO call server…
        }
    }
    

    编译成功后,下面的代码生成了:

    public class ExampleActivity$$ViewBinder<T extends 
            io.bxbxbai.samples.ui.ExampleActivity> implements ViewBinder<T> {
    
        @Override public void bind(final Finder finder, final T target, Object source) {
            View view;
            view = finder.findRequiredView(source, 21313618, “field ‘user’”);
            target.username = finder.castView(view, 21313618, “field ‘user’”);
            view = finder.findRequiredView(source, 21313618, “field ‘pass’”);
            target.password = finder.castView(view, 21313618, “field ‘pass’”);
            view = finder.findRequiredView(source, 21313618, “field ‘submit’ and method ‘submit’”);
            view.setOnClickListener(
                new butterknife.internal.DebouncingOnClickListener() {
                @Override public void doClick(android.view.View p0) {
          target.submit();
            }
            });
        }
        
        @Override public void reset(T target) {
            target.username = null;
            target.password = null;
        }
    }
    

    用一张图来说明一下:

    butterknife_example.png

    ButterKnife.bind 执行阶段

    最后,执行bind方法时,我们会调用ButterKnife.bind(this)

    • ButterKnife会调用findViewBinderForClass(targetClass)加载ExampleActivity$$ViewBinder.java
    • 然后调用ViewBinderbind方法,动态注入ExampleActivity类中所有的View属性和
    • 如果Activity中有@OnClick注解的方法,ButterKnife会在ViewBinder类中给View设置onClickListener,并且将@OnClick注解的方法传入其中

    在上面的过程中可以看到,为什么你用@Bind@OnClick等注解标注的属性或方法必须是public或protected的,因为ButterKnife是通过ExampleActivity.this.editText来注入View的

    为什么要这样呢?有些注入框架比如roboguice你是可以把View设置成private的,答案就是性能。如果你把View设置成private,那么框架必须通过反射来注入View,不管现在手机的CPU处理器变得多快,如果有些操作会影响性能,那么是肯定要避免的,这就是ButterKnife与其他注入框架的不同

    有一点需要注意

    通过ButterKnife来注入View时,ButterKnife有bind(Object, View)bind(View)两个方法,有什么区别呢?

    如果你自定义了一个View,比如public class BadgeLayout extends Fragment,那么你可以可以通过ButterKnife.bind(BadgeLayout)来注入View的

    如果你在一个ViewHolder中inflate了一个xml布局文件,得到一个View对象,并且这个View是LinearLayoutFrameLayout等系统自带View,那么不是不能用ButterKnife.bind(View)来注入View的,因为ButterKnife认为这些类的包名以com.android开头的类是没有注解功能的(-。- 这不是废话吗?),所以这种情况你需要使用ButterKnife.bind(ViewHolder,View)来注入View。

    这表示你是把@Bind@OnClick等注解写到了这个ViewHolder类中,ViewHolder中的View呢需要从后面那个View中去找, 大概就是这么个意思

    参考:https://medium.com/@lgvalle/how-butterknife-actually-works-85be0afbc5ab

    相关文章

      网友评论

      本文标题:ButterKnife框架原理

      本文链接:https://www.haomeiwen.com/subject/jxtflttx.html