ButterKnife,资源注入如此简单

安卓基础开发库,让开发简单点。
DevRing & Demo地址https://github.com/LJYcoder/DevRing

学习/参考地址:
http://www.jianshu.com/p/9ad21e548b69
http://www.cnblogs.com/zhaoyanjun/p/6016341.html

前言

ButterKnife是一个资源绑定框架,它使用注解来进行资源绑定、监听事件绑定的操作,可以帮我们省去findViewById、setXXXListener等繁琐的代码。使用方便,不影响性能(编译时就生成相应文件),提高开发效率。


介绍

下面从 配置、使用、插件、混淆 这几个部分来介绍。

1. 配置

在Module下的build.gradle中添加

//ButterKnife注入
compile 'com.jakewharton:butterknife:8.8.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:8.8.1'

2. 使用

使用流程可以分成 设置资源绑定、设置监听绑定、开启绑定

2.1 设置资源绑定

2.1.1绑定视图 @BindView( ) / @BindViews( )

  • 使用@BindView( )绑定单个视图
@BindView(R.id.rv_collect)
RecyclerView mRvCollect;
  • 使用@BindViews( )绑定一组视图
    bindviews设置属性
@BindViews({ R2.id.tv_name, R2.id.tv_age,  R2.id.tv_introduce })  
List<TextView> buttonList ;  

另外,ButterKnife提供了apply方法,可对一组视图进行操作。
1)对一组视图进行操作(不传值)

ButterKnife.apply(@NonNull List< T> list, @NonNull Action< ? super T> action)
@BindViews({ R2.id.tv_name, R2.id.tv_age,  R2.id.tv_introduce })  
List<TextView> listTv;  

//统一把文字颜色设为红色
ButterKnife.Action<TextView> SET_COLOR =new ButterKnife.Action<TextView>() {
    @Override
    public void apply(@NonNull TextView textView, int index) {
        textView.setTextColor(Color.RED);
    }
};

ButterKnife.apply(listTv, SET_COLOR);

2)对一组视图进行操作(传值)

ButterKnife.apply(@NonNull List<T> list, @NonNull Setter<? super T, V> setter, V value)
@BindViews({ R2.id.tv_name, R2.id.tv_age,  R2.id.tv_introduce })  
List<TextView> listTv;  

List<String> listTitle= Arrays.asList(new String[]{"姓名","年龄","介绍"});
//按顺序取出标题写入TextView
ButterKnife.Setter<TextView, List<String>> SET_TEXT = new ButterKnife.Setter<TextView, List<String>>() {
    @Override
    public void set(@NonNull TextView textView, List<String> listTitle, int index) {
        textView.setText(listTitle.get(index));
    }
};

ButterKnife.apply(listTv, SET_TEXT, listTitle);

3)对一组视图的Property属性进行操作

ButterKnife.apply(listTv, View.ALPHA, 0.3f);

2.1.2 绑定字符串 @BindString( ) / @BindArray( )

  • 使用BindString( )绑定单个字符串资源
@BindString(R.string.tip)
String tip;
  • 使用@BindArray( )绑定一组字符串资源
@BindArray(R.array.tips)
String[] tips ;

2.1.3 绑定颜色值 @BindColor( )

@BindColor(R.color.theme)
int themeColor;

2.1.4 绑定图片 @BindBitmap( )

@BindBitmap(R.mipmap.ic_launcher)
Bitmap appLogo ;

2.1.5 注意

  1. 使用注解声明的资源变量,不能用private或static修饰,否则会保错。
  2. 当指定资源id对应的View找不到时,会抛出异常,可以加多个@Nullable注解来声明变量,以防止崩溃(建议使用Android注解库“support-annotations”中的@Nullable)


2.2 设置监听绑定

定义一个方法,用相关注解进行监听事件的绑定,

2.2.1 点击事件 @OnClick( )

@OnClick(R.id.btn1)  
public void show1(){  
    Toast.makeText(this, "onClick", Toast.LENGTH_SHORT).show();  
} 

2.2.2 长按事件 @OnLongClick( )

