替换FindViewById - ButterKnife

最近公司的Android代码修改了一番，其中就把传统的findViewById的形式取消掉了。替换为ButterKnife的注解形式，之前我对这个ButterKnife不了解，就只知道它能代替findViewById来进行view控件的查找。所以打算抽点时间好好了解一下这个东西。

首先我觉得学习一个东西你得知道这个东西有啥好处

---

ButterKnife优势

• ButterKnife是一个View注入框架,传统的代码中我们是用findViewById来找到View对象的，但是ButterKnife可以省去这些步骤，它现在使用范围很广，很受欢迎。最重要的一点，使用ButterKnife对性能基本没有损失，与缓慢的反射相比，Butter Knife使用再编译时生成的代码来执行View的查找，因此不必担心注解的性能问题。它通过调用bind来生成这些代码，你可以查看或调试这些代码，项目集成起来也是特别方便，使用起来也是特别简单。

class BKTestActivity extends BaseActivity {
    @BindView(R.id.hint1)  
    TextView mHint1;
    @BindView(R.id.hint2) 
    TextView mHint2;
    @BindView(R.id.hint3) 
    TextView mHint3;

    @Override public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.simple_activity);
        ButterKnife.bind(this);
        // TODO something
    }
}

上面的测试代码，生成的代码大致如下所示：

public void bind(BKTestActivity activity) {
    activity.mHint1 = (android.widget.TextView) activity.findViewById(2130968577);
    activity.mHint2 = (android.widget.TextView) activity.findViewById(2130968578);
    activity.mHint3 = (android.widget.TextView) activity.findViewById(2130968579);
}

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

在android Studio项目中配置使用ButterKnife

• stepOne
  在Project的 build.gradle 中添加如下代码：

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

• stepTwo
  在Project的 build.gradle 中添加如下代码：

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

ButterKnife的注册与绑定

• ButterKnife的注意事项：
  ⑴，在Activity 类中绑定 。
  必须在setContentView();之后绑定,代码如下：

public class BaseActivity extends AppCompatActivity{  

    @Override  
    protected void onCreate(Bundle savedInstanceState) {  
        super.onCreate(savedInstanceState);  
        setContentView(getContentView());  
        //绑定ButterKnife  
        ButterKnife.bind(this);  
    }  
} 

⑵，并且父类bind绑定后，子类不需要再绑定。
比如说你的BKTestActivity extends BaseActivity ,在BaseActivity 里面绑定之后，BKTestActivity 就不需要绑定了

⑶，在非Activity 类（Fragment、ViewHold...）中绑定。
Fragment具体来说，ButterKnife在Activity中不需要做解绑操作，但是在Fragment 中必须在onDestroyView()中做解绑操作。Fragment的生命周期不同于activity。在onCreateView中绑定一个Fragment，在onDestroyView中将视图设置为null。当调用bind来为你绑定一个Fragment时,Butter Knife会返回一个Unbinder的实例。在适当的生命周期（onDestroyView）回调中调用它的unbind方法进行Fragment解绑。代码如下：

public class BKFragment extends Fragment{  
    private Unbinder unbinder;  
    @Override  
    public View onCreateView(LayoutInflater inflater, ViewGroup container,  
                             Bundle savedInstanceState) {  
        View view = inflater.inflate(R.layout.bk_fragment, container, false);  
        //返回一个Unbinder值（进行解绑），注意这里的this不能使用getActivity()  
        unbinder = ButterKnife.bind(this, view);  
        return view;  
    }  

    /** 
     * onDestroyView中进行解绑操作 
     */  
    @Override  
    public void onDestroyView() {  
        super.onDestroyView();  
        unbinder.unbind();  
    }  
} 

在Adapter的ViewHolder中使用，将ViewHolder加一个构造方法，在new ViewHolder的时候把view传递进去。使用ButterKnife.bind(this, view)进行绑定，代码如下：

