android ButterKnife的简单使用

今天，简单讲讲android里如何使用ButterKnife。

Android框架系列：

一.android EventBus的简单使用

二.android Glide简单使用

三.android OKHttp的基本使用详解

四.android RxJava（RxAndroid）的简单使用

五.android ButterKnife的简单使用

 

前言：
ButterKnife是一个专注于Android系统的View注入框架,以前总是要写很多findViewById来找到View对象，有了ButterKnife可以很轻松的省去这些步骤。是大神JakeWharton的力作，目前使用很广。最重要的一点，使用ButterKnife对性能基本没有损失，因为ButterKnife用到的注解并不是在运行时反射的，而是在编译的时候生成新的class。项目集成起来也是特别方便，使用起来也是特别简单。

 

ButterKnife 闪亮登场

ButterKnife 初识

ButterKnife，又被戏称为黄油刀，至于为什么被戏称为这个，大家可以看下面附上的从官方截取的icon~

一块桌布，一个盘子，一个Android小机器人形状的黄油，一把刀。这些合起来被大家戏称为黄油刀。（我说呢，纠结我半天，都搞不懂黄油刀是个什么鬼，这次晓得了）

icon下面简单解释就是为Android 视图(View)提供绑定字段和方法。 也就是说，我们今后可以通过这把刀去替换之前琐碎的初始化~

 

一、 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'
}

注意和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. 定义View

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

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

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

1. 点击事件

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

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

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

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

更多事件看下面的 三

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

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();
    }
}

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

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

注意： 如果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("被取消了...");
    }
}

 

三、绑定注解

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

4.2 多个view

使用BindViews绑定多个

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

使用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);
    }
};

4.3 自定义View使用注解事件

不用指定id，直接注解OnClick

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

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) {
    }
});

所以这时候如果我们需要注解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();
}

注意的是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);

4.7 代码混淆（这个不用理解，知道有这个功能就行，因为我也没有明白）

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

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

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

 

五、 原理

利用了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'

 

好了，ButterKnife的基本使用就到这里的。如果只是想知道怎么使用，看到这里就可以了。下面会讲讲具体的原理代码，对能力有一定的要求，大家自己决定看不看。

 

ButterKnife 语法

1. activity fragment 绑定与 fragment解绑

想要使用ButterKnife，简单配置之后，我们还需要在Activity中onCreate()绑定，如下：

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        // 必须在setContentView()之后绑定
        ButterKnife.bind(this); 
    }

而如果使用fragment，官方给出的绑定以及解绑如下：

public class FancyFragment extends Fragment {
  @BindView(R.id.button1) Button button1;
  @BindView(R.id.button2) Button button2;
  private Unbinder unbinder;

  @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
    View view = inflater.inflate(R.layout.fancy_fragment, container, false);
    // 绑定
    unbinder = ButterKnife.bind(this, view);
    // TODO Use fields...
    return view;
  }

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

绑定之后，我们一起来看看，常用的几种监听通过使用ButterKnife之后，我们又该如何编写相关事件呢？别急，往下看~

2.单击事件

首先我们先看看人家表层提供我们代码中，我们可以得到哪儿些对我们有用的信息

首先明确，targetType(目标类型)为View，setter为setOnClickListener(单击事件监听)，type为ButterKnife封装的单击事件(butterknife.internal.DebouncingOnClickListener)，而method中则是name为doClick以及parameters为View类型的俩个参数；而下面的interface接口中需要我们传递一个id。

简单了解后，我们衍生出三种写法，如下：

    // 写法1
    @OnClick(控件ID)
    void 方法名() {
        //业务逻辑操作
    }

    // 写法2
    @OnClick(控件ID)
    void 方法名(控件类型) {
        //业务逻辑操作
    }

    // 写法3
    @OnClick(控件ID)
    void 方法名(View view) {
        //业务逻辑操作
    }

你可以按照上面指定一个个的写，也可以绑定多个，如官网提供下面写法

3.长按事件

同样依旧看人家怎么写的，看看我们能了解到什么

和单击事件对比，长按时间则多出了一个returnType(返回值)，且默认为false。So，写法如下~

    // 方法1
    @OnLongClick(控件ID)
    boolean 方法名(){
        // 业务逻辑操作
        return false;
    }

    // 方法2
    @OnLongClick(控件ID)
    boolean 方法名(控件类型){
        // 业务逻辑操作
        return false;
    }

    // 方法3
    @OnLongClick(控件ID)
    boolean 方法名(View view){
        // 业务逻辑操作
        return false;
    }

4.Checked改变事件

老规矩：

改变，一般来说，会提供我们一个标识，去方便我们根据不同的状态去处理不同的逻辑，so…

    // 写法1
    @OnCheckedChanged(控件ID)
    void radioButtonCheckChange(boolean isl) {
        // 业务逻辑
    }

    // 写法2
    @OnCheckedChanged(控件ID)
    void radioButtonCheckChange(控件类型，boolean isl) {
        // 业务逻辑
    }

5.监听软键盘右下角按钮事件

老规矩：

