Android ButterKnife(黄油刀)的使用

Android ButterKnife(黄油刀)的使用

八归少年 2,286 2020-09-16

首语

  • 在android开发过程中，我们会写大量的布局和点击事件，像findViewById、设置view监听这样简单而重复的操作让人觉得麻烦，而ButterKnife是注解中相对简单易懂的很不错的开源框架。

优势

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

GitHub地址：https://github.com/JakeWharton/butterknife

ButterKnife基本使用

使用步骤

1.在Setting->Plugins中输入butterknife——>添加插件Android ButterKnife Aelezny ——>点击安装。
2.dependencies中添加依赖：

implementation 'com.jakewharton:butterknife:8.8.1'
annotationProcessor "com.jakewharton:butterknife-compiler:8.8.1"
ButterKnife使用心得
  • 在Activity类中绑定，ButterKnife.bind(this);必须在setContentView();之后绑定；且父类bind绑定后，子类不需要再bind。
  • 在非Activity 类（eg：Fragment、ViewHold）中绑定： ButterKnife.bind(this，view);这里的this不能替换成getActivity()。
  • 在Activity中不需要做解绑操作，在Fragment 中必须在onDestroyView()中做解绑操作。
  • 使用ButterKnife修饰的方法和控件，不能用private or static 修饰，否则会报错。
    错误: @BindView fields must not be private or static. (com.zyj.wifi.ButterknifeActivity.button1)。
  • setContentView()不能通过注解实现。（其他的有些注解框架可以）
  • 使用Activity为根视图绑定任意对象时，如果你使用类似MVC的设计模式你可以在Activity 调用ButterKnife.bind(this, activity)，来绑定Controller。
  • 使用ButterKnife.bind(this，view)绑定一个view的子节点字段。如果你在子View的布局里或者自定义view的构造方法里 使用了inflate,你可以立刻调用此方法。或者，从XML inflate来的自定义view类型可以在onFinishInflate回调方法中使用它。
在Activity中绑定ButterKnife
public class ButterKnifeActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_butter_knife);
        //在Activity中绑定ButterKnife
        ButterKnife.bind(this);
    }
}
在Fragment中绑定ButterKnife
public class ButterKnifeFragment extends Fragment {

    private Unbinder unbinder;
    
    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment_butter_knife, container, false);
        //在Fragment中进行绑定ButterKnife，返回一个Unbinder(进行解绑)，这里的this不能用Activity
        unbinder = ButterKnife.bind(this, view);
        return view;
    }

    @Override
    public void onDestroyView() {
        super.onDestroyView();
        //在onDestroyView中进行解绑操作
        unbinder.unbind();
    }
}
在Adapter中绑定ButterKnife
public class ButterKnifeAdapter extends BaseAdapter {

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

        holder.name.setText("ButterKnife");
        holder.job.setText("Android");
        return view;
    }

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

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

    }
}

View绑定

  • 控件id注解
@BindView(R.id.fragment_answer_et1)
EditText et1;
@BindView(R.id.fragment_answer_et2)
EditText et2;
@BindView(R.id.fragment_answer_et3)
EditText et3;
  • 多个控件id注解
public class MainActivity extends AppCompatActivity {  

    @BindViews({ R.id.button1, R.id.button2,  R.id.button3})  
    public List<Button> buttonList ;  

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

        ButterKnife.bind(this);  

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

事件绑定

  • 控件点击事件
public class MainActivity extends AppCompatActivity {  

    @OnClick(R.id.button1 )   //给 button1 设置一个点击事件  
    public void showToast(){  
        Toast.makeText(this, "is a click", Toast.LENGTH_SHORT).show();  
    }  

    @OnLongClick( R.id.button1 )    //给 button1 设置一个长按事件  
    public boolean showToast2(){  
        Toast.makeText(this, "is a long click", Toast.LENGTH_SHORT).show();
    }  

    @Override  
    protected void onCreate(Bundle savedInstanceState) {  
        super.onCreate(savedInstanceState);  
        setContentView(R.layout.activity_main);  
        //绑定activity  
        ButterKnife.bind( this ) ;  
    }  
}
  • 多个id绑定事件
public class MainActivity extends AppCompatActivity {  

    //Tip：当涉及绑定多个id事件时，我们可以使用Android studio的Butterknife
    //插件zelezny快速自动生成
    @OnClick({R.id.ll_product_name, R.id.ll_product_lilv, R.id.ll_product_qixian, R.id.ll_product_repayment_methods})  
    public void onViewClicked(View view) {  
        switch (view.getId()) {  
            case R.id.ll_product_name:  
                System.out.print("我是点击事件1");  
                break;  
            case R.id.ll_product_lilv:  
                System.out.print("我是点击事件2");  
                break;  
            case R.id.ll_product_qixian:  
                System.out.print("我是点击事件3");  

                break;  
            case R.id.ll_product_repayment_methods:  
                System.out.print("我是点击事件4");  
                break;  
        }  
    }  
    @Override  
    protected void onCreate(Bundle savedInstanceState) {  
        super.onCreate(savedInstanceState);  
        setContentView(R.layout.activity_main);  
        //绑定activity  
        ButterKnife.bind( this ) ;
  • 省略setOnClickListener()
@OnClick(R.id.basic_finish_a_button)
    void finishA(View view) {
        finish();
    }//方法不能被private或public修饰，并且有一个参数
ButterKnife.inject(this);
  • ListView的点击@OnItemClick, CheckBox的@OnCheckedChanged也可以实现省略操作。

更多绑定注解

  • @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存在,则注入, 不存在,则什么事情都不做。

Copyright: 采用 知识共享署名4.0 国际许可协议进行许可

Links: https://www.yanghujun.com/archives/butterknife