ButterKnife注解使用

简介

在开发过程中，我们总是会写大量的findViewById和setOnClickListener来进行初始化和监听，这样简单而重复的操作会让人觉得特别麻烦，因此自然就出现了相应的解决方案–依赖注入。而ButterKnife则是依赖注入中相对简单易懂且很不错的开源框架，被广泛应用于Android开发当中。帮助安卓开发者省去了大量初始化控件的重复性工作，简单快捷地就可以初始化布局文件中的控件，极大地提升了开发效率。

官网：http://jakewharton.github.io/butterknife/
GitHub：https://github.com/JakeWharton/butterknife/

优势

1、强大的View绑定和Click事件处理功能，简化代码且提高开发效率；
2、可方便的处理Adapter里的ViewHolder绑定问题；
3、运行时不会影响APP效率，使用配置简单方便；
4、代码清晰，可读性强。

依赖配置

1、在Project的build.gredle文件中添加如下配置

buildscript {    repositories {        jcenter()    }    dependencies {        classpath 'com.jakewharton:butterknife-gradle-plugin:8.8.1'    }}

2、在Module的build.gredle文件中添加如下配置

apply plugin: 'com.jakewharton.butterknife'android {    ......}dependencies {    compile 'com.jakewharton:butterknife:8.8.1'    annotationProcessor 'com.jakewharton:butterknife-compiler:8.8.1'}

插件

1、在Android Studio中选择File -> Settings...

2、选择Plugins，点击Browse repositories...

3、搜索ButterKnife，选择Zelezny或者Plugin Plus，点击Install并重启Studio即可

4、在需要添加注解的类中，鼠标右键布局文件名（注意：一定要将光标停在布局文件名上），选择Generate...

5、选择Generate Butterknife Injections（此弹窗也可使用快捷键Alt+insert组合按键弹出）

6、弹出框中可以看到布局中定义控件的ID，在OnClick中对应控件后的选择框中打勾可以绑定当前View的监听事件，最后选择Confirm确认按钮生成注解

7、在当前类中就可以看到已经生成的注解了

注意事项

1、在Activity类中绑定：ButterKnife.bind(this);必须在setContentView();之后且若父类绑定之后其子类不需要再进行绑定。
2、在非Activity类（eg：Fragment、ViewHolder）中绑定：ButterKnife.bind(this, view);这里的this不能替换成getActivity()。
3、在Activity中不需要做解绑操作，在Fragment中必须在onDestroyView()中做解绑操作。
4、使用ButterKnife修饰的方法和控件，不能用private or static进行修饰，否则会错误: @BindView fields must not be private or static. (com.wiggins.smile.view.login.MoreFragment.tvMore)
5、setContentView();不能通过注解进行实现。
6、使用Activity为根视图绑定任意对象时，如果你使用类似MVC的设计模式时可以在Activity中调用ButterKnife.bind(this, activity)来绑定Controller。
7、使用ButterKnife.bind(this, view);绑定一个View的子节点字段，如果你在子View的布局中或者自定义View的构造方法中使用了inflate可以立刻调用此方法，或者从XML inflate来的自定义View类型可以在onFinishInflate回调方法中使用它。
8、默认情况下@Bind和Listener的绑定是必需的，如果无法找到目标视图将会抛出一个异常，如果要抑制此行为并创建可选绑定，可将@Nullable注解添加到字段中或将@Optional注解添加到方法中，任何被命名为@Nullable的注解都可以用于成员变量，这里建议使用Android的”support.annotation”库中的@Nullable注解。

