转载注明出处：http://blog.csdn.net/sahadev_/article/details/50895398

转载注明出处：http://blog.csdn.net/sahadev_/article/details/50895398

一、 ButterKnife是啥

注解中相对简单易懂的很不错的开源框架
1. 强大的View绑定和Click事件处理功能，简化代码，提升开发效率
2. 方便的处理Adaper里的ViewHolder绑定问题
3. 运行时不会影响app效率，使用配置方便
4. 代码清晰，可读性强

github开源地址：
https://github.com/JakeWharton/butterknife

二、使用步骤

2.1 添加插件

File -> Settings -> Plugins -> 搜索ButterKnife，找到Android ButterKnife Zeleany进行安装重启AndroidStudio

2.2 添加依赖

在对应module的build.gradle里面添加下面的依赖，重新编译就会自动下载

dependencies {
  compile 'com.jakewharton:butterknife:8.5.1'
  annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1'
}
  
  

   
   
1
   
   
2
   
   
3
   
   
4
  
  

注意和Dagger2配合使用需要注意把annotationProcessor改为apt。

2.3 在Activity中使用

2.3.1 使用插件

在R.layout.activity_main上面右击 选择Generate -> Generate ButterKnife injections,即可选择 生成view对应的注解,还支持ViewHolder和OnClick

2.3.2 手动

1. 绑定ButterKnife

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    //绑定初始化ButterKnife
    ButterKnife.bind(this);
}
  
  

   
   
1
   
   
2
   
   
3
   
   
4
   
   
5
   
   
6
   
   
7
   
   
8
  
  

1. 定义View

下面的代码把R.id.tv_test这个TextView定义了为tvTest，注意类型不能为static或者private

@BindView(R.id.tv_test)
TextView tvTest;

//当然写成一行也是可以
@BindView(R.id.tv_test) TextView tvTest;

  
  

   
   
1
   
   
2
   
   
3
   
   
4
   
   
5
   
   
6
  
  

1. 点击事件

添加注解@OnClick(R.id.xx)即为点击方法，对应的View参数可有可无，如果有多个参数可以只加一个参数(例如onItemClick有四个参数，你可以只加一个int position的参数)。如果参数错误，编译的时候会报错。

@OnClick(R.id.bt_test)
public void onClick(View v) {
    tvTest.setText("被点击了...");
}
  
  

   
   
1
   
   
2
   
   
3
   
   
4
  
  

如果定义为指定的类型，将会自动转换

@OnClick(R.id.bt_test)
public void onClick(Button button) {
    tvTest.setText("被点击了...");
}
  
  

   
   
1
   
   
2
   
   
3
   
   
4
  
  

更多事件看下面的 三

2.4 在Fragment中使用

在Fragment中使用和在Activity中使用，只是有一点不一样：在获取View的时候，加多一个view参数把View绑定到ButterKnife就行了。

@Nullable
@Override
public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
    View view = inflater.inflate(R.layout.my_fragment, container, false);
    //这里需要加多一个参数view
    ButterKnife.bind(this, view);
    return view;
}
  
  

   
   
1
   
   
2
   
   
3
   
   
4
   
   
5
   
   
6
   
   
7
   
   
8
  
  

Fragment生命周期和activity有点不同，销毁的时候可以进行解绑

public class MyFragment extends Fragment {

    @BindView(R.id.bt_test)
    Button btTest;

    private Unbinder unbinder;

    @Nullable
    @Override
    public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.my_fragment, container, false);
        //绑定的时候返回了一个Unbinder对象
        unbinder = ButterKnife.bind(this, view);
        return view;
    }

    @Override
    public void onDestroyView() {
        super.onDestroyView();
        unbinder.unbind();
    }
}
  
  

   
   
1
   
   
2
   
   
3
   
   
4
   
   
5
   
   
6
   
   
7
   
   
8
   
   
9
   
   
10
   
   
11
   
   
12
   
   
13
   
   
14
   
   
15
   
   
16
   
   
17
   
   
18
   
   
19
   
   
20
   
   
21
   
   
22
   
   
23
  
  

