关于ButterKnife的小小总结

ButterKnife是一个学习成本比较小,但是性价比比较高的开源库,项目中最近使用ButterKnife框架来简化代码书写,用了一小段时间,也是时候做个小小的总结了(当前最新的版本为8.4)。

ButterKnife简介


ButterKnife是JakeWharton大神开源的编译期注解的库,这个库主要是针对view、资源ID进行注解,可以减少大量的findViewById以及setOnClickListener代码,同时也支持对字段使用资源注解的形式,取消对资源的检索。
ButterKnife的GitHub地址:Butter Knife GitHub

ButterKnife的优势


  1. 避免过多的findViewById的操作,直接对view进行注解绑定点击事件
  2. 因为是编译期的注解,在运行时不会影响App的效率,使用配置方便
  3. 方便的处理Adapter里的ViewHolder绑定问题
  4. 可以简化代码书写,逻辑清晰

在AndroidStudio中添加ButterKnife库


首先,需要在project的build.gradle中,添加如下:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.2.3'
        classpath 'com.jakewharton:butterknife-gradle-plugin:8.4.0'  //添加这行
    }
}

然后在module的build.gradle文件中,添加如下:

apply plugin: 'com.android.application'
apply plugin: 'com.jakewharton.butterknife'

android {
   //省略代码
}

dependencies {
    compile 'com.jakewharton:butterknife:8.4.0'
    annotationProcessor 'com.jakewharton:butterknife-compiler:8.4.0'
}

如果直接通过 File--Project Structure--Dependencies--Library dependency直接搜索ButterKnife的方式添加的,module的build.gradle文件中要按照上述进行配置,否则会出现空指针异常。

ButterKnife的使用方式


下面通过一个登陆的小demo总结一下常用的注解方法,布局简单,就不贴了,由于每次在Acitivity中都要进行ButterKnife的bind操作,所以建议将bind操作写到BaseActivity中,绑定Activity 必须在setContentView之后,代码如下:

public abstract class BaseActivity extends Activity {

    private Unbinder mUnBinder;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(getContentView());
        mUnBinder = ButterKnife.bind(this);
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        mUnBinder.unbind();
    }

    protected abstract int getContentView();
}

在8.4中ButterKnife移除了ButterKnife.unBind()方法,当时取而代之的是ButterKnife.bind(this)会返回一个Unbinder的引用,通过Unbinder的unbind()方法进行解除绑定。

  • 控件id的注解 @BindView
@BindView(R.id.et_user_name)
public EditText mUserName;    //此处EditText的修饰类型不能是:private 或者 static
                                //否则会报Error:(15, 22) 错误: @BindView fields must not be private or static. 
  • 多个控件id的注解 @BindViews
@BindViews({R.id.et_user_name,R.id.et_pass_word})
public List<EditText> mEditList;
  • 绑定字符串 @BindString
@BindString(R.string.btn_login)
public String mLoginEng;
  • 绑定string里面array数组 @BindArray()
@BindArray(R.array.test_array)
public String[] mTestArray;
  • 绑定Bitmap资源 @BindBitmap()
@BindBitmap(R.mipmap.ic_launcher)
public Bitmap bitmap;
  • 绑定控件点击事件 @OnClick()
@OnClick(R.id.bt_login)
public void login() {
    if ("123".equals(mUserName.getText().toString()) && "123".equals(mPassWord.getText().toString())) {
        Toast.makeText(this, "登录成功", Toast.LENGTH_SHORT).show();
    } else {
        Toast.makeText(this, "登录失败", Toast.LENGTH_SHORT).show();
    }
}

如果同时绑定多个View的点击事件,则可以如下:

@OnClick({R.id.bt_login, R.id.bt_exit})
public void login(View v) {
    int id = v.getId();
    switch (id) {
        case R.id.bt_login:
            if ("123".equals(mUserName.getText().toString()) && "123".equals(mPassWord.getText().toString())) {
                Toast.makeText(this, "登录成功", Toast.LENGTH_SHORT).show();
            } else {
                Toast.makeText(this, "登录失败", Toast.LENGTH_SHORT).show();
            }
            break;
        case R.id.bt_exit:
            Toast.makeText(this, "退出登录", Toast.LENGTH_SHORT).show();
            break;
    }
}

懒人攻略


Zelezny插件的使用的使用,能够快速的自动对控件进行注解,使用步骤如下图所示:

  1. 首先需要下载Zelezny插件


    下载Zelezny插件

    安装Zelezny插件

    Zelezny插件的使用

    上图直接借用的网上的动图。。。

ButterKnife使用心得


  1. ButterKnife.bind()的调用在Activity中必须在setContentView之后
  2. 属性布局不能用private or static 修饰,否则会报错
  3. 可以写一个BaseActivity来调用ButterKnife.bind()方法,子类则不需要再进行bind操作
  4. 在8.4中ButterKnife移除了unBind方法,使用ButterKnife.bind(this)返回一个Unbinder的引用,通过Unbinder的unbind()方法进行解除绑定

参考链接


ButterKnife官方教程
ButterKnife github地址
绝对不容错过,ButterKnife使用详谈
ButterKnife使用详解
Android Butterknife 8.4.0 使用方法总结

推荐阅读更多精彩内容