so…经过上面几个大家可以知道，我们只需要对parameters以及是否是returnType重点关注即可。

    // 写法1
    @OnEditorAction(控件ID)
    boolean 方法名() {
        // 业务逻辑操作
        return false;
    }

    // 写法2
    // code:状态码
    @OnEditorAction(控件ID)
    boolean EditTextAction(int code) {
        // 业务逻辑操作
        return false;
    }

    // 写法3
    // KeyEvent
    @OnEditorAction(控件ID)
    boolean EditTextAction(KeyEvent keyEvent) {
        // 业务逻辑操作
        return false;
    }

    // 写法4
    @OnEditorAction(控件ID)
    boolean EditTextAction(int code, KeyEvent keyEvent) {
        // 业务逻辑操作
        return false;
    }

    // 写法5
    @OnEditorAction(控件ID)
    boolean EditTextAction(TextView textView,int code, KeyEvent keyEvent) {
        // 业务逻辑操作
        return false;
    }

6. EditText内容改变监听事件

由于源码中内容较长，不方便截图，故截取部分代码做解析，如下：

@Target(METHOD)
@Retention(CLASS)
@ListenerClass(
    targetType = "android.widget.TextView",
    setter = "addTextChangedListener",
    remover = "removeTextChangedListener",
    type = "android.text.TextWatcher",   --->   这里同样对之前的TextWatcher做了相关处理 ggg
    callbacks = OnTextChanged.Callback.class   --->   自定义枚举，通过枚举类型标识当前操作 666
)
public @interface OnTextChanged {
  /** View IDs to which the method will be bound. */
  @IdRes int[] value() default { View.NO_ID };   --->   需要传入ID

  /** Listener callback to which the method will be bound. */
  Callback callback() default Callback.TEXT_CHANGED;  --->  未改变状态

  /** {@link TextWatcher} callback methods. */
  enum Callback {  --->  枚举中分为三种类似 未改变 改变前 改变后
    /** {@link TextWatcher#onTextChanged(CharSequence, int, int, int)} */
    @ListenerMethod(
        name = "onTextChanged",  --->  当前标识为 未改变
        parameters = {
            "java.lang.CharSequence",  --->  用户输入字符
            "int", --->  改变前个数
            "int", --->  测试时，返回0，没整明白代表什么意思
            "int"  --->  根据打印结果，猜测这个应该是每次增加内容个数
        }
    )
    TEXT_CHANGED,

    /** {@link TextWatcher#beforeTextChanged(CharSequence, int, int, int)} */
    @ListenerMethod(
        name = "beforeTextChanged",  --->  当前标识为 改变前
        parameters = {
            "java.lang.CharSequence",  --->  用户输入字符
            "int", --->  改变前个数
            "int",
            "int"
        }
    )
    BEFORE_TEXT_CHANGED,

    /** {@link TextWatcher#afterTextChanged(android.text.Editable)} */
    @ListenerMethod(
        name = "afterTextChanged",  --->  当前标识为 改变后
        parameters = "android.text.Editable"  --->  用户输入字符
    )
    AFTER_TEXT_CHANGED, --->  我们关注的重点在此，每次只需要监听这个，去做相关处理即可
  }

从上得知，关于EditText内容改变事件，我们关注点只在乎改变后的内容格式(个数)是否符合项目需求，而其他可以暂时忽略，从而衍生下面写法：

    // 内容改变后监听
    // Editable editable：用户输入字符
    @OnTextChanged(value = 控件ID, callback = 监听类型，改变后取值为：OnTextChanged.Callback.AFTER_TEXT_CHANGED)
    void editTextChangeAfter(Editable editable) {
        // 业务逻辑
    }

    // 内容改变前监听
    @OnTextChanged(value = 控件ID, callback = 监听类型，改变前取值为：OnTextChanged.Callback.BEFORE_TEXT_CHANGED)
    void editTextChangeBefore(CharSequence s, int start) {
        // 业务逻辑
    }

    // 内容未发生改变监听
    @OnTextChanged(value = 控件ID, callback = 监听类型，取值为：OnTextChanged.Callback.TEXT_CHANGED)
    void editTextChange(CharSequence s, int start) {
        // 业务逻辑
    }

7. 焦点监听事件

老规矩：

由此可见，如下：

    @OnFocusChange(控件ID)
    void editTextFocus(boolean isl){
        // 业务逻辑
    }

8. 触摸监听事件

老规矩：

写法如下：

    @OnTouch(控件ID)
    boolean imageView(MotionEvent event){
        // 业务逻辑
        return false;
    }

 

9. item项单击监听事件

老规矩：

so…

    @OnItemClick(控件ID)
    void listItemClick(int position){
        // 业务逻辑
    }

10. item项长按监听事件

老规矩：

so…

    @OnItemLongClick(R.id.listView)
    boolean listItemLongClick(int position) {
        Toast.makeText(this, "OnItemLongClick---点击了第" + position + "个", Toast.LENGTH_SHORT).show();
        return true;
    }

 

简单总结一下，ButterKnife就是一个框架，用注解来取代了findviewbyid的功能，而且它是编译器完成的，对于运行没有任何的效率的影响。使用ButterKnife最好是下载对应的插件Android ButterKnife Zelezny，具体怎么下载，我下一步博客再讲。

 

android ButterKnife的简单使用就讲完了。

 

就这么简单。