static class ViewHolder {  
    @BindView(R.id.title)
    TextView item_name;  
    @BindView(R.id.job) 
    TextView item_age;  

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

⑷，使用ButterKnife修饰的方法和控件，不能用private or static 修饰，否则会报错。错误信息为: @BindView fields must not be private or static.
比如：

@BindView(R.id.hint1)  
priavte TextView mHint1;

@BindView(R.id.hint2)  
static TextView mHint2;

⑸，使用ButterKnife.bind(this，view)绑定一个view的子节点字段。
如果你在子View的布局里或者自定义view的构造方法里 使用了inflate,要在inflate之后调用此方法。或者从XML inflate来的自定义view可以在onFinishInflate回调方法中使用它，即：就是在View有了之后才去调用ButterKnife.bind(this，view)；

ButterKnife的基本用法

• 首先看一下他的注意事项再去学习它的用法

⑴，ButterKinfe的注解标签因版本不同而有所变化。
8.0.0之前的Bind标签在8.0.0之后变成了BindView，而8.7.0之后在绑定view时，要用R2.id.XXX而不再是常用的R.id.XXX了。
具体变化情况和查看gitHub上的提交日志声明和使用权限
⑵，默认情况下，@bind和 listener 的绑定是必需的。如果无法找到目标视图，将抛出一个异常。 要抑制此行为并创建可选绑定，可以将@Nullable注解添加到字段中，或将@Optional注解添加到方法。任何被命名为@Nullable的注解都可以用于成员变量。建议使用android的”support-annotations”库中的@Nullable注解。

@Nullable  
@BindView(R.id.tv)   
TextView mBKTestTv;  

@Optional  
@OnClick(R.id.tv)   
public void onBKTestClicked() {  
    // TODO ...  
}  

• 绑定View：
  ⑴，控件id 注解： @BindView(id)

@BindView(R.id.button)  
public Button button; 

⑵，布局内多个控件id 注解： @BindViews()

public class BKTestActivity extends BaseActivity {  

    @BindViews({ R2.id.button1, R2.id.button2,  R2.id.button3})  
    public List buttonList ;  

    @Override  
    protected void onCreate(Bundle savedInstanceState) {  
        super.onCreate(savedInstanceState);  

        buttonList.get( 0 ).setText( "button 1 ");  
        buttonList.get( 1 ).setText( "button 2 ");  
        buttonList.get( 2 ).setText( "button 3 ");  
    }  
} 

⑶，绑定string 字符串：@BindString()

 //绑定资源文件中string字符串  
@BindString(R2.string.app_name) 
String str;  

⑷，绑定string里面array数组：@BindArray()

  

      
        北京市  
        天津市  
        哈尔滨市  
        大连市  
        香港市  
      
  
------------------------------------------------------------------
 //绑定string里面array数组  
@BindArray(R.array.city) 
String [] citys ; 

⑸，绑定Bitmap 资源：@BindBitmap()

//绑定Bitmap 资源  
@BindBitmap(R.mipmap.bm)
public Bitmap bitmap;  

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

@BindColor(R.color.colorBKTest) 
int black ;  

• 绑定事件：
  ⑴，绑定控件点击事件：@OnClick()

//给 button1 设置一个点击事件
@OnClick(R.id.button1)   
public void showToast(){  
    // TODO 
}  

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

//给 button1 设置一个长按事件  
@OnLongClick(R.id.button1) 
    public boolean showToast2(){  
        // TODO
        return true ;  
    }  

⑶，指定多个id绑定事件：

@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:  
                // TODO
                break;  
            case R.id.btn2:  
                // TODO
                break;  
            case R.id.btn3:  
                // TODO
                break;  
            case R.id.btn4:  
                // TODO
                break;  
        }  
    }  

当然，多个id点击事件也可以用单点方式来实现，如果不嫌麻烦的话

@OnClick(R2.id.btn1)    
public void onViewClicked1(View view) {    
   // TODO          
}    
@OnClick(R2.id.btn2)    
public void onViewClicked2(View view) {    
   // TODO    
}   
@OnClick(R2.id.btn3)    
public void onViewClicked3(View view) {    
   // TODO             
}    
@OnClick(R2.id.btn4)    
public void onViewClicked4(View view) {    
   // TODO              
}    

⑷，自定义View使用绑定事件
不用指定id，直接注解OnClick。看代码觉得好像跟实现点击事件的方法类似。实际上并没有实现OnClickListener接口。代码如下：

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

• 绑定监听
  ⑴，自定义一个方法

@OnClick(R.id.btn)  
public void testMethod(Button btn) {
  btn.setText("Hello!");  
} 

当R.id.btn按钮被点击时，执行btn.setText("Hello!");

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

//多个控件对应公共事件
@OnClick({R.id.btn1, R.id.btn2, R.id.btn3})
public void sayHi(Button button) {
    button.setText("Hello!");
}

这里细说一下吧，这个公共事件，如果btn1被点击，那么btn1会执行button.setText("Hello!");
btn2与btn3不响应，即：谁被点击谁会响应监听

⑶，自定义视图可以通过不指定ID来绑定到它们自己的监听器

public class BKTestButton extends Button {  
  @OnClick  
  public void onClick() {  
    // TODO 
  }  
}

⑷，Listener中多方法注解
如果view对应的监听器有多个回调方法，可用于绑定到其中任何一个。每个注解都有一个它绑定的默认回调。使用回调参数指定一个替换。

以Spinner为例。
传统写法的代码：

