Android实践 | 注解框架ButterKnife基本使用

ButterKnife是JakeWharton完成的一个注解框架,它不会影响App的效率,被广泛应用于Android开发。
项目地址:https://github.com/JakeWharton/butterknife
文档地址:http://jakewharton.github.io/butterknife/

使用ButterKnife,我们可以不用写很多的findViewById()语句,以及通过getResources获取String、Color等资源,这可以让我们的代码更加简洁,使用起来也很方便。下面来看怎么用吧!

首先当然是添加依赖(建议去github查看最新版本)

implementation 'com.jakewharton:butterknife:9.0.0-rc2'
annotationProcessor 'com.jakewharton:butterknife-compiler:9.0.0-rc2'

接下来要在Activity中进行绑定:

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

需要注意的是:

  1. Butterkinife.bind(this) 必须在setContentView()后面;
  2. setContentView()不能通过注解实现;
  3. 在父类中绑定后,就不用在子类中再进行绑定了(因此,建议写一个BaseActivity,进行Activity绑定,然后让所有的Activity去继承BaseActivity)。
绑定控件

通常操作:

Button button = (Button)findViewById(R.id.button);

使用ButterKnife:

@BindView(R.id.button) Button button;

这里需要注意:使用ButterKnife注解的控件或资源不能用private等修饰符。

绑定资源

通常操作:

String str = getResources().getString(R.string.app_name);
int color = getResources().getColor(R.color.colorPrimary);
Drawable drawable = getResources().getDrawable(R.drawable.ic_launcher_background);

使用ButterKnife:

@BindString(R.string.app_name) String str;
@BindColor(R.color.colorPrimary) int color;
@BindDrawable(R.drawable.ic_launcher_background) Drawable drawable;

是不是高端大气上档次,简洁明了不啰嗦!!!

当然,在Fragment中使用也不是问题

public class LeftFragment extends Fragment {
    
    @BindView(R.id.button)
    Button button;

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment_left, container, false);
        ButterKnife.bind(this, view);
        return view;
    }
}

不过在Fragment中使用ButterKinfe时,我们需要在onDestroy方法中对其进行解绑,因此在Fragment中使用时我们要这样写:

public class LeftFragment extends Fragment {

    @BindView(R.id.button)
    Button button;

    private Unbinder unbinder;

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment_left, container, false);
        unbinder = ButterKnife.bind(this, view);
        return view;
    }

    @Override
    public void onDestroy() {
        super.onDestroy();
        unbinder.unbind();
    }
}

当我们调用 ButterKnife.bind() 方法时,会返回一个Unbinder对象,我们只需要重写onDestroy()方法,调用Unbinder对象的unbind()方法,进行解绑。

在Adapter里面也是可以用的

public class ListAdapter extends BaseAdapter {

    @Override
    public View getView(int position, View convertView, ViewGroup parent) {
        ViewHolder holder;
        if (convertView == null){
            convertView = mInflater.inflate(R.layout.item_article, parent, false);
            holder = new ViewHolder(convertView);
            convertView.setTag(holder);
        }else {
            holder = (ViewHolder)convertView.getTag();
        }
        return convertView;
    }

    public final class ViewHolder{
        @BindView(R.id.title) TextView mTitleText;
        @BindView(R.id.inform) TextView mInformText;

        public ViewHolder(View view){
            ButterKnufe.bind(this, view)
        }
    }
}

总之,任何需要 findViewById() 的地方都可以使用ButterKnife来简化代码。

前面只说了绑定View和资源,接下来当然是Listener啦

单个View监听
@OnClick(R.id.show)
public void show(){
    //TODO
}

@OnClick(R.id.show)
public void show(TextView textview){
    //TODO
}

@OnClick(R.id.show)
public void show(View view){
    //TODO
}

所有监听方法的参数都是可选的,可写可不写。

多个View监听
@OnClick({R.id.button1, R.id.button2, R.id.text})
public void show(View view){
    switch (view.getId()){
        case R.id.button1:
            //TODO
            break;
        case R.id.button2:
            //TODO
            break;
        case R.id.text:
            //TODO
            break;
        default:
            break;
    }
}


当然,这里所列举出来的都是一些比较常用的基本用法,如果你想了解更多关于ButterKnife的用法,可以去看看 JakeWharton 给出的文档。

补充:
如果在运行时报这个错误:

只需要在 app 的 build.gradle 文件中的 android 标签下 加上

android {
    ···
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

将JDK版本指定为1.8即可解决。

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

推荐阅读更多精彩内容