通过使用注解进行生成样板代码来完成Android view字段和方法的绑定。
＊在字段上使用@BindView消除findViewById。
＊可以在列表或数组中同时配置。使用action，setters，或properties一次性配置完毕。
＊通过@Onclick和其他的注解方法消除监听器的匿名内部类。
＊通过字段资源注解来消除资源查找。
class ExampleActivity extends Activity {
@BindView(R.id.user) EditText username;
@BindView(R.id.pass) EditText password;
@BindString(R.string.login_error) String loginErrorMessage;
@OnClick(R.id.submit) void submit() {
// TODO call server...
}
@Override public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.simple_activity);
ButterKnife.bind(this);
// TODO Use fields...
}
}
Butter knife是一把锋利的dragger
详细使用
使用@BindView和view的id来注解字段，这样Butter Knife会寻找和自动把布局中相应的view强转为相应类型。
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代理生成代码是看见的并且可以debug。
上方例子生成的代码大致等同于：
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);
}
资源绑定
使用@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
// ...
}
非activity绑定
可以绑定任意对象到你提供的view root上。
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;
}
}
另一种使用方法是简化list adapter内的view holder。
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);
}
}
}
可以在任何有findViewById调用的地方调用ButterKnife.bind。其他提供的API：
使用activity的时候绑定任何对象作为view的root。如果使用像MVC一样的模式，可以在activity中使用ButterKnife.bind(this,activity)来绑定controller。
使用ButterKnife.bind(this)来绑定一个view的子view到相应字段。如果在布局中使用<merge>标签，可以在自定义view构造函数之后立刻调用。另外，从xml解析的自定义view类型可以在onFinishInflate（）回调中使用。
view列表
可以用列表或数组来组织多个view。
@BindViews({ R.id.first_name, R.id.middle_name, R.id.last_name })
List<EditText> nameViews;
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);
}
};
Android属性也可以通过apply方法来使用。
ButterKnife.apply(nameViews, View.ALPHA, 0.0f);
监听器绑定
监听器也可以自动配置到相应方法。
@OnClick(R.id.submit)
public void submit(View view) {
// TODO submit data to server...
}
监听器的所有参数方法都是可选的。
@OnClick(R.id.submit)
public void submit() {
// TODO submit data to server...
}
定义一个指定类型，它会自动强转。
@OnClick(R.id.submit)
public void sayHi(Button button) {
button.setText("Hello!");
}
相同事件调用可以在一次绑定中指定多个ID。
@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();
}
}
自定义的view可以不指定ID来绑定他们的监听器。
public class FancyButton extends Button {
@OnClick
public void onClick() {
// TODO do something!
}
}
绑定重置
Fragment和activity的生命周期不同。当在onCreateView中绑定fragment，需要在onDestroyView中设置views为null。当你这么做的时候ButterKnife返回一个Unbinder的实例。在合适的生命周期回调中调用unbind方法。
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();
}
}
选项绑定
默认情况下，@Bind和监听器都是需要的。如果目标view没找到会抛出一个异常。
为了阻止这种情况发生并且创建一个optional bind，在字段上使用@Nullable注解或者在方法上使用@Optional注解。
注意：任意使用@Nullable的注解可以在字段上使用。鼓励使用来源于 Android's "support-annotations" library.的@Nullable注解。
@Nullable @BindView(R.id.might_not_be_there) TextView mightNotBeThere;
@Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {
// TODO ...
}
多个方法的监听器
有多个回调的监听器的方法注解可以绑定到他们中的任一一个。每个注解都有一个默认绑定的回调。使用callback参数来指定一个。
@OnItemSelected(R.id.list_view)
void onItemSelected(int position) {
// TODO ...
}
@OnItemSelected(value = R.id.maybe_missing, callback = NOTHING_SELECTED)
void onNothingSelected() {
// TODO ...
}
福利
可以通过findById方法来简化View，Activity，或Dialog中的代码。使用泛型来推断返回值并自动强转。
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);
添加static import的ButterKnife.findById会更有趣。
