Android注入框架Butter Knife使用入门

wshunli2018-01-182026-02-04

Butter Knife 是一个专注于 Android 系统的 View 注入框架，可以减少大量的 findViewById 以及 setOnClickListener 代码，可视化一键生成。

Butter Knife 概述

1.强大的View绑定和Click事件处理功能，简化代码，提升开发效率
2.方便的处理Adapter里的ViewHolder绑定问题
3.运行时不会影响APP效率，使用配置方便
4.代码清晰，可读性强

Butter Knife 上手使用

0、首先为项目添加 Butter Knife 依赖：

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

1、简单使用示例:

首先在 onCreate 绑定 Activity 实例。

package com.wshunli.butterknifedemo;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.Button;
import android.widget.Toast;

import butterknife.BindString;
import butterknife.BindView;
import butterknife.ButterKnife;
import butterknife.OnClick;

public class MainActivity extends AppCompatActivity {

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

    @BindString(R.string.app_name)
    String appName;

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

    }

    @OnClick(R.id.button)
    void clickButton() {
        Toast.makeText(this, appName, Toast.LENGTH_LONG).show();
    }

}

其中：@BindView 根据控件 id 绑定；@BindString 绑定资源中的字符串；@OnClick 绑定按钮的单击事件。

3、最终效果：

点击按钮，显示app名称。

最终效果

Butter Knife 方法详解

1、绑定 Activity 和 Fragment

在 onCreate 中绑定 Activity

@Override public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.simple_activity);
    ButterKnife.bind(this);
    // TODO Use fields...
  }

在 onCreateView 中绑定 Fragment

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

2、绑定布局中的 View

@BindView(R.id.title) TextView title;
@BindView(R.id.subtitle) TextView subtitle;
@BindView(R.id.footer) TextView footer;

3、在 Adapter ViewHolder 中绑定 View

static class ViewHolder {
  @BindView(R.id.title) TextView name;
  @BindView(R.id.job_title) TextView jobTitle;

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

4、绑定资源

@BindString(R.string.title) String title;
@BindDrawable(R.drawable.graphic) Drawable graphic;
@BindColor(R.color.red) int red; // int or ColorStateList field
@BindDimen(R.dimen.spacer) Float spacer; // int (for pixel size) or float (for exact value) field
// ...

5、绑定方法

@OnClick(R.id.submit)
public void submit() {
  // TODO submit data to server...
}

或者

@OnClick(R.id.submit)
public void submit(View view) {
  // TODO submit data to server...
}

甚至自动类型转换：

@OnClick(R.id.submit)
public void sayHi(Button button) {
  button.setText("Hello!");
}

多个 View 绑定同一个事件：

@OnClick({ R.id.door1, R.id.door2, R.id.door3 })
public void pickDoor(DoorView door) {
  if (door.hasPrizeBehind()) {
    Toast.makeText(this, "You win!", LENGTH_SHORT).show();
  } else {
    Toast.makeText(this, "Try again", LENGTH_SHORT).show();
  }
}

本文内容基于 Butter Knife 8.8.1 ，时间原因部分方法可能过时，最新版可参考 http://jakewharton.github.io/butterknife/

参考资料
1、JakeWharton/butterknife: Bind Android views and callbacks to fields and methods.
https://github.com/JakeWharton/butterknife
2、ButterKnife使用详解 - ITjianghuxiaoxiong的专栏 - CSDN博客
http://blog.csdn.net/itjianghuxiaoxiong/article/details/50177549