@Nullable@BindView(R.id.tv_more)TextView tvMore;@Optional@OnClick(R.id.ll_count_down)public void countDown() {    // TODO...}

绑定

1、在Activity中绑定
由于每次都要在Activity中的onCreate中进行绑定，所以建议写一个基类BaseActivity完成绑定，子类继承即可。绑定Activity必须在setContentView()之后使用ButterKnife.bind(this)进行绑定。

public class SplashActivity extends Activity {    @BindView(R.id.iv_splash)    ImageView ivSplash;    @BindView(R.id.tv_count_down)    TextView tvCountDown;    @BindView(R.id.ll_count_down)    LinearLayout llCountDown;    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);    }    @OnClick({R.id.iv_splash, R.id.ll_count_down})    public void onClick(View view) {        switch (view.getId()) {            case R.id.iv_splash:                break;            case R.id.ll_count_down:                break;        }    }}

2、在Fragment中绑定
Fragment的生命周期不同于Activity，在onCreateView中绑定一个Fragment时，在onDestroyView中会将视图设置为null，调用bind绑定一个Fragment时ButterKnife会返回一个Unbinder的实例，在其生命周期onDestroyView中调用unbind方法进行Fragment解绑，使用ButterKnife.bind(this, view)进行绑定。

public class MoreFragment extends Fragment {    @BindView(R.id.tv_more)    TextView tvMore;    Unbinder unbinder;    @Override    public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {        View view = inflater.inflate(R.layout.fragment_more, container, false);        unbinder = ButterKnife.bind(this, view);        return view;    }    @Override    public void onDestroyView() {        super.onDestroyView();        unbinder.unbind();    }    @OnClick(R.id.tv_more)    public void onClick() {    }}

3、在Adapter中绑定
在Adapter的ViewHolder中使用时将ViewHolder添加一个构造方法，在new ViewHolder的时候将view传递进去进行绑定，使用ButterKnife.bind(this, view)进行绑定。

public class GridAdapter extends BaseAdapter {    ......    @Override    public View getView(int position, View convertView, ViewGroup parent) {        ViewHolder holder;        if (convertView == null) {            convertView = inflater.inflate(R.layout.item_dialog_grid, null);            holder = new ViewHolder(convertView);            convertView.setTag(holder);        } else {            holder = (ViewHolder) convertView.getTag();        }        return convertView;    }    static class ViewHolder {        @BindView(R.id.iv_image)        ImageView ivImage;        @BindView(R.id.tv_name)        TextView tvName;        ViewHolder(View view) {            ButterKnife.bind(this, view);        }    }}

基本使用

1、绑定View
控件id注解：@BindView()

@BindView(R.id.iv_splash)ImageView mIvSplash;

多个控件id注解：@BindViews()

public class SplashActivity extends Activity {    @BindViews({R.id.tv_count1, R.id.tv_count2, R.id.tv_count3})    public List<TextView> tvList;    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);        tvList.get(0).setText("Hello One");        tvList.get(1).setText("Hello Two");        tvList.get(2).setText("Hello Three");    }}

2、绑定资源
绑定strings字符串：@BindString()

public class SplashActivity extends Activity {    @BindView(R.id.tv_count_down)    TextView tvCountDown;    @BindString(R.string.app_name)// 绑定资源文件中strings字符串    String str;    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);        tvCountDown.setText(str);    }}

绑定strings里面array数组：@BindArray()

<resources>    <string-array name="city">        <item>北京市</item>        <item>天津市</item>        <item>哈尔滨市</item>        <item>大连市</item>        <item>香港市</item>    </string-array></resources>public class SplashActivity extends Activity {    @BindView(R.id.tv_count_down)    TextView tvCountDown;    @BindArray(R.array.city)// 绑定strings里面array数组    String[] city;    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);        tvCountDown.setText(city[0]);    }}

绑定Bitmap资源：@BindBitmap()

public class SplashActivity extends Activity {    @BindView(R.id.iv_splash)    ImageView ivSplash;    @BindBitmap(R.mipmap.icon_default)// 绑定Bitmap资源    Bitmap bitmap;    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);        ivSplash.setImageBitmap(bitmap);    }}

绑定一个颜色值：@BindColor()

public class SplashActivity extends Activity {    @BindView(R.id.tv_count_down)    TextView tvCountDown;    @BindColor(R.color.red)// 颜色值在colors文件中    int red;    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);        tvCountDown.setTextColor(red);    }}

3、事件绑定
绑定控件点击事件：@OnClick()

public class SplashActivity extends Activity {    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);    }    @OnClick(R.id.iv_splash)    public void onClick() {    }}

绑定控件长按事件：@OnLongClick()

public class SplashActivity extends Activity {    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);    }    @OnLongClick(R.id.iv_splash)    public void onClick() {    }}

