Butter Knife 7.0.1 使用方法

Butter Knife , Android 视图中field和方法的绑定

带有“@Bind(R.id.xxx)” Butter Knife注解的域（或者叫字段）,Butter Knife 会自动在布局中查找相应的视图。

1.Activity中的绑定

[plain] view plain copy

1. class ExampleActivity extends Activity {  
2.   @Bind(R.id.title) TextView title;  
3.   @Bind(R.id.subtitle) TextView subtitle;  
4.   @Bind(R.id.footer) TextView footer;  
5.   
6.   @Override public void onCreate(Bundle savedInstanceState) {  
7.     super.onCreate(savedInstanceState);  
8.     setContentView(R.layout.simple_activity);  
9.     ButterKnife.bind(this);  
10.   
11.   }  
12. }  

代码通过执行视图查找，来取代速度较慢的反射。调用绑定注解生成的代码你可以看到并且可以进行调试。

上面的例子所生成的代码大致相当于以下：

[plain] view plain copy

1. public void bind(ExampleActivity activity) {  
2.   activity.subtitle = (android.widget.TextView) activity.findViewById(2130968578);  
3.   activity.footer = (android.widget.TextView) activity.findViewById(2130968579);  
4.   activity.title = (android.widget.TextView) activity.findViewById(2130968577);  
5. }  

2.资源绑定

通过预定义的注解（@BindBool, @BindColor, @BindDimen, @BindDrawable, @BindInt, @BindString）结合一个资源 ID以和表示该资源类型的相应的字段。

[plain] view plain copy

1. class ExampleActivity extends Activity {  
2.   @BindString(R.string.title) String title;  
3.   @BindDrawable(R.drawable.graphic) Drawable graphic;  
4.   @BindColor(R.color.red) int red;   
5.   @BindDimen(R.dimen.spacer) Float spacer;   
6.   // ...  
7. }  

3.Fragment中的绑定

你还可以通过提供你自己的根视图来执行任意对象的绑定。

[plain] view plain copy

1. public class FancyFragment extends Fragment {  
2.   @Bind(R.id.button1) Button button1;  
3.   @Bind(R.id.button2) Button button2;  
4.   
5.   @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {  
6.     View view = inflater.inflate(R.layout.fancy_fragment, container, false);  
7.     ButterKnife.bind(this, view);  
8.     return view;  
9.   }  
10. }  

4.List适配器中的用法

[plain] view plain copy

1. public class MyAdapter extends BaseAdapter {  
2.   @Override public View getView(int position, View view, ViewGroup parent) {  
3.     ViewHolder holder;  
4.     if (view != null) {  
5.       holder = (ViewHolder) view.getTag();  
6.     } else {  
7.       view = inflater.inflate(R.layout.whatever, parent, false);  
8.       holder = new ViewHolder(view);  
9.       view.setTag(holder);  
10.     }  
11.   
12.     holder.name.setText("测试");  
13.   
14.   
15.     return view;  
16.   }  
17.   
18.   static class ViewHolder {  
19.     @Bind(R.id.title) TextView name;  
20.     @Bind(R.id.job_title) TextView jobTitle;  
21.   
22.     public ViewHolder(View view) {  
23.       ButterKnife.bind(this, view);  
24.     }  
25.   }  
26. }  

其他绑定API:

1. 使用Activity为根视图绑定任意对象时，如果你使用类似MVC的设计模式你可以在Activity 调用ButterKnife.bind(this, activity)，来绑定Controller。

   2.使用ButterKnife.bind(this)绑定一个view的子节点字段.如果你在子View的布局里或者自定义view的构造方法里使用了inflate,你可以立刻调用此方法。或者，从XML inflate来的自定义view类型可以在onFinishInflate回调方法中使用它。

5.View集合中的使用

你可以将多个view组成一个List或数组。

[plain] view plain copy

1. @Bind({ R.id.first_name, R.id.middle_name, R.id.last_name })  
2. List<EditText> nameViews;  

apply方法可以一次作用到所有的View。

[plain] view plain copy

1. ButterKnife.apply(nameViews, DISABLE);  
2. ButterKnife.apply(nameViews, ENABLED, false);  

Action 和 Setter 接口可以指定简单的行为。

[plain] view plain copy