2.5 在Adapter ViewHolder中使用

把ViewHolder加一个构造方法，在new ViewHolder的时候把view传递进去。

static class ViewHolder {
    @BindView(R.id.tv_item_test)
    TextView tvItemTest;
    @BindView(R.id.bt_item_test)
    Button btItemTest;
    public ViewHolder(View view) {
        ButterKnife.bind(this, view);
    }
}
  
  

   
   
1
   
   
2
   
   
3
   
   
4
   
   
5
   
   
6
   
   
7
   
   
8
   
   
9
  
  

item里面Button控件的点击事件也可以使用注解@OnClick来实现，在适配器里面添加就行，如：

    //item的button的点击事件
    @OnClick(R.id.bt_item_test)
    void onClick(){
        Toast.makeText(context,"点击了按钮",Toast.LENGTH_SHORT).show();

    }

    static class ViewHolder {
        @BindView(R.id.tv_item_test)
        TextView tvItemTest;
        @BindView(R.id.bt_item_test)
        Button btItemTest;
        public ViewHolder(View view) {
            ButterKnife.bind(this, view);
        }
    }
  
  

   
   
1
   
   
2
   
   
3
   
   
4
   
   
5
   
   
6
   
   
7
   
   
8
   
   
9
   
   
10
   
   
11
   
   
12
   
   
13
   
   
14
   
   
15
   
   
16
   
   
17
  
  

注意： 如果item里面有Button等这些有点击的控件事件的，需要设置这些控件属性focusable为false

三、 事件注解

一共有12个

名称	作用
@OnClick	点击事件
@OnCheckedChanged	选中，取消选中
@OnEditorAction	软键盘的功能键
@OnFocusChange	焦点改变
@OnItemClick	item被点击(注意这里有坑，如果item里面有Button等这些有点击的控件事件的，需要设置这些控件属性focusable为false)
@OnItemLongClick	item长按(返回真可以拦截onItemClick)
@OnItemSelected	item被选择事件
@OnLongClick	长按事件
@OnPageChange	页面改变事件
@OnTextChanged	EditText里面的文本变化事件
@OnTouch	触摸事件
@Optional	选择性注入，如果当前对象不存在，就会抛出一个异常，为了压制这个异常，可以在变量或者方法上加入一下注解,让注入变成选择性的,如果目标View存在,则注入, 不存在,则什么事情都不做=如下代码

@Optional
@OnCheckedChanged(R.id.cb_test)
public void onCheckedChanged(CompoundButton buttonView,boolean isChecked){
    if(isChecked){
        tvTest.setText("被选中了...");
    }else{
        tvTest.setText("被取消了...");
    }
}
  
  

   
   
1
   
   
2
   
   
3
   
   
4
   
   
5
   
   
6
   
   
7
   
   
8
   
   
9
  
  

三、绑定注解

有11种

名称	解析
@BindViews	绑定多个view id为一个view的list变量
@BindView	绑定一个view id为一个view 变量
@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;

五、 ButterKnife更多使用

4.1 指定多个id绑定事件

例如绑定多个Button的onclick事件，在小括号里面加大括号，然后用逗号分割即可。

    @OnClick({R.id.bt_test,R.id.bt_test_two})
    public void onClick(View v) {
        switch (v.getId()){
            case R.id.bt_test:
                tvTest.setText("按钮1被点击了...");
                break;
            case R.id.bt_test_two:
                tvTest.setText("按钮2被点击了...");
                break;
        }
    }
  
  

   
   
1
   
   
2
   
   
3
   
   
4
   
   
5
   
   
6
   
   
7
   
   
8
   
   
9
   
   
10
   
   
11
  
  

4.2 多个view

使用BindViews绑定多个

@BindViews({R.id.tv_test,R.id.tv_test_two,R.id.tv_test_three})
List<TextView> tvList;
  
  

   
   
1
   
   
2
  
  

使用Action接口或者Setter接口或者View的Property，可以同时设置多个view的属性

