ButterKnife的使用详解
1,概述:
ButterKnife则是注解中相对简单易懂的很不错的开源框架.
ButterKnife是目前常用的一种依托Java注解机制实现辅助代码生成的框架；用到了注解处理器。
它是一个专注于Android系统的View注入框架,将Android视图和回调方法绑定到成员变量和方法上；可视化一键生成；可以减少大量的findViewById以及setOnClickListener代码，是注解中相对简单易懂的开源框架 。
原理：利用了IOC的(Inverse of Controll)控制反转结构，2004年后改名为DI(dependency injection)依赖注入。目的是为了使类与类之间解耦合，提高系统的可扩展性和可维护性。
翻译:黄油刀/
英文使用说明地址：http://jakewharton.github.io/butterknife/
API文档地址：http://jakewharton.github.io/butterknife/javadoc/
GitHub源码地址：
https://github.com/JakeWharton/butterknife/blob/master/CHANGELOG.md#version-800-2016-04-25
2,ButterKnife 优势：
- 1.强大的View绑定和Click事件处理功能，简化代码，提升开发效率
- 2.方便的处理Adapter里的ViewHolder绑定问题
- 3.运行时不会影响APP效率，使用配置方便
- 4.代码清晰，可读性强
3,注意事项
使用心得：
1.Activity ButterKnife.bind(this);必须在setContentView();之后，且父类bind绑定后，子类不需要再bind
2.Fragment ButterKnife.bind(this, mRootView);
3.属性布局不能用private or static 修饰，否则会报错
4.setContentView()不能通过注解实现。（其他的有些注解框架可以）
4,安装Butterknife插件自动生成功能.
file-->
setting-->
plugins-->
Browse repositories-->
Android ButterKnife Zelezny-->
install-->
点击Restart激活已安装的插件
5,项目配置：
1,在module的build.gradle 文件中的dependencies标签中添加代码如下（导入库的依赖）:
dependencies {
annotationProcessor 'com.jakewharton:butterknife:10.2.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:10.2.1'
implementation 'com.jakewharton:butterknife:10.2.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:10.2.1'
//compile 'com.jakewharton:butterknife:8.8.1'
//implementation 'com.jakewharton:butterknife:8.8.1'
//annotationProcessor 'com.jakewharton:butterknife-compiler:8.8.1'
}
6,Butter Knife的注册绑定
- 6.1使用注意事项
（注：不理解可以继续往下看，都有详细说明，或者自己动手写写就明白了。）- 1）在Activity 类中绑定 ：
必须在setContentView();之后绑定；且父类bind绑定后，子类不需要再bind。
- 1）在Activity 类中绑定 ：
ButterKnife.bind(this);
2）在非Activity 类（eg：Fragment、ViewHold）中绑定： ButterKnife.bind(this，view);
这里的this不能替换成getActivity（）。3）在Activity中不需要做解绑操作，在Fragment 中必须在onDestroyView()中做解绑操作。
4）使用ButterKnife修饰的方法和控件，不能用private or static 修饰，否则会报错。
5）setContentView()不能通过注解实现。（其他的有些注解框架可以）
6）使用Activity为根视图绑定任意对象时，如果你使用类似MVC的设计模式你可以在Activity 调用ButterKnife.bind(this, activity)，来绑定Controller。
7）使用ButterKnife.bind(this，view)绑定一个view的子节点字段。如果你在子View的布局里或者自定义view的构造方法里 使用了inflate,你可以立刻调用此方法。或者，从XML inflate来的自定义view类型可以在onFinishInflate回调方法中使用它。
6.2在Activity中绑定ButterKnife
ButterKnife.bind(this);6.3在Fragment中绑定ButterKnife
ButterKnife.bind(this, view);-
6.4在Adapter中绑定ButterKnife
ButterKnife.bind(this, 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("诺诺");
// 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);
}
}
}
7,Butter Knife的使用
1.快速生成注解view和onclick代码
首先将鼠标放置在初始化view布局文件的位置上，然后按快捷键
Alt+Insert -->Generate Butterknife Injections
最后选择生成view和点击事件。
2.使用注意事项
1）ButterKinfe的注解标签因版本不同而有所变化。8.0.0之前的Bind标签在8.0.0之后变成了BindView，
2）默认情况下，@bind和 listener 的绑定是必需的。如果无法找到目标视图，将抛出一个异常。
要抑制此行为并创建可选绑定，可以将@Nullable注解添加到字段中，或将@Optional注解添加到方法。
3.绑定view注解
@BindView---->绑定一个view；id为一个view 变量
修饰类型不能是：private 或者 static
@BindView(R.id.tv_fm1)
TextView tvFm1;
@BindViews ---->绑定多个view
@BindViews: 布局内多个控件 id 注解
@BindViews({ R.id.button1, R.id.button2, R.id.button3})
public List代码中的实力使用
buttonList.get( 0 ).setText( "hello 1 ");
buttonList.get( 1 ).setText( "hello 2 ");
buttonList.get( 2 ).setText( "hello 3 ");
4.绑定资源注解
@BindString ---->绑定一个String
@BindString(R.string.app_name )
String meg;
@BindString(R.string.app_name) //绑定资源文件中string字符串
String str;
button.setText( str );
@BindArray---->绑定string里面array数组；
@BindArray(R.array.city )
String[] citys ;
@BindBitmap---->绑定图片资源为Bitmap；
@BindBitmap(R.mipmap.wifi )
Bitmap bitmap;
@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;
@BindBool ---->绑定boolean值
@BindFloat ---->绑定float
@BindInt ---->绑定int
5,ButterKnife事件注解
@OnClick---->点击事件,点击事件绑定
不用声明view，不用setOnClickLisener（）就可以绑定点击事件
//给 button1 设置一个点击事件
@OnClick(R.id.button1 )
public void showToast(){
Toast.makeText(this, "is a click", Toast.LENGTH_SHORT).show();
}
指定多个id绑定事件
@OnClick({R.id.ll_product_name, R.id.ll_product_lilv, R.id.ll_product_qixian, R.id.ll_product_repayment_methods})
public void onViewClicked(View view) {
switch (view.getId()) {
case R.id.ll_product_name:
System.out.print("我是点击事件1");
break;
case R.id.ll_product_lilv:
System.out.print("我是点击事件2");
break;
case R.id.ll_product_qixian:
System.out.print("我是点击事件3");
break;
case R.id.ll_product_repayment_methods:
System.out.print("我是点击事件4");
break;
}
}
@OnCheckedChanged ---->选中，取消选中
@OnCheckedChanged({R.id.rb_praise, R.id.rb_tread})
void OnCheckedChangeListener(CompoundButton view, boolean ischanged) {
switch (view.getId()) {
case R.id.rb_praise:
if (ischanged) {
Toast.makeText(this, "赞了!", Toast.LENGTH_SHORT).show();
}
break;
case R.id.rb_tread:
if (ischanged) {
Toast.makeText(this, "踩了!", Toast.LENGTH_SHORT).show();
}
break;
default:
break;
}
}
@OnEditorAction ---->软键盘的功能键
@OnFocusChange ---->焦点改变
@OnItemClick item---->被点击(注意这里有坑，如果item里面有Button等这些有点击的控件事件的，需要设置这些控件属性focusable为false)
@OnItemLongClick item---->长按(返回真可以拦截onItemClick)
@OnItemSelected ---->item被选择事件
@OnLongClick ---->绑定控件长按事件
//给 button1 设置一个长按事件
@OnLongClick( R.id.button1 )
public boolean showToast2(){
Toast.makeText(this, "is a long click", Toast.LENGTH_SHORT).show();
return true ;
}
@OnPageChange ---->页面改变事件
@OnTextChanged ---->EditText里面的文本变化事件
@OnTextChanged(R.id.et_photo_describe)
public void onTextChanged(CharSequence text) {
ImageInfo imageInfo = mImageInfos.get(mPosition);
if (imageInfo != null) {
imageInfo.photoDescribe = text.toString();
}
}
@OnTouch ---->触摸事件
@OnTouch(R.id.recycler_view3)
public boolean onRvTouch(View v, MotionEvent event){
if (event.getAction() == MotionEvent.ACTION_UP) {
layoutView3.performClick(); //模拟父控件的点击
}
return false;
}
6,使用findById
Butter Knife仍然包含了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 iv = ButterKnife.findById(view, R.id.iv);
9,设置多个view的属性
允许您立即对列表中的所有视图进行操作
apply()
Action和Setter接口允许指定简单的行为
Action和Setter接口
public class ButterknifeActivity extends AppCompatActivity {
@BindViews({R.id.first_name, R.id.middle_name, R.id.last_name})
List nameViews;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_butterknife);
//绑定activity
ButterKnife.bind(this);
//看不懂的小伙伴，多敲几遍代码，实际操作一下自然就懂了。相信我！如果你重复敲了10遍以上的代码，并认真思考了还没懂，欢迎给我评论留言。
//设置多个view的属性
//方式1：传递值
ButterKnife.apply(nameViews, DISABLE);
//方式2：指定值
ButterKnife.apply(nameViews, ENABLED, false);
////方式3 设置View的Property
ButterKnife.apply(nameViews, View.ALPHA, 0.0f);//一个Android属性也可以用于应用的方法。
}
/*
* Action接口设置属性
*/
static final ButterKnife.Action DISABLE = new ButterKnife.Action() {
@Override
public void apply(View view, int index) {
view.setEnabled(false);//目的是使多个view都具备此属性
}
};
/*
* Setter接口设置属性
*/
static final ButterKnife.Setter ENABLED = new ButterKnife.Setter() {
@Override
public void set(View view, Boolean value, int index) {
view.setEnabled(value);//目的是使多个view都具备此属性，可变boolean值是可以传递的
}
};
}
7,Butter Knife的代码混淆
在混淆文件中，添加如下代码：
-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }
-keepclasseswithmembernames class * {
@butterknife.* ;
}
-keepclasseswithmembernames class * {
@butterknife.* ;
}
附录:
ButterKnife
https://github.com/zhang721688/ButterKnife
Android Studio 3.0 butterknife:7.0.1配置问题