ButterKnife的使用详解

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/

 

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()不能通过注解实现。（其他的有些注解框架可以）
官网http://jakewharton.github.io/butterknife/
4,安装Butterknife插件自动生成功能.
file-->setting-->plugins-->Browse repositories-->
Android ButterKnife Zelezny-->install
-->点击Restart激活已安装的插件
5,项目配置：
1,在module的build.gradle 文件中的dependencies标签中添加代码如下（导入库的依赖）:
dependencies {
//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 类中绑定 ：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 修饰，否则会报错。
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布局文件的位置上，然后按快捷键Shift+Alt+S --> Alt+Insert -->Ctrl+Shif+F12，
//最后选择生成view和点击事件。

 

 

2.使用注意事项
1）ButterKinfe的注解标签因版本不同而有所变化。8.0.0之前的Bind标签在8.0.0之后变成了BindView，
2）默认情况下，@bind和 listener 的绑定是必需的。如果无法找到目标视图，将抛出一个异常。
要抑制此行为并创建可选绑定，可以将@Nullable注解添加到字段中，或将@Optional注解添加到方法。

 

3.绑定注解
@BindView---->绑定一个view；id为一个view 变量
@BindView(R.id.tv_fm1)
TextView tvFm1;
@BindViews ---->绑定多个view；id为一个view的list变量
@BindViews({ R.id.btn1,R.id.btn2 })
List buttons;
@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;

 

 

4,事件注解
@OnClick---->点击事件
@OnCheckedChanged ---->选中，取消选中
@OnEditorAction ---->软键盘的功能键
@OnFocusChange ---->焦点改变
@OnItemClick item---->被点击(注意这里有坑，如果item里面有Button等这些有点击的控件事件的，需要设置这些控件属性focusable为false)
@OnItemLongClick item---->长按(返回真可以拦截onItemClick)
@OnItemSelected ---->item被选择事件
@OnLongClick ---->长按事件
@OnPageChange ---->页面改变事件
@OnTextChanged ---->EditText里面的文本变化事件
@OnTouch ---->触摸事件

 

 

5,绑定view

1）@BindView() : 布局id 注解
@BindView( R2.id.button)
public Button button;
button 的修饰类型不能是：private 或者 static 。

2）@BindViews(): 布局内多个控件 id 注解
@BindViews({ R2.id.button1, R2.id.button2, R2.id.button3})
public List

buttonList ;
ButterKnife.bind(this);
buttonList.get( 0 ).setText( "hello 1 ");
buttonList.get( 1 ).setText( "hello 2 ");
buttonList.get( 2 ).setText( "hello 3 ");

 

 

 

6.绑定资源
1）@BindString() ：绑定string 字符串
@BindString(R2.string.app_name) //绑定资源文件中string字符串
String str;
button.setText( str );

2）@BindArray() : 绑定string里面array数组
@BindArray(R2.array.city) //绑定string里面array数组
String [] citys ;
button.setText(citys[0]);

3）@BindBitmap( ) : 绑定Bitmap 资源
@BindBitmap(R2.drawable.bm)//绑定Bitmap 资源
public Bitmap bitmap ;
imageView.setImageBitmap(bitmap);
drawable文件夹下的图片使用R或R2引用都没问题；但是mipmap文件夹下的图片资源引用目前只能使用R

4）@BindColor( ) : 绑定一个颜色值
@BindColor( R2.color.colorAccent ) //具体色值在color文件中
int black ; //绑定一个颜色值
button.setTextColor( black );

 

 

 

7,点击事件绑定
不用声明view，不用setOnClickLisener（）就可以绑定点击事件
1）绑定事件
@OnClick( ) : 绑定控件点击事件
@OnLongClick( ) ： 绑定控件长按事件
@OnClick(R2.id.button1 ) //给 button1 设置一个点击事件
public void showToast(){
Toast.makeText(this, "is a click", Toast.LENGTH_SHORT).show();
}

@OnLongClick( R2.id.button1 )//给 button1 设置一个长按事件
public boolean showToast2(){
Toast.makeText(this, "is a long click", Toast.LENGTH_SHORT).show();
return true ;
}

2）指定多个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;
}
}
多条点击事件不可以用R2的方式
如果一定要使用R2的写法，可以单一逐次写

3）自定义View使用注解事件
不用指定id，直接注解OnClick
public class MyButton extends Button {
@OnClick
public void onClick() {}
}

 

 

8,.使用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({R2.id.first_name, R2.id.middle_name, R2.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值是可以传递的
}
};
}
8,Butter Knife的代码混淆
在混淆文件中，添加如下代码：
-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }

-keepclasseswithmembernames class * {
@butterknife.* ;
}

-keepclasseswithmembernames class * {
@butterknife.* ;
}

