ButterKnife 注解 bindview

简介

官网：http://jakewharton.github.io/butterknife/

github：https://github.com/JakeWharton/butterknife

注意：7.0版本与8.0版本方法名有所改动，整体业务逻辑和原理没什么变动

注意： 2017-5之前 需在 gradle进行好几项配置，而 2017-5之后只需添加以下两行依赖即可

1. 2017-5的配置
2. compile 'com.jakewharton:butterknife:8.6.0'
3. annotationProcessor 'com.jakewharton:butterknife-compiler:8.6.0'

特点：

• 采用注解的方式实现
• 强大的View绑定和Click事件处理功能，简化代码，提升开发效率
  
• 方便的处理Adapter里的ViewHolder绑定问题
  
• 运行时不会影响APP效率，使用配置方便
  
• 代码清晰，可读性强

使用心得：

• Activity中ButterKnife.bind(this);必须在setContentView();之后，且父类bind绑定后，子类不需要再bind
  
• Fragment中为ButterKnife.bind(this, mRootView);
  
• 成员不能用private or static 修饰，否则会报错

使用准备

一、 AS中将注解和字段放在一行的设置：

settings-->editor-->code style-->java-->wrapping and braces-->Field annotation 

二、 .gradle配置

1、在app层级的build.gradle文件的头部添加【 apply plugin: 'com.neenbedankt.android-apt' 】

2、 在app层级的build.gradle文件的 dependencies中添加如下依赖：

     compile 'com.jakewharton:butterknife:8.1.0'

     apt 'com.jakewharton:butterknife-compiler:8.1.0'

3、在project层级的 build. gradle文件 的 dependencies中添加如下依赖

      【classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'】

最后，同步Gradle，你就可以愉快地使用ButterKnife了。

三、使用zelezny插件

可一键生成所有定义id的组件的声明及onclick事件 ，不用手动写。

在AndroidStudio->File->Settings->Plugins->搜索【Zelezny】下载添加即可。

使用时，在要导入注解的Activity 或 Fragment 或 ViewHolder的【layout】资源代码上，右键—>Generate —> Generate ButterKnife Injections

功能

1、绑定Activity或Fragment，父类中绑定后子类不需要再绑定

1. public class SimpleFragment extends Fragment {
2.     @BindView(R.id.fragment_text_view) TextView mTextView;
3.     private Unbinder unbinder;
4.     public SimpleFragment() {
5.     }
6.     @Override
7.     public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
8.         View view = inflater.inflate(R.layout.fragment_simple, container, false);       
9.         unbinder = ButterKnife.bind(this, view);//绑定Activity为ButterKnife.bind(this);
10.         mTextView.setText("TextView in Fragment are found!");
11.         return view;
12.     }
13.     @Override
14.     public void onDestroyView() {
15.         unbinder.unbind();//解除绑定，官方文档只对fragment做了解绑
16.         super.onDestroyView();
17.     }
18. }

2、绑定资源

1. @BindView(R.id.app_name)  TextView mTextView;//view  
2. @BindString(R.string.app_name)  String appName;//sting  
3. @BindColor(R.color.red)  int textColor;//颜色  
4. @BindDrawable(R.mipmap.ic_launcher)  Drawable drawable;//drawble  
5. @BindDrawable(R.drawable.selector_image)  Drawable selector;  

3、点击事件的绑定

a.直接绑定一个方法

1. @OnClick(R.id.submit)  
2. public void submit(View view) { }  

b.所有监听方法的参数是可选的

1. @OnClick(R.id.submit)  
2. public void submit() { }  

c.定义一个特定类型，它将自动被转换

1. @OnClick(R.id.submit) 
2. public void sayHi(Button button) { } 

d.多个view统一处理同一个点击事件，很方便，避免抽方法重复调用的麻烦

1. @OnClick({ R.id.door1, R.id.door2, R.id.door3 })  
2. public void pickDoor(DoorView door) { }  

 e.自定义view可以绑定自己的监听，不指定id

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

f.给EditText加addTextChangedListener（即添加多回调方法的监听的使用方法），利用指定回调，实现想回调的方法即可，哪个注解不会用点进去看下源码上的注释就会用了

1. @OnTextChanged(value = R.id.mobileEditText, callback = OnTextChanged.Callback.BEFORE_TEXT_CHANGED)  
2. void beforeTextChanged(CharSequence s, int start, int count, int after) { }  
3. @OnTextChanged(value = R.id.mobileEditText, callback = OnTextChanged.Callback.TEXT_CHANGED)  
4. void onTextChanged(CharSequence s, int start, int before, int count) { }  
5. @OnTextChanged(value = R.id.mobileEditText, callback = OnTextChanged.Callback.AFTER_TEXT_CHANGED)  
6. void afterTextChanged(Editable s) { }  

