简介
Butter Knife使用注解来生成样板代码,实现Android视图的字段和方法绑定。
- 通过在字段上使用@BindView消除findViewById调用。
- 通过在方法上使用@OnClick或其他注解消除Listener的匿名内部类。
- 通过在字段上使用资源注解消除资源查找。
- 将多个View分组到列表或数组中,一次性使用action、setter或property同时对它们进行操作。
如何配置
在项目级别中的build.gradle,引入”android-apt”插件:
buildscript { repositories { mavenCentral() } dependencies { classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8' } }
在模型级别中的build.gradle中应用”android-apt”插件,并添加Butter Knife依赖:
apply plugin: 'android-apt' android { ... } dependencies { compile 'com.jakewharton:butterknife:8.2.1' apt 'com.jakewharton:butterknife-compiler:8.2.1' }
绑定字段
在字段上使用@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...
}
}
是不是摆脱了写findViewById的烦恼,同样在列表适配器的View Holder模式中,也可以使用Butter Knife。
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);
}
}
}
绑定Listener
在方法上使用注解(如@OnClick、@OnItemClick),Listener将自动配置到方法上。
对于方法的参数,有以下几种形式:
普通的View类型参数
@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... }
指定类型参数,Butter Knife会自动进行转换。
@OnClick(R.id.submit) public void sayHi(Button button) { button.setText("Hello!"); }
此外,如果多个View具有相同的事件处理方式,则可以在一个绑定中指定多个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可以绑定直接它们的listener,而不需要指定ID。
public class FancyButton extends Button {
@OnClick
public void onClick() {
// TODO do something!
}
}
绑定资源
可以使用@BindBool,@BindColor,@BindDimen,@BindDrawalbe,@BindInt,@BindString来绑定预定义的资源。Butter Knife会将一个ID指定资源的值赋给对应的字段。
class ExampleActivity extends Activity {
@BindString(R.string.title) String title;
@BindDrawable(R.drawable.graphic) Drawable graphic;
@BindColor(R.color.red) int red;
@BindDimen(R.dimen.spacer) Float spacer;
}
绑定多个View
通过@BindViews可以将多个View绑定到一个列表或数组中,之后就可以一次性地同时对它们进行操作了。
绑定多个View到列表中
@BindViews({ R.id.first_name, R.id.middle_name, R.id.last_name }) List<EditText> nameViews;
使用Action对Views进行操作
ButterKnife.apply(nameViews, DISABLE); static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() { @Override public void apply(View view, int index) { view.setEnabled(false); } };
使用Setter对View进行操作
ButterKnife.apply(nameViews, ENABLED, 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); } };
使用Property对View进行操作
ButterKnife.apply(nameViews, View.ALPHA, 0.0f);
实现原理
以下面的例子进行介绍。
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原理不是效率很低的反射,而是生成执行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);
延伸
绑定重置
Fragment与Activity的View生命周期不同。在onCreateView中绑定一个Fragment,在onDestroyView设置view为null。Butter Knife返回了一个Unbinder变量当你调用bind时。在合适的生命周期回调里调用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和listener是必须的。如果目标View没有找到,会抛出一个异常。
可以创建一个可选绑定来压制这种行为,添加一个@Nullable注解到字段,或@Optional注解到方法。
@Nullable @BindView(R.id.might_not_be_there) TextView mightNotBeThere;
@Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {
// TODO ...
}
福利
引入了findById方法,简化了在一个View、Activity或Dialog上查找View的代码。它使用泛型来推断返回类型并自动执行转换。
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);
官网链接:
https://github.com/JakeWharton/butterknife
解析系列: