Android依赖注入框架：ButterKnife 8.4.0新版本导入及使用详解

一直在使用 Butter Knife的同志们应该知道此库不断更新，现在导入主要是运用 android-apt，而且使用方法有了细微变化，下面来依次介绍。

官方文档在此： https://github.com/JakeWharton/butterknife

导入到项目中

1. 在项目中的 build.gradle 中包含“android-apt”插入

buildscript {
  repositories {
    mavenCentral()
   }
  dependencies {
    classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
  }
}

【截图如下：】

---

2. 在app文件夹中的 build.gradle中插入android-apt”和 添加 “Butter Knife ”的依赖

apply plugin: 'android-apt'

android {
  ...
}

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

【截图如下：】

---

---

基本使用

以上再编译即可，下面介绍基本应用：

1. @BindView 绑定 view ID

@BindView用来注解布局中的view ID
【举例：】

class ExampleActivity extends Activity {
  @BindView(R.id.title) TextView title;
  @BindView(R.id.subtitle) TextView subtitle;
  @BindView(R.id.footer) TextView footer;


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

代替了速度慢的反射，生成的代码来执行视图View，调用bind委托给生成的代码。上面的示例生成的代码大致相当于下面的：

public void bind(ExampleActivity activity) {
  activity.subtitle = (android.widget.TextView) activity.findViewById(2130968578);
  activity.footer = (android.widget.TextView) activity.findViewById(2130968579);
  activity.title = (android.widget.TextView) activity.findViewById(2130968577);
}

---

---

2. RESOURCE BINDING 资源绑定

可绑定预先定义好的资源，如：@BindBool, @BindColor, @BindDimen, @BindDrawable, @BindInt, @BindString：

class ExampleActivity extends Activity {
  @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
  // ...
}

---

---

3. 非 Activity 绑定

您也可以通过提供您自己的视图根来执行任意对象的绑定。

public class FancyFragment extends Fragment {
  @BindView(R.id.button1) Button button1;
  @BindView(R.id.button2) Button button2;

  @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;
  }
}

---

---

3. 简化适配器Adapter

简化列表适配器的视图保持器模式。

public class MyAdapter extends BaseAdapter {
  @Override public View getView(int position, View view, ViewGroup parent) {
    ViewHolder holder;
    if (view != null) {
      holder = (ViewHolder) view.getTag();
    } else {
      view = inflater.inflate(R.layout.whatever, parent, false);
      holder = new ViewHolder(view);
      view.setTag(holder);
    }

    holder.name.setText("John Doe");
    // etc...

    return 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);
    }
  }
}

---

---

以上几个例子介绍，可得ButterKnife 中的bind可以用在任何需要findviewById的地方。

以活动为视图根绑定任意对象。如果你使用一个模式MVC可以绑定控制器利用其活性与butterknife。绑定ButterKnife.bind(this, activity).（这个活动）

---

---

4. VIEW LISTS 绑定一个View集合

您可以将多个视图组到一个列表或数组中。

@BindViews({ R.id.first_name, R.id.middle_name, R.id.last_name })
List<EditText> nameViews;

---

应用方法允许你立即显示一个列表中的所有视图：

ButterKnife.apply(nameViews, DISABLE);
ButterKnife.apply(nameViews, ENABLED, false);

---

Action 和 Setter接口允许指定简单的行为

static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
  @Override public void apply(View view, int index) {
    view.setEnabled(false);
  }
};
static final ButterKnife.Setter<View, Boolean> ENABLED = new ButterKnife.Setter<View, Boolean>() {
  @Override public void set(View view, Boolean value, int index) {
    view.setEnabled(value);
  }
};

---

一个安卓属性也可以使用的应用方法。：

ButterKnife.apply(nameViews, View.ALPHA, 0.0f);

---

---

4. LISTENER BINDING 监听器绑定

LISTENER 可以自动地配置到方法上。

@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!");
}

---

在一个绑定中指定常见事件处理的多个标识。

@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();
  }
}

---

自定义视图可以绑定到自己的侦听器，通过不指定ID：

public class FancyButton extends Button {
  @OnClick
  public void onClick() {
    // TODO do something!
  }
}

---

---

5. BINDING RESET 解除绑定（fragment）

fragment相较于activity有一个不同的生命周期，当fragment 在 onCreateView方法中绑定ButterKnife时，在ondestroyview 方法中将view 设置null。当你调用绑定时ButterKnife 返回一个unbinder实例，调用它的破解方法在适当的生命周期回调。

public class FancyFragment extends Fragment {
  @BindView(R.id.button1) Button button1;
  @BindView(R.id.button2) Button button2;
  private Unbinder unbinder;

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

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

---

---

6. OPTIONAL BINDINGS 可选择的绑定

默认情况下，@Bind 和 监听器Listener 绑定都是必需的。如果找不到目标视图，则将引发异常。

为了制止这种行为，创建一个可选的绑定，添加一个“@nullable” 或者 “@Optional”可选的注释。

@Nullable @BindView(R.id.might_not_be_there) TextView mightNotBeThere;

@Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {
  // TODO ...
}

---

---

7. MULTI-METHOD LISTENERS 多种方法的监听器

方法标注其相应的听众有多个回调函数可用于绑定到他们中的任何一个。每个注释都有一个绑定到的默认回调函数。使用回调参数指定另一个。

@OnItemSelected(R.id.list_view)
void onItemSelected(int position) {
  // TODO ...
}

@OnItemSelected(value = R.id.maybe_missing, callback = NOTHING_SELECTED)
void onNothingSelected() {
  // TODO ...
}

---

---

8. BONUS

还包括findById方法简化代码，还可以找到一个视图，视图的活动，或对话框。它使用泛型来推断返回类型，并自动执行转换类型。

View view = LayoutInflater.from(context).inflate(R.layout.thing, null);
TextView firstName = ButterKnife.findById(view, R.id.first_name);
TextView lastName = ButterKnife.findById(view, R.id.last_name);
ImageView photo = ButterKnife.findById(view, R.id.photo);

---

---

---

以上使用的方法，翻译于
http://jakewharton.github.io/butterknife/
这个库还是很强大的，用者自行体会的到

希望对你们有帮助 ：）