代码实现：

 

 1 public class MainActivity extends AppCompatActivity {
 2 
 3     @BindView(R.id.tv)
 4     TextView tv;
 5 
 6     @Override
 7     protected void onCreate(Bundle savedInstanceState) {
 8         super.onCreate(savedInstanceState);
 9         setContentView(R.layout.activity_main);
10         ButterKnife.bind(this);
11         tv.setText("ButterKnife,在Activity中使用!");
12     }
13 
14 
15     @OnClick(R.id.tv)
16     public void onViewClicked() {
17         DemonstrateUtil.showToastResult(this,"布局中含有Fragment!");
18     }
19 }

 

 

 

 

 

 

 

 1 public class TempActivity extends AppCompatActivity {
 2 
 3     @BindView(R.id.btn)
 4     Button btn;
 5     @BindView(R.id.tv)
 6     TextView tv;
 7     @BindView(R.id.iv)
 8     ImageView iv;
 9 
10     @Override
11     protected void onCreate(Bundle savedInstanceState) {
12         super.onCreate(savedInstanceState);
13         setContentView(R.layout.activity_temp);
14         ButterKnife.bind(this);
15         tv.setTextColor(getResources().getColor(R.color.colorAccent));
16         tv.setText("ButterKnife!");
17     }
18 
19     @OnClick(R.id.btn)
20     public void onViewClicked() {
21         DemonstrateUtil.showLogResult("OnClick");
22         DemonstrateUtil.showToastResult(this,"OnClick");
23     }

 

 

 

 

 1 public class Temp2Activity extends AppCompatActivity {
 2 
 3     @BindView(R.id.iv1)
 4     ImageView iv1;
 5     @BindView(R.id.tv1)
 6     TextView tv1;
 7 
 8     @Override
 9     protected void onCreate(Bundle savedInstanceState) {
10         super.onCreate(savedInstanceState);
11         setContentView(R.layout.activity_temp2);
12         ButterKnife.bind(this);
13     }
14 
15     @OnClick(R.id.tv1)
16     public void onViewClicked() {
17     }
18 }

 

 

 

 1 public class MyAdapter extends BaseAdapter {
 2 
 3 
 4 
 5     private List mList;
 6 
 7     public MyAdapter(List list) {
 8         mList = list;
 9     }
10 
11     @Override
12     public int getCount() {
13         return mList == null ? 0 : mList.size();
14     }
15 
16     @Override
17     public Object getItem(int position) {
18         return mList.get(position);
19     }
20 
21     @Override
22     public long getItemId(int position) {
23         return position;
24     }
25 
26     @Override
27     public View getView(int position, View convertView, ViewGroup parent) {
28         ViewHolder viewHolder = null;
29         if (convertView == null) {
30             convertView = View.inflate(parent.getContext(), R.layout.item_list, null);
31             viewHolder = new ViewHolder(convertView);
32             convertView.setTag(viewHolder);
33         } else {
34             viewHolder = (ViewHolder) convertView.getTag();
35         }
36         viewHolder.tvItem.setText(mList.get(position).name);
37         if (position % 2 == 0) {
38             viewHolder.iv.setImageBitmap(viewHolder.bitmap);
39         }else {
40             viewHolder.iv.setImageResource(R.mipmap.ic_launcher_round);
41         }
42         return convertView;
43     }
44 
45     static class ViewHolder {
46         @BindView(R.id.tv_item)
47         TextView tvItem;
48         @BindView(R.id.iv)
49         ImageView iv;
50         @BindBitmap(R.mipmap.ic_launcher)
51         Bitmap bitmap;
52         ViewHolder(View view) {
53             ButterKnife.bind(this, view);
54         }
55     }
56 
57 }

 

 

 

 1 public class BlankFragment extends Fragment {
 2 
 3 
 4     @BindView(R.id.tv_fm1)
 5     TextView tvFm1;
 6     Unbinder unbinder;
 7     @BindViews({ R.id.btn1,R.id.btn2 })
 8     List

buttons; 9 @BindColor(R.color.colorAccent) 10 int colorAccent; 11 12 13 @Override 14 public View onCreateView(LayoutInflater inflater, ViewGroup container, 15 Bundle savedInstanceState) { 16 View view = View.inflate(getContext(), R.layout.fragment_blank, null); 17 unbinder = ButterKnife.bind(this, view); 18 tvFm1.setText("fragment中使用ButterKnife!"); 19 tvFm1.setTextColor(colorAccent); 20 Button btn2 = buttons.get(1); 21 btn2.setText("适配器使用ButterKnife"); 22 return view; 23 } 24 25 @Override 26 public void onDestroyView() { 27 super.onDestroyView(); 28 unbinder.unbind(); 29 } 30 31 @OnClick({R.id.btn1, R.id.btn2}) 32 public void onViewClicked(View view) { 33 switch (view.getId()) { 34 case R.id.btn1: 35 DemonstrateUtil.showToastResult(getContext(),"fragment中的第1个按钮!"); 36 break; 37 case R.id.btn2: 38 startActivity(new Intent(getActivity(),AdpActivity.class)); 39 break; 40 } 41 } 42 }

 

 

 

 1 public class AdpActivity extends AppCompatActivity {
 2 
 3     @BindView(R.id.lv)
 4     ListView lv;
 5 
 6     @BindArray(R.array.names)
 7     String[] names;
 8 
 9     @Override
10     protected void onCreate(Bundle savedInstanceState) {
11         super.onCreate(savedInstanceState);
12         setContentView(R.layout.activity_adp);
13         ButterKnife.bind(this);
14         List list = new ArrayList<>();
15         for (int i = 0; i < names.length; i++) {
16             ItemInfo info = new ItemInfo();
17             info.name = names[i];
18             info.age = "age"+i;
19             list.add(info);
20         }
21         lv.setAdapter(new MyAdapter(list));
22     }
23 
24 }