在Android编程我们要使布局文件如TextView、Button、ImageView与代码关联起来就要使用到FindViewById这个方法,要为他们设置监听器的话就要setOnClickListener。虽然用起来很简单,但如果布局控件一旦多了起来就会感觉很重复麻烦不便以后的维护,常常会使我们分不清楚哪个控件才是我们想使用的。
使用ButtonKnife的优势
- 强大的View绑定和Click事件处理功能,简化代码,提升开发效率
- 方便的处理Adapter里的ViewHolder绑定问题
- 运行时不会影响APP效率,使用配置方便
- 代码清晰,可读性强
配置ButtonKnife
在app->build gradle中添加依赖
compile 'com.jakewharton:butterknife:(butterknife:7.0.1)'
annotationProcessor 'com.jakewharton:butterknife-compiler:(butterknife:7.0.1)'
点击按钮:Sync Projects with Gradle Files重新编译即可。
常见使用ButtonKnife的方法:
绑定view
@Bind(R.id.tvTitle)
TextView mTvTitle;
@Bind(R.id.iv_avatar)
ImageView mIvAvatar;
@Bind(R.id.tv_author)
TextView mTvAuthor;
@Bind(R.id.tv_time)
TextView mTvTime;
@Bind(R.id.wv_content)
WebView mWvContent;
之后View对象就可以直接使用了.
需要注意的是View变量声明的时候不能为private或者static.
绑定资源文件
@BindString(R.string.app_name)
String appName;
@BindColor(R.color.red)
int textColor;
@BindDrawable(R.mipmap.ic_launcher)
Drawable drawable;//drawble
@Bind(R.id.imageview)
ImageView mImageView;
@Bind(R.id.checkbox)
CheckBox mCheckBox;
@BindDrawable(R.drawable.selector_image)
Drawable selector;
@BindString(R.string.app_name)
String appName;
@BindDrawable(R.mipmap.ic_launcher)
Drawable drawable;
为View设置监听
@OnClick(R.id.iv_avatar)
public void submit() {
// TODO submit data to server...
}
或者
@OnClick(R.id.iv_avatar)
public void submit(View view) {
// TODO submit data to server...
}
还可以批量为多个控件添加为同一个响应函数:
@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();
}
}
Fragment控件
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;
}
}
优化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("helloworld");
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);
}
}
}
可以看到ViewHolder类加了一个带参数View的构造方法,用注解标记每个字段,再也不需要在getView()方法里调用findViewById()方法了。
控件的批量操作
ButterKnife中还有一个好玩的地方莫过于控件的批量操作,我们可以定义统一的行为,来设置给某一组控件,比如我想给我某一组的TextView修改背景颜色,可以定义如下行为:
ButterKnife.Action CHANGECOLOR = new ButterKnife.Action() {
@Override
public void apply(@NonNull View view, int index) {
view.setBackgroundColor(Color.RED);
}
};
使用方式如下:
ButterKnife.apply(textViews, CHANGECOLOR);
其中textViews是一个TextView的集合。
如果你想给TextView设置不同的背景颜色,那么还可以这样来定义:
ButterKnife.Setter> CHANGECOLOR2 = new ButterKnife.Setter>() {
@Override
public void set(@NonNull View view, List value, int index) {
view.setBackgroundColor(value.get(index));
}
};
使用方式:
List colors = new ArrayList<>();
colors.add(Color.RED);
colors.add(Color.GREEN);
colors.add(Color.BLUE);
ButterKnife.apply(textViews,CHANGECOLOR2,colors);
注意
- ButtKnife初始化ButterKnife.bind(this)必须在加载布局资源之后(在setContentView(),Inflate等方法下面),所以ButterKnife不能在Application中初始化。
- ButtKnife在Fragment和Adapter中使用时,初始化代码有所不同,多了个参数VIew对象.ButterKnife.bind(this, mRootView);
- 使用ButterKnife设置控件点击事件,其方法权限必须在默认权限以上方可(包括默认权限)
参考文献:http://jakewharton.github.io/butterknife/