1. static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {  
2.   @Override public void apply(View view, int index) {  
3.     view.setEnabled(false);  
4.   }  
5. };  
6. static final ButterKnife.Setter<View, Boolean> ENABLED = new ButterKnife.Setter<View, Boolean>() {  
7.   @Override public void set(View view, Boolean value, int index) {  
8.     view.setEnabled(value);  
9.   }  
10. };  

Android的Property（配置信息）也可以被用在apply方法中

[plain] view plain copy

1. ButterKnife.apply(nameViews, View.ALPHA, 0.0f);  

6.监听器绑定

Butter knife可以自动将侦听器配置为方法。

[plain] view plain copy

1. @OnClick(R.id.submit)  
2. public void submit(View view) {  
3.   
4. }  
5.   
6.   
7. @OnClick(R.id.submit)  
8. public void submit() {  
9.   
10. }  
11. //定义的指定类型将会被自动转换  
12.   
13. @OnClick(R.id.submit)  
14. public void sayHi(Button button) {  
15.   button.setText("Hello!");  
16. }  

指定多个id在一个单一的绑定事件中处理。

[plain] view plain copy

1. @OnClick({ R.id.door1, R.id.door2, R.id.door3 })  
2. public void pickDoor(DoorView door) {  
3.   if (door.hasPrizeBehind()) {  
4.     Toast.makeText(this, "You win!", LENGTH_SHORT).show();  
5.   } else {  
6.     Toast.makeText(this, "Try again", LENGTH_SHORT).show();  
7.   }  
8. }  

自定义View可以绑定自己的侦听器但是不用指定一个id。

[plain] view plain copy

1. public class MyButton extends Button {  
2.   @OnClick  
3.   public void onClick() {  
4.   }  
5. }  

7.重置绑定

Fragment的生命周期与Activity不同，当我们在onCreateView绑定Fragment，在onDestroyView将View 设置为null时，Butter Knife 的 unbind()方法可以帮我们做这些。

[plain] view plain copy

1. public class FancyFragment extends Fragment {  
2.   @Bind(R.id.button1) Button button1;  
3.   @Bind(R.id.button2) Button button2;  
4.   
5.   @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {  
6.     View view = inflater.inflate(R.layout.fancy_fragment, container, false);  
7.     ButterKnife.bind(this, view);  
8.     return view;  
9.   }  
10.   
11.   @Override public void onDestroyView() {  
12.     super.onDestroyView();  
13.     ButterKnife.unbind(this);  
14.   }  
15. }  

8.可选绑定

默认情况下，”@Bind”和”@OnClick”(或者其他监听)监听绑定都是必需的。如果不能找到目标视图，则会引发异常。

为了制止这种行为，创建一个可选的结合，添加一个‘@Nullable’注解字段或方法。

任何名字为@Nullable的注解可以被这样使用。鼓励你使用Android自己的注解库”support-annotations”中的@Nullable注解，参见Android Tools Project.

[plain] view plain copy

1. @Nullable @Bind(R.id.might_not_be_there) TextView mightNotBeThere;  
2.   
3. @Nullable @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {  
4.   
5. }  

9.多元监听

与方法注解相匹配的监听器有多个回调可以被用来绑定在他们中间的任何一个身上。每一个注解都有默认的回调跟它绑定在一起。可以使用callback参数声明一个可替代的回调。

[plain] view plain copy

1. @OnItemSelected(R.id.list_view)  
2. void onItemSelected(int position) {  
3.   
4. }  
5.   
6. @OnItemSelected(value = R.id.maybe_missing, callback = NOTHING_SELECTED)  
7. void onNothingSelected() {  
8.   
9. }  

10.在Android Studio 中配置

compile ‘com.jakewharton:butterknife:7.0.1’

11.代码混淆

在代码混淆的时候可能出问题，这时候需要在当前model下的proguard-rules.pro文件做如下修改：

[plain] view plain copy

1. -keep class butterknife.** { *; }  
2. -dontwarn butterknife.internal.**  
3. -keep class **$$ViewBinder { *; }  
4.   
5. -keepclasseswithmembernames class * {  
6.     @butterknife.* <fields>;  
7. }  
8.   
9. -keepclasseswithmembernames class * {  
10.     @butterknife.* <methods>;  
11. }