@BindViews({R.id.tv_test,R.id.tv_test_two,R.id.tv_test_three})
List<TextView> tvList;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    ButterKnife.bind(this);


    //设置多个view的属性
    //方式1 传递值
    ButterKnife.apply(tvList,ENABLED,false);
    //方式2 指定值
    ButterKnife.apply(tvList,DISABLE);
    //方式3 设置View的Property
    ButterKnife.apply(tvList, View.ALPHA, 0.0f);

}

//Action接口设置属性
static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
    @Override public void apply(View view, int index) {
        view.setEnabled(false);
    }
};

//Setter接口设置属性
static final ButterKnife.Setter<View, Boolean> ENABLED = new ButterKnife.Setter<View, Boolean>() {
    @Override public void set(View view, Boolean value, int index) {
        view.setEnabled(value);
    }
};
  
  

   
   
1
   
   
2
   
   
3
   
   
4
   
   
5
   
   
6
   
   
7
   
   
8
   
   
9
   
   
10
   
   
11
   
   
12
   
   
13
   
   
14
   
   
15
   
   
16
   
   
17
   
   
18
   
   
19
   
   
20
   
   
21
   
   
22
   
   
23
   
   
24
   
   
25
   
   
26
   
   
27
   
   
28
   
   
29
   
   
30
   
   
31
   
   
32
   
   
33
  
  

4.3 自定义View使用注解事件

不用指定id，直接注解OnClick

public class MyButton extends Button {
  @OnClick
  public void onClick() {
  }
}
  
  

   
   
1
   
   
2
   
   
3
   
   
4
   
   
5
  
  

4.4 绑定api

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

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

4.5 多方法的listener

例如Spinner的setOnItemSelectedListener，他会回调两个方法:

mSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() {
    @Override
    public void onItemSelected(AdapterView<?> parent, View view, int position, long id) {
    }
    @Override
    public void onNothingSelected(AdapterView<?> parent) {
    }
});
  
  

   
   
1
   
   
2
   
   
3
   
   
4
   
   
5
   
   
6
   
   
7
   
   
8
  
  

所以这时候如果我们需要注解onNothingSelected，需要在注解参数添加一个callback，

@OnItemSelected(R.id.my_spiner)//默认callback为ITEM_SELECTED
void onItemSelected(int position) {
    Toast.makeText(this, "position: " + position, Toast.LENGTH_SHORT).show();
}

@OnItemSelected(value = R.id.my_spiner, callback = OnItemSelected.Callback.NOTHING_SELECTED)
void onNothingSelected() {
    Toast.makeText(this, "Nothing", Toast.LENGTH_SHORT).show();
}
  
  

   
   
1
   
   
2
   
   
3
   
   
4
   
   
5
   
   
6
   
   
7
   
   
8
   
   
9
  
  

注意的是Spinner中只要有数据,默认都会选中第0个数据,所以想进入到onNothingSelected()方法,就需要把Adapter中的数据都清空

4.6 使用findById

Butter knife仍然包含了findById方法，用于仍需从一个view ，Activity，或者Dialog上 find 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 photo = ButterKnife.findById(view, R.id.photo);
  
  

   
   
1
   
   
2
   
   
3
   
   
4
  
  

4.7 代码混淆

-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }

-keepclasseswithmembernames class * {
    @butterknife.* <fields>;
}

-keepclasseswithmembernames class * {
    @butterknife.* <methods>;
}
  
  

   
   
1
   
   
2
   
   
3
   
   
4
   
   
5
   
   
6
   
   
7
   
   
8
   
   
9
   
   
10
   
   
11
  
  

五、 原理

利用了IOC的(Inverse of Controll)控制反转结构，04年后改名为DI(dependency injection)依赖注入。目的是为了使类与类之间解耦合，提高系统的可扩展性和可维护性。

六、 和Dagger使用注意

搭配Dagger使用的时候，ButterKnife可能会不起作用，没效果，绑定控件为null。这时候把依赖包的annotationProcessor改为apt 就可以了：

    compile 'com.jakewharton:butterknife:8.5.1' 

    //apt 

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

   
   
1
   
   
2
   
   
3