一篇文章让你搞懂ButterKnife使用和原理

我们在日常开发android的过程中,在前端activity或者fragment时,无法避免的会用到findViewById这类的代码,然后强制类型转换出我们所需要的控件类型,说实话,对于追求代码简洁,高可读,并且想偷懒的程序员来说,写这样的重复代码,简直就是灾难。一般有俩种解决方法:1.通过自定义注解,使用时通过反射生成2使用ButterKnife

一.使用反射方式减少findViewById的编写

JAVA反射机制是在运行状态中,对于任意一个类,都能够知道这个类的所有属性和方法;对于任意一个对象,都能够调用它的任意一个方法和属性;这种动态获取的信息以及动态调用对象的方法的功能称为java语言的反射机制。
为了减少我们findViewById,我们都知道可以使用反射的方式进行优化下面我们来看下是怎么实现的:

1.创建注解类FindView

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FindView {

    public int value();

    /* parent view id */
    public int parent() default 0;
}

2.在activity或者fragment中,使用以下方式注入ID并且初始化对象

@SetOnClickListener({R.id.ll_community_switch,R.id.panel_abot,R.id.ll_me_info})
public class MeFragment implements OnClickListener{

    @FindView(R.id.panel_shell)
    private FrameLayout mShellPanel;

    @FindView(R.id.panel_coverture)
    private LinearLayout mPanelCoverture;

    public void onClick(View v) {
        switch (v.getId()) {
            case R.id.ll_community_switch: {
                // TODO 
                break;
            }
        case R.id.ll_panel_abot: {
                // TODO 
                break;
            }
        ......

}

3.添加查找注解到视图的方法

注解使用的其中一种方式是给类/方法/成员变量设置注解,然后在某个地方,对设置的注解进行解析,以期获取到注解对应的类/方法/成员变量的一些属性或者能力,我们这里正是利用的这个特性,在activity(onCreate)或者fragment(onActivityCreated)的生命周期中,加入我们解析注解的代码,对注解属性进行初始化操作

// this代表Fragment或者Activity对象
InjectFinder.injectView(this);  

4.解析注解

在injectView方法中,我们通过反射方式获取到activity或者fragment的FindView注解,然后根据注解中的ID,最终还是通过findViewById的方法获取到对应的控件(注:SetOnClickListener注解原理类似)

public static <O> void injectView(Class<?> clazz, O o) {
        Class<?> tempClazz = clazz != null ? clazz : (o != null ? o.getClass() : null);
        if (tempClazz != null) {
            // find view
            final SparseArray<View> tempViewArray = new SparseArray<View>();
            Field[] fields = tempClazz.getDeclaredFields();
            if (Assert.notEmpty(fields)) {
                for (Field field : fields) {
                    FindView viewInject = field.getAnnotation(FindView.class);
                    if (viewInject != null) {
                        try {
                            int viewId = viewInject.value();
                            View view = findViewById(o, viewId, viewInject.parent());

                            // Check if the object type is match
                            Class<?> targetType = field.getType();
                            Class<?> viewType = view.getClass();
                            if (!targetType.isAssignableFrom(viewType)) {
                                String err = "Type mismatch! \n" 
                                        + "  The view is   (" + viewType.getName() + ") R.id." 
                                        + view.getContext().getResources().getResourceEntryName(viewId) 
                                        + "#" + String.format("0x%08x", viewId) + "\n" 
                                        +"  Cannot set to (" + targetType.getName() + ") " 
                                        + o.getClass().getName() + "." + field.getName();
                                Log.e(TAG, err);
                                continue;
                            }
                            // 设置变量值
                            if (setField(o, field, view)) {
                                tempViewArray.append(viewId, view);
                            }
                        } catch (Throwable e) {
                            Log.e(TAG, e);
                        }
                    }
                }
            }

            // 获取onClicklistener类
            boolean isClickClazz = Assert.isInstanceOf(OnClickListener.class, o);

            // 获取注解的View id
            int[] clickIds = findClickIds(tempClazz);
            if (Assert.notEmpty(clickIds)) {
                for (int id : clickIds) {
                    if (id != 0) {
                        View tempView = tempViewArray.get(id);
                        if (tempView == null) {
                            try {
                                tempView = findViewById(o, id, 0);
                            } catch (Throwable t) {
                                Log.e(TAG, t);
                            }
                        }

                        if (tempView != null) {
                            // 设置点击事件
                            if (isClickClazz) {
                                tempView.setOnClickListener(ViewUtils.proxy((OnClickListener) o));
                            }
                        }
                    }
                }
            }
        }
    }

通过以上几步,我们知道,通过反射方式,虽然可以达到我们的目的,但是通过反射时,先找查找类资源,使用类加载器创建,过程比较繁琐,所以效率较低
这个也就是我们为什么使用ButterKnife

二.ButterKnife

由于使用反射等方式处理注入,会存在效率方面的问题,所以我们的JakeWharton大神写了ButterKnife框架,来帮助我们实现依赖注入。

1.ButterKnife优势

  • 强大的View绑定和Click事件处理功能,简化繁琐的代码编写
  • 可以支持Adapter中的VIewHolder绑定问题
  • 采用编译时通过注解生成代码,对运行时没有侵入,对比反射方式,效率倍高
  • 代码清晰,可读性强

2.ButterKnife使用

①在你android project级别的build.gradle配置文件中,引入android-apt插件
buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        // butter knife plugins
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
    }
}
②在android module的build.gradle配置文件中,引入如下依赖
dependencies {
    /* butterknife */
    compile 'com.jakewharton:butterknife:8.2.1'
    annotationProcessor 'com.jakewharton:butterknife-compiler:8.2.1'
}
③ButterKnife使用实例
a 注入视图
    @BindView(R.id.toolbar)
    Toolbar toolbar;

    @BindView(R.id.fab)
    FloatingActionButton fab;