指定多个id绑定事件

public class SplashActivity extends Activity {    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);    }    @OnClick({R.id.iv_splash, R.id.tv_count_down, R.id.ll_count_down})    public void onClick(View view) {        switch (view.getId()) {            case R.id.iv_splash:                break;            case R.id.tv_count_down:                break;            case R.id.ll_count_down:                break;        }    }}

自定义View绑定事件

public class FancyButton extends Button {    @OnClick    public void onClick() {        // TODO do something!    }}

4、绑定监听
Listeners可以自动配置到方法中

@OnClick(R.id.ll_count_down)public void countDown(View view) {    // TODO...}

监听器方法的所有参数都是可选的

@OnClick(R.id.ll_count_down)public void countDown() {    // TODO...}

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

@OnClick(R.id.tv_count_down)public void countDown(TextView tv) {    tv.setText("Hello!");}

单个绑定中可以指定多个id，用于公共事件处理

@OnClick({R.id.tv_count_down1, R.id.tv_count_down2, R.id.tv_count_down3})public void countDown(TextView tv) {    tv.setText("Hello!");}

Listener中多方法注解
监听中有的控件对应监听器有多个回调，可用于绑定到其中任何一个，每个注解都有一个它绑定的默认回调，使用回调参数指定一个替换。
(1) 以Spinner为例，以下为原本的监听代码：

public class SplashActivity extends Activity {    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);        Spinner spinner = new Spinner(this);        spinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() {            @Override            public void onItemSelected(AdapterView<?> parent, View view, int position, long id) {            }            @Override            public void onNothingSelected(AdapterView<?> parent) {            }        });    }}

(2) 添加注解方式

public class SplashActivity extends Activity {    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);    }    /**     * 默认callback为ITEM_SELECTED     */    @OnItemSelected(R.id.spinner)    void onItemSelected(int position) {    }    /**     * 注解onNothingSelected需要在注解参数添加一个callback     * 需要注意的是Spinner中只要有数据，默认都会选中第0条数据，所以想进入到onNothingSelected()方法，就需要把Adapter中的数据都清空     */    @OnItemSelected(value = R.id.spinner, callback = OnItemSelected.Callback.NOTHING_SELECTED)    void onNothingSelected() {    }}

@OnCheckedChanged()注解的使用
(1) RadioGroup原本的监听代码：

 <RadioGroup    android:id="@+id/radioGroup"    android:layout_width="match_parent"    android:layout_height="wrap_content"    android:orientation="vertical">    <RadioButton        android:id="@+id/rb_one"        android:layout_width="match_parent"        android:layout_height="wrap_content"        android:focusable="false"        android:text="one" />    <RadioButton        android:id="@+id/rb_two"        android:layout_width="match_parent"        android:layout_height="wrap_content"        android:focusable="false"        android:text="two" />    <RadioButton        android:id="@+id/rb_three"        android:layout_width="match_parent"        android:layout_height="wrap_content"        android:focusable="false"        android:text="three" /></RadioGroup>public class SplashActivity extends Activity {    @BindView(R.id.radioGroup)    RadioGroup radioGroup;    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);        radioGroup.setOnCheckedChangeListener(new RadioGroup.OnCheckedChangeListener() {            @Override            public void onCheckedChanged(RadioGroup group, int checkedId) {            }        });    }}

(2) 添加注解方式

