阅读 3338

Butter Knife常用用法总结

早就听过Butter Knife这个神器,公司最近新开了一个项目,用到了这个框架,但也只是简单使用自动绑定控件,昨天抽时间看了下官网,发现这个框架还可以做其他很多的工作,来提高开发效率,总结一下常用用法。

一 导入

dependencies {
  compile 'com.jakewharton:butterknife:8.5.1'
  annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1'
}复制代码

目前最新版为8.5.1

二 用法

  • 单个控件绑定

    class ExampleActivity extends Activity {
      @BindView(R.id.title) TextView title;//@BindView注解加控件id标注要查找的控件
      @BindView(R.id.subtitle) TextView subtitle;
      @BindView(R.id.footer) TextView footer;
    
      @Override public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.simple_activity);
        ButterKnife.bind(this);//在当前activity自动绑定
        // TODO Use fields...
      }
    }复制代码
  • 资源绑定
    class ExampleActivity extends Activity {
      @BindString(R.string.title) String title;//@BindString注解加资源id标注要查找的资源
      @BindDrawable(R.drawable.graphic) Drawable graphic;
      @BindColor(R.color.red) int red; // int or ColorStateList field
      @BindDimen(R.dimen.spacer) Float spacer; // int (for pixel size) or float (for exact value) field
      // ...
    }复制代码
  • 根据自定义的根布局来自动绑定布局里的控件

    public class FancyFragment extends Fragment {
      @BindView(R.id.button1) Button button1;
      @BindView(R.id.button2) Button button2;
    
      @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fancy_fragment, container, false);
        ButterKnife.bind(this, view);//自动绑定Activity根部局控件的时候直接传this即可
        // TODO Use fields...
        return view;
      }
    }复制代码
  • 在adapter里绑定控件

    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);//item布局
          holder = new ViewHolder(view);//传给ViewHolder
          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);//其实就是根据我们自己提供的根布局来绑定控件
        }
      }
    }复制代码
  • 控件集合绑定
    @BindViews({ R.id.first_name, R.id.middle_name, R.id.last_name })
    List<EditText> nameViews;复制代码
  • 同时操作多个控件
    ButterKnife.apply(nameViews, DISABLE);
    ButterKnife.apply(nameViews, ENABLED, false);复制代码
    DISABLE,ENABLED是ButterKnife提供的一种数据类型ButterKnife.Action,它是一个接口,需要我们根据需求实现其中的apply()方法,这里:
    static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
      @Override public void apply(View view, int index) {
        view.setEnabled(false);
      }
    };
    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);
      }
    };复制代码
    注意:ButterKnife.apply具有多个重载方法,例如还可以设置属性等:
    ButterKnife.apply(nameViews, View.ALPHA, 0.0f);复制代码
  • 单个控件事件绑定
    @OnClick(R.id.submit)//注解控件
    public void test(View view) {//点击控件后触发的方法,参数可选
      // TODO submit data to server...
    }复制代码
  • 多个控件事件绑定
    @OnClick({ R.id.door1, R.id.door2, R.id.door3 })
    public void test(View view) {
      switch(view.getId()){
        case R.id.door1:
          //todo something
          break;
        case R.id.door2:
          //todo something
          break;
        case R.id.door3:
          //todo something
          break;
        default:
          break;
      }
    }复制代码
  • 绑定重置
    与Activity相比,Fragment的视图具有不同的生命周期,在onCreateView中绑定视图的时候,Butter Knife会返回一个Unbinder类型的对象,我们可以在合适的生命周期回调方法中调用它unbind()方法来解除绑定。

    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);//返回unbinder对象
        // TODO Use fields...
        return view;
      }
    
      @Override public void onDestroyView() {
        super.onDestroyView();
        unbinder.unbind();//解除绑定
      }
    }复制代码
  • 可选绑定(OPTIONAL BINDINGS)
    通常,控件绑定与事件绑定我们都需要,但是如果没有找不到目标view的话会报错,为了避免这种情况,可以用@Nullable和@Optional这两个注解,如果找不到目标view存在,就自动绑定,不存在,也不会出错。

    @Nullable @BindView(R.id.might_not_be_there) TextView mightNotBeThere;
    
    @Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {
      // TODO ...
    }复制代码
  • ButterKnife.findById()
    Butter Knife提供了一个findById()的方法,它主要用来简化控件类型转化:
    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);复制代码
    findById()有两个参数,第一个是目标view,有三种类型:View,Activity,Dialog,第二个参数是要查找的控件id。它主要是通过返回泛型来自动执行类型转换。
  • 自动生成绑定的插件
    最后推荐一个插件android butterknife zelezny,可以自动生成绑定代码:


具体用法请参考:blog.csdn.net/dreamliveme…

参考:

  1. jakewharton.github.io/butterknife…
  2. github.com/JakeWharton…
关注下面的标签,发现更多相似文章
评论