@OnLongClick(R.id.btn2)  
public void show2(){  
    Toast.makeText(this, "onLongClick", Toast.LENGTH_SHORT).show();  
} 

2.2.3 多个控件绑定一个事件

以onclick事件举例。
方法可以定义适当的参数,它将会被自动转化。

@OnClick( {R.id.btn1, R.id.btn2, R.id.btn3, R.id.btn4} )  
public void onViewClicked(View view) {  
    switch (view.getId()) {  
        case R.id.btn1:  
            Toast.makeText(this, "onclick1", Toast.LENGTH_SHORT).show();  
            break;  
        case R.id.btn2:  
            Toast.makeText(this, "onclick2", Toast.LENGTH_SHORT).show();  
            break;  
        case R.id.btn3:  
            Toast.makeText(this, "onclick3", Toast.LENGTH_SHORT).show();  
            break;  
        case R.id.btn4:  
            Toast.makeText(this, "onclick4", Toast.LENGTH_SHORT).show();   
            break;  
    }  
}  

2.2.4 其他事件

除了点击事件和长按事件,ButterKnife还提供了很多点击事件,比如
@OnCheckedChanged(),
@OnEditorAction(),
@OnFocusChange(),
@OnItemClick(),
@OnItemLongClick(),
@OnItemSelected(),
@OnPageChange() 等

2.2.5 注意

  1. 使用注解声明的监听方法,不能用private或static修饰,否则会保错。
  2. 当指定资源id对应的View找不到时,会抛出异常,可以加多个@Optional注解来声明方法,以防止崩溃


2.3 开启绑定

设置完资源绑定和监听事件绑定后,需要通过ButterKnife.bind()方法开启绑定,调用该方法后,对应的资源和监听事件就会开始进行注入绑定。

2.3.1 在Activity中开启绑定

@Override  
protected void onCreate(Bundle savedInstanceState) {  
    super.onCreate(savedInstanceState);  
    setContentView(R.layout.activity_main);  
    //在setContentView后调用
    ButterKnife.bind(this);  
}  

2.3.2 在Fragment中开启绑定

在Fragment中开启绑定后,需要在视图销毁时进行解绑操作。

private Unbinder unbinder; 
 
@Override  
public View onCreateView(LayoutInflater inflater, ViewGroup container,  
                         Bundle savedInstanceState) {  
    View view = inflater.inflate(R.layout.fragment, container, false);  
    
    //返回Unbinder值用于解绑
    //这里调用的方法与Activity调用的有区别  
    unbinder = ButterKnife.bind(this, view);  
    return view;  
}  

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

2.3.3 在ViewHolder中开启绑定

使用列表控件时,常常用到ViewHolder,可以通过以下方式进行绑定

//来自http://www.jianshu.com/p/9ad21e548b69

public class MyAdapter extends BaseAdapter {
    @Override 
    public View getView(int position, View view, ViewGroup parent) {
        ViewHolder holder;
        if (view != null) {
            holder = (ViewHolder) view.getTag();
        } else {
            view = inflater.inflate(R.layout.whatever, parent, false);
            holder = new ViewHolder(view);
            view.setTag(holder);
        }

        holder.name.setText("John Doe");
        // etc...

        return view;
    }

    static class ViewHolder {
        @BindView(R.id.title)
        TextView name;
        @BindView(R.id.job_title) TextView jobTitle;

        public ViewHolder(View view) {
            ButterKnife.bind(this, view);
        }
    }
}

3. 插件

zelezny插件可以快速自动生成ButterKnife绑定相关的代码。
1.先通过Android Studio ---> Setting---> Plugins ---> Browse Responsitories ---> 搜索zelezny并下载,下载后请重启Android Studio。


下载插件

2.右键R.layout.xxxx,点击Generate--->Generate ButterKnife Injections,选择目标View,即可生成相应的代码。


插件使用1

插件使用2

4. 混淆

在proguard-rules.pro文件中添加以下内容进行混淆配置

#butterknife开始
-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }
-keepclasseswithmembernames class * { @butterknife.* <fields>;}
-keepclasseswithmembernames class * { @butterknife.* <methods>;}
#butterknife结束

推荐阅读更多精彩内容