public class SplashActivity extends Activity {    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);    }    @OnCheckedChanged({R.id.rb_one, R.id.rb_two, R.id.rb_three})    public void onCheckedChanged(CompoundButton view, boolean isChanged) {        switch (view.getId()) {            case R.id.rb_one:                // 注意：这里一定要有这个判断，只有对应id的按钮被点击了，isChanged状态发生改变，才会执行下面的内容                if (isChanged) {                }                break;            case R.id.rb_two:                if (isChanged) {                }                break;            case R.id.rb_three:                if (isChanged) {                }                break;        }    }}

5、findById的使用
ButterKnife依然包含了findById()方法，使用时需从一个View中获取并且它可以自动转换类型。

View view = inflater.inflate(R.layout.fragment_more, container, false);TextView tvMore = ButterKnife.findById(view, R.id.tv_more);

6、设置多个view的属性
apply()
作用：允许您立即对列表中的所有视图进行操作。
Action和Setter接口
作用：Action和Setter接口允许指定简单的行为。

public class SplashActivity extends Activity {    @BindViews({R2.id.first_name, R2.id.middle_name, R2.id.last_name})    List<EditText> nameViews;    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_splash);        ButterKnife.bind(this);        // 设置多个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<View> DISABLE = new ButterKnife.Action<View>() {        @Override        public void apply(View view, int index) {            view.setEnabled(false);// 目的是使多个View都具备此属性        }    };    /**     * 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);// 目的是使多个View都具备此属性，可变boolean值是可以传递的        }    };}

绑定注解总结

1、@BindView：绑定一个View，此定义为一个View变量

@BindView(R.id.iv_splash)ImageView mIvSplash;

2、@BindViews：绑定多个View，此定义为多个View的List变量

@BindViews({R.id.tv_count1, R.id.tv_count2, R.id.tv_count3})public List<TextView> tvList;

3、@BindString：绑定一个String字符串，此定义为一个String变量

@BindString(R.string.app_name)String str;

4、@BindArray：绑定String里面array数组，此定义为一个String[]数组

@BindArray(R.array.city)String[] city;

5、@BindBitmap：绑定图片资源为Bitmap，此定义为一个Bitmap资源

@BindBitmap(R.mipmap.icon_default)Bitmap bitmap;

6、@BindDrawable：绑定图片资源为Drawable，此定义为一个Drawable资源

@BindDrawable(R.drawable.icon_default)Drawable drawable;

7、@BindColor：绑定一个颜色Color，此定义为一个int变量

@BindColor(R.color.red)int red;

8、@BindDimen：绑定Dimen资源，此定义为一个int或float变量（int (for pixel size) or float (for exact value) field）

@BindDimen(R.dimen.btn_height)int height;

事件注解总结

1、@OnClick：点击事件；
2、@OnCheckedChanged：选中或取消选中；
3、@OnEditorAction：软键盘的功能键；
4、@OnFocusChange：焦点改变；
5、@OnItemClick：item被点击事件(注意：如果item里面有Button等这些有点击事件控件时需要设置这些控件属性focusable为false)；
6、@OnItemLongClick：item长按事件(返回true可以拦截OnItemClick)；
7、@OnItemSelected：item被选择事件；
8、@OnLongClick：长按事件；
9、@OnPageChange：页面改变事件；
10、@OnTextChanged：EditText里面的文本变化事件；
11、@OnTouch：触摸事件；
12、@Optional：选择性注入，若当前对象不存在就会抛出一个异常，为了优化此异常可在变量或者方法上加入这个注解，可以使注入变成选择性的，如果目标存在则注入，反之则什么事情都不做。

混淆

在混淆文件中添加如下代码

-keep class butterknife.** { *; }-dontwarn butterknife.internal.**-keep class **$$ViewBinder { *; }-keepclasseswithmembernames class * {    @butterknife.* <fields>;}-keepclasseswithmembernames class * {    @butterknife.* <methods>;}