4、Adapter的ViewHolder 绑定

1.     static class ViewHolder {  
2.         @Bind(R.id.hello_world)  
3.         TextView textview;  
4.         public ViewHolder(View view) {  
5.             ButterKnife.bind(this, view);  
6.         }  
7.     }

5、对一组View进行统一操作

a .装入一个list

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

b.设置统一处理

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. };  

c.统一操作处理，例如设置是否可点，属性等

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

6、可选绑定：默认情况下，“绑定”和“监听”绑定都是必需的。如果不能找到目标视图，则将抛出异常。所以做空处理

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

7、代码混淆

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

Activity

1. public class SimpleActivity extends AppCompatActivity {
2. @BindView(R.id.simple_activity_text_view) TextView mTextView; //this field should not be declared private or static
3. @Override
4. protected void onCreate(Bundle savedInstanceState) {
5. super.onCreate(savedInstanceState);
6. setContentView(R.layout.activity_simple);
7. ButterKnife.bind(this);// ButterKnife.inject(this) should be called after setContentView()
8. mTextView.setText("View视图的绑定");
9. }
10. @OnClick(R.id.simple_activity_button)
11. void onButtonClick(View view) { //the method should not be declared private or static
12. //you can write the parameter (View view) as above or just write onButtonClick() leave parameters empty, both are ok
13. Toast.makeText(this, "事件绑定", Toast.LENGTH_SHORT).show();
14. }
15. //bind event to CheckBox
16. @OnCheckedChanged(R.id.simple_activity_checkbox)
17. void onCheckedChanged(CompoundButton button, boolean checked) {
18. Toast.makeText(this, "CheckBox状态改变了：" + checked, Toast.LENGTH_SHORT).show();
19. }
20. }

Fragment

1. public class SimpleFragment extends Fragment {
2. @BindView(R.id.fragment_text_view) TextView mTextView;
3. private Unbinder unbinder;
4. public SimpleFragment() {
5. }
6. @Override
7. public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
8. View view = inflater.inflate(R.layout.fragment_simple, container, false);
9. unbinder = ButterKnife.bind(this, view);
10. mTextView.setText("TextView in Fragment are found!");
11. return view;
12. }
13. @Override
14. public void onDestroyView() {
15. unbinder.unbind();
16. super.onDestroyView();
17. }
18. }

ListView

1. public class ListViewActivity extends AppCompatActivity {
2. @BindView(R.id.my_list_view) ListView mListView;
3. private PersonAdapter adapter;
4. @Override
5. protected void onCreate(Bundle savedInstanceState) {
6. super.onCreate(savedInstanceState);
7. setContentView(R.layout.activity_list_view);
8. ButterKnife.bind(this);
9. adapter = new PersonAdapter(this, MockDataUtils.getPersons());
10. mListView.setAdapter(adapter);
11. }
12. @OnItemClick(R.id.my_list_view)
13. void onItemClick(int position) {//though there are 4 parameters, you can just write the one you want to use
14. Toast.makeText(this, "点击事件： " + adapter.getItem(position).getName(), Toast.LENGTH_SHORT).show();
15. }
16. @OnItemLongClick(R.id.my_list_view)
17. boolean onItmeLongClick(int position) {
18. Toast.makeText(this, "长点击事件：" + adapter.getItem(position).getName(), Toast.LENGTH_SHORT).show();
19. if (position % 2 == 0) return true;
20. else return false; //if return false, the onItemClick() will be invoked反射调用 when touch up
21. }
22. }

Adapter

1. public class PersonAdapter extends BaseAdapter {
2. @Override
3. public View getView(int position, View convertView, ViewGroup parent) {
4. ViewHolder holder;
5. if (convertView == null) {
6. convertView = mInflater.inflate(R.layout.person_item_layout, null);
7. holder = new ViewHolder(convertView);
8. convertView.setTag(holder);
9. } else holder = (ViewHolder) convertView.getTag();
10. Person person = getItem(position);
11. if (null != person) {
12. holder.name.setText(person.getName());
13. }
14. return convertView;
15. }
16. static class ViewHolder {
17. @BindView(R.id.person_name) TextView name;
18. public ViewHolder(View view) {
19. ButterKnife.bind(this, view);
20. }
21. }
22. }

2017-5-23

null