官方原文链接
其他不错的翻译
这里只是作为笔记,还有我还没过四级。。。。。
介绍(基于butterKnife 8.4.0)
GRADLE 导入
compile 'com.jakewharton:butterknife:8.5.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1'
通过@BindView
来注释字段,同时为butterknife提供一个View的ID使其能在你的布局(layout)中找到并自动构造相应的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...
}
}
代替慢反射,代码生成于执行视图查找之前。调用Bind代表给你所能看见和调试的生成代码。
上述示例的生成代码大致相当与下列代码:
public void bind(ExampleActivity activity) {
//省去了烦人的findViewById
activity.subtitle = (android.widget.TextView) activity.findViewById(2130968578);
activity.footer = (android.widget.TextView) activity.findViewById(2130968579);
activity.title = (android.widget.TextView) activity.findViewById(2130968577);
}
RESOURCE BINDING (资源约束)
用@BindBool
, @BindColor
, @BindDimen
, @BindDrawable
, @BindInt
, @BindString
绑定预定义资源。方法是通过绑定一个r.bool ID(或您指定的类型)到其相应的字段。
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
// ...
}
NON-ACTIVITY BINDING(非Activity中绑定)
你还可以通过提供相应的视图(View)来绑定相应的对象。
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适配器里的viewHolder。
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()
。
其他的绑定API:
- 如果使用的是MVC模式,则可以通过
ButterKnife.bind(this, activity)
在controller绑定。 - 使用ButterKnife.bind(this)绑定一个布局的孩子布局到字段上。如果你在布局中使用了
标签并且在自定义的控件构造时inflate了这个布局,你可以在inflate之后立即调用它。或者,你可以在onFinishInflate()回调中使用它。
VIEW LISTS(视图列表)
你可以将多个视图放入一个list或数组中。
@BindViews({ R.id.first_name, R.id.middle_name, R.id.last_name })
List nameViews;
apply
方法允许你对列表中的所有视图立即执行。
ButterKnife.apply(nameViews, DISABLE);
ButterKnife.apply(nameViews, ENABLED, false);
Action 和 Setter接口允许指定简单的行为
static final ButterKnife.Action DISABLE = new ButterKnife.Action() {
@Override public void apply(View view, int index) {
view.setEnabled(false);
}
};
static final ButterKnife.Setter ENABLED = new ButterKnife.Setter() {
@Override public void set(View view, Boolean value, int index) {
view.setEnabled(value);
}
};
一个android的Property
也能用apply
方法。
LISTENER BINDING(监听绑定)
监听也能自动配置到方法上面
@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) {
//通常在这里面使用switch来进行多个点击操作监听
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!
}
}
BINDING RESET(绑定复位)
fragment有一个不同于Activity的生命周期。在onCreate
中绑定fragment,在onDestoryView
中设置View为null。当你调用bind
的为你做这个的时候,ButterKnife会返回一个unbind
实例。在适当的生命周期回调中调用其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();
}
}
OPTIONAL BINDINGS(可选绑定)
默认情况下,@Bind
和侦听器绑定都是必需的。如果找不到目标视图,将抛出异常。
要抑制这种行为和创建一个可选的绑定,添加一个@Nullable
给字段或添加一个@Optional
给方法。
注意:任何名为@Nullable
的注释都可用于字段。我们鼓励使用Android的“support-annotations”库中的@Nullable
注释。
@Nullable @BindView(R.id.might_not_be_there) TextView mightNotBeThere;
@Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {
// TODO ...
}
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 ...
}
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);
为ButterKnife.findById
添加静态导入,并开始使用吧。