关于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 使用方法总结

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

推荐阅读更多精彩内容