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<View>,它是一个接口,需要我们根据需求实现其中的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,可以自动生成绑定代码:

图片发自简书App

具体用法请参考:http://blog.csdn.net/dreamlivemeng/article/details/51261170
参考:

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容