b 注入事件
@OnClick(R.id.fab)
public void show(View view){
        Snackbar.make(view, "Replace with your own action",Snackbar.LENGTH_LONG)
                        .setAction("Action", null).show();
}
c 在activity或者fragment初始化的时候进行绑定操作
@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    ButterKnife.bind(this);
    setSupportActionBar(toolbar);
}

3.ButterKnife原理分析

可能很多人都觉得ButterKnife在bind(this)方法执行的时候通过反射获取MainActivity中所有的带有@BindView注解的属性并且获得注解中的R.id.xxx值,最后还是通过反射拿到Activity.findViewById()方法获取View,并赋值给MainActivity中的某个属性。这是一种原始的使用反射的方式,缺点是反射影响App性能,造成卡顿,并且会产生大量的临时对象,频繁的引发GC。

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

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

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


image.png

4.ButterKnife框架工作流程(知识点!)

当你编译使用了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()方法
举个栗子
APP编译阶段执行以上①②③步
public class MainActivity extends AppCompatActivity {

    @BindView(R.id.toolbar)
    Toolbar toolbar;

    @BindView(R.id.fab)
    FloatingActionButton fab;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ButterKnife.bind(this);
        setSupportActionBar(toolbar);
    }

    @OnClick(R.id.fab)
    public void show(View view){
        Snackbar.make(view, "Replace with your own action", Snackbar.LENGTH_LONG)
                        .setAction("Action", null).show();
    }
}

编译之后,会在目录下生成两个文件


image.png

让我们来看下这两个文件内容:

MainActivity_ViewBinder.class
public final class MainActivity_ViewBinder implements ViewBinder<MainActivity> {
  @Override
  public Unbinder bind(Finder finder, MainActivity target, Object source) {
    return new MainActivity_ViewBinding<>(target, finder, source);
  }
}
MainActivity_ViewBinding.class
public class MainActivity_ViewBinding<T extends MainActivity> implements Unbinder {
  protected T target;

  private View view2131492973;

  public MainActivity_ViewBinding(final T target, Finder finder, Object source) {
    this.target = target;

    View view;
    target.toolbar = finder.findRequiredViewAsType(source, R.id.toolbar, "field 'toolbar'", Toolbar.class);
    view = finder.findRequiredView(source, R.id.fab, "field 'fab' and method 'show'");
    target.fab = finder.castView(view, R.id.fab, "field 'fab'", FloatingActionButton.class);
    view2131492973 = view;
    view.setOnClickListener(new DebouncingOnClickListener() {
      @Override
      public void doClick(View p0) {
        target.show(p0);
      }
    });
  }

  @Override
  public void unbind() {
    T target = this.target;
    if (target == null) throw new IllegalStateException("Bindings already cleared.");

    target.toolbar = null;
    target.fab = null;

    view2131492973.setOnClickListener(null);
    view2131492973 = null;

    this.target = null;
  }
}

我们可以看到MainActivity_ViewBinder类在执行bind方法的时候会new一个MainActivity_ViewBinding对象,并且传入了MainActivity实例,在MainActivity_ViewBinding对象执行构造方法的时候,需要对target.XXX,所以我们这里在MainActivity中的BindView注解的属性,不能使用private修饰符,那么使用protected修饰是否可以呢?答案是可以的,因为ButterKnifeProcessor类的process()方法会在MainActivity的同一个包下生成BinderBinding类,所以同包下是可以调用到的。同样的道理,onClickListener也是通过找到view,然后设置viewonclicklistenertarget.XXX()方法,同样的调用target.XXX()方法需要public或者protected修饰。

通过以上的流程我们知道,ButterKnife是在编译时通过注解方式解析生成了Binder类和Binding,在Activity中调用了ButterKnife.bind(this)方法后,通过BinderBinding的配合,找到Activity中的类,并且类似与代理一样的,为Activity的注解绑定了对应的实例或者调用方法。

ButterKnife.bind 执行阶段(Activity启动或者Fragment加载)也就是上面的第④步:

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

ButterKnife会调用findViewBinderForClass(targetClass)加载MainActivity$$ViewBinder.java
然后调用ViewBinderbind方法,动态注入MainActivity类中所有的View属性和
如果Activity中有@OnClick注解的方法,ButterKnife会在ViewBinder类中给View设置onClickListener,并且将@OnClick注解的方法传入其中
在上面的过程中可以看到,为什么你用@Bind、@OnClick等注解标注的属性或方法必须是publicprotected的,因为ButterKnife是通过ExampleActivity.this.editText来注入View

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

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

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

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

这表示你是把@Bind、@OnClick等注解写到了这个ViewHolder类中,ViewHolder中的View呢?需要从后面那个View中去找。

总结:

通过分析,我们还了解到ButterKnife之所以对性能影响不大,是因为它使用的APT(编译时解析技术),即注解类在编译时就通过反射的方式将注解扫描出来被编译成实际的类,使用时只需要调用bind()方法查找,所以应用性能不会受影响。

感谢https://www.jianshu.com/p/7a8c0f8de7da

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

推荐阅读更多精彩内容