Spinner sp=new Spinner(this);  
sp.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener(){  
    @Override  
    public void onItemSelected(AdapterView parent, View view, int position, long id) {  
    }  
    @Override  
    public void onNothingSelected(AdapterView parent) {  
    }  
}); 

Butter Knife 注解写法的代码：

/*利用注解对Spinner item  作选择监听事件处理方式*/  
@OnItemSelected(value = R.id.my_spiner, callback = OnItemSelected.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();  
}  

⑸，OnCheckedChanged监听的使用

举例如下：
原方法应是：setOnCheckedChangeListener()

  
  

      

          

          

          
      

  
-------------------------------------------------------------------------
@OnCheckedChanged({R.id.rg_home,R.id.rg_wealth,R.id.rg_account})  
public void OnCheckedChangeListener(CompoundButton view, boolean ischanged){  
    switch (view.getId()) {  
        case R.id.rg_home:  
            //注意：这里一定要有这个判断，只有对应该id的按钮被点击了，ischanged状态发生改变，才会执行下面的内容
            if (ischanged){  
                //TODO
            }  
            break;  
        case R.id.rg_wealth:  
            if (ischanged) {  
                //TODO  
            }  
            break;  
        case R.id.rg_account:  
            if (ischanged) {  
                //TODO
            }  
            break;  
        default:  
            break;  
    }  
} 

从上面能看出来点，其实绑定监听和绑定事件是有些地方是相同的

• 使用findById方法
  Butter Knife包含了findById()方法，用于仍需从一个view、Activity或者Dialog上初始化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 iv = ButterKnife.findById(view, R.id.iv);  

• 设置多个view的属性：apply()
  允许立即对列表中的所有视图（就是list）进行操作

@BindViews({R.id.btn1, R.id.btn2, R.id.btn2})  
List mViews;

···

//设置多个view的属性  
//方式1：传递值  
ButterKnife.apply(mViews, DISABLE);  
//方式2：指定值  
ButterKnife.apply(mViews, ENABLED, false);  
//方式3 设置View的Property  
//一个Android属性也可以用于应用于方式3 
ButterKnife.apply(mViews, View.ALPHA, 0.0f);

• Action和Setter接口
  作用：Action和Setter接口允许指定简单的行为。

先说Action

/*
 * 定义了一个Action接口，并设置了属性
 */
static final ButterKnife.Action DISABLE = new ButterKnife.Action() {
        @Override
        public void apply(View view, int index) {
            //目的是使view不能被点击
            view.setEnabled(false);
        }
    };

-----------------------------------------------------
// 使用Action接口对list中的每个view赋值不能点击
ButterKnife.apply(list, DISABLE);

再看Setter

/*
 * Setter接口设置属性
 */
static final ButterKnife.Setter ENABLED = new ButterKnife.Setter() {
        @Override
        public void set(View view, Boolean value, int index) {
            //目的是使多个view都具备此属性，可变boolean值是可以传递的
            view.setEnabled(value);
        }
    };

-----------------------------------------------------------------------
// 使用Setter接口对list中的每个view赋值不能点击
ButterKnife.apply(list, ENABLED, false);

• 更多绑定注解：

@BindView—->绑定一个view；id为一个view 变量

@BindViews —-> 绑定多个view；id为一个view的list变量

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

• 更多事件注解:

@OnClick—->点击事件

@OnCheckedChanged —->选中，取消选中

@OnEditorAction —->软键盘的功能键

@OnFocusChange —->焦点改变

@OnItemClick item—->被点击(注意这里有坑，如果item里面有Button等这些有点击的控件事件的，需要设置这些控件属性focusable为false)

@OnItemLongClick item—->长按(返回真可以拦截onItemClick)

@OnItemSelected —->item被选择事件

@OnLongClick —->长按事件

@OnPageChange —->页面改变事件

@OnTextChanged —->EditText里面的文本变化事件

@OnTouch —->触摸事件

@Optional —->选择性注入，如果当前对象不存在，就会抛出一个异常，为了压制这个异常，可以在变量或者方法上加入一下注解,让注入变成选择性的,如果目标View存在,则注入, 不存在,则什么事情都不做

拿Optional来看：

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

ButterKnife的代码混淆

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

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

-keepclasseswithmembernames class * {  
    @butterknife.* ;  
}  

-keepclasseswithmembernames class * {  
    @butterknife.* ;  
}  

ok，ButterKnife基本知识点到这里都讲到了，这几天我也是在网上到处搜BK的网页，这也是基本上复用了两篇文章的思路与框架，把一些一笔带过的东西通过敲遍代码梳理补充了一些，也学了不少东西，感兴趣的可以去看下原创网页
Android Butterknife（黄油刀） 使用方法总结
Android Butter Knife 框架——最好用的View注入