1 简介
ButterKnife是一个专注于Android系统的View注入框架(Github地址)。
以前总是要写很多findViewById来找到View对象,有了ButterKnife可以很轻松的省去这些步骤。是大神JakeWharton的力作,目前使用很广。
使用ButterKnife对性能基本没有损失,因为ButterKnife用到的注解并不是在运行时反射的,而是在编译的时候生成新的class。
项目集成起来也是特别方便,使用起来也是特别简单。
2 依赖和混淆规则
implementation 'com.jakewharton:butterknife:10.2.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:10.2.1'
混淆规则:
# butterknife
-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }
-keepclasseswithmembernames class * {
@butterknife.* <fields>;
}
-keepclasseswithmembernames class * {
@butterknife.* <methods>;
}
}
3 使用
3.1 注意事项
1、在Activity 类中绑定 :ButterKnife.bind(this);必须在setContentView();之后绑定;且父类bind绑定后,子类不需要再bind。
2、在非Activity 类(eg:Fragment、ViewHold)中绑定: ButterKnife.bind(this,view);这里的this不能替换成getActivity()。
3、在Activity中不需要做解绑操作,在Fragment 中必须在onDestroyView()中做解绑操作。
4、使用ButterKnife修饰的方法和控件,不能用private or static 修饰,否则会报错。错误: @BindView fields must not be private or static. (com.zyj.wifi.ButterknifeActivity.button1)
5、setContentView()不能通过注解实现。(其他的有些注解框架可以)
6、使用Activity为根视图绑定任意对象时,如果你使用类似MVC的设计模式你可以在Activity 调用ButterKnife.bind(this, activity),来绑定Controller。
7、使用ButterKnife.bind(this,view)绑定一个view的子节点字段。如果你在子View的布局里或者自定义view的构造方法里 使用了inflate,你可以立刻调用此方法。或者,从XML inflate来的自定义view类型可以在onFinishInflate回调方法中使用它。
3.2 ButterKnife的注册与绑定
3.2.1 在Activity中绑定ButterKnife
在Activity中的onCreate绑定Activity,建议写一个BaseActivity完成绑定,子类继承。
绑定Activity 必须在setContentView之后。
public class MainActivity extends AppCompatActivity{
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
ButterKnife.bind(this);//绑定初始化ButterKnife
}
}
3.2.2 在Fragment中绑定ButterKnife
在onCreateView中绑定一个Fragment时,在onDestroyView中将视图设置为null。
当你调用bind来为你绑定一个Fragment时,Butter Knife会返回一个Unbinder的实例。
在适当的生命周期(onDestroyView)回调中调用它的unbind方法进行Fragment解绑。
public class ButterknifeFragment extends Fragment{
private Unbinder unbinder;
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fragment, container, false);
//返回一个Unbinder值(进行解绑),注意这里的this不能使用getActivity()
unbinder = ButterKnife.bind(this, view);
return view;
}
/**
* onDestroyView中进行解绑操作
*/
@Override
public void onDestroyView() {
super.onDestroyView();
unbinder.unbind();
}
}
3.2.3 在Adapter中绑定ButterKnife
在Adapter的ViewHolder中使用,将ViewHolder加一个构造方法,在new ViewHolder的时候把view传递进去。
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.testlayout, parent, false);
holder = new ViewHolder(view);
view.setTag(holder);
}
holder.name.setText("Donkor");
holder.job.setText("Android");
// etc...
return view;
}
static class ViewHolder {
@BindView(R.id.title)
TextView name;
@BindView(R.id.job)
TextView job;
public ViewHolder(View view) {
ButterKnife.bind(this, view);
}
}
}
3.3 ButterKnife的基本使用
3.3.1 绑定注解
@BindView | 绑定一个view;id为一个view 变量 | @BindView(R.id.button1) Button button1; |
@BindViews | 绑定多个view;id为一个view的list变量 | @BindViews({R.id.button1,R.id.button2}) List buttonList; |
@BindArray | 绑定string里面array数组; | @BindArray(R.array.city ) String[] citys ; |
@BindBitmap | 绑定图片资源为Bitmap; | @BindBitmap( R.mipmap.wifi ) Bitmap bitmap; |
@BindBool | 绑定boolean值 | |
@BindColor | 绑定color; | @BindColor(R.color.colorAccent) int black; |
@BindDimen | 绑定Dimen; | @BindDimen(R.dimen.borth_width) int mBorderWidth; |
@BindDrawable | 绑定Drawable; | @BindDrawable(R.drawable.test_pic) Drawable mTestPic; |
@BindFloat | 绑定float | |
@BindInt | 绑定int | |
@BindString | 绑定一个String id为一个String变量; | @BindString( R.string.app_name ) String meg; |
3.3.2 事件注解
@OnClick | 点击事件 |
@OnLongClick | 长按事件 |
@OnCheckedChanged | 选中,取消选中 |
@OnTouch | 触摸事件 |
@OnTextChanged | EditText里面的文本变化事件 |
@OnEditorAction | 软键盘的功能键 |
@OnFocusChange | 焦点改变 |
@OnItemClick item | 被点击(注意这里有坑,如果item里面有Button等这些有点击的控件事件的,需要设置这些控件属性focusable为false) |
@OnItemLongClick item | 长按(返回真可以拦截onItemClick) |
@OnItemSelected | item被选择事件 |
@OnPageChange | 页面改变事件 |
@Optional | 选择性注入,如果当前对象不存在,就会抛出一个异常,为了压制这个异常,可以在变量或者方法上加入一下注解,让注入变成选择性的,如果目标View存在,则注入, 不存在,则什么事情都不做 |
3.4 Butterknife插件:zelezny