ButterKnife使用及Library填坑记

这段时间学习有所懈怠,没有坚持写博文,后续要自我约束继续加油。也警告自己不要陷在业务代码开发的泥淖中,一定要抽空学习总结。

言归正传,ButterKnife的源码地址是:https://github.com/JakeWharton/butterknife。该库使用注解来实现Field和Method的绑定。使用中遇到问题建议优先其次都必须参考官方文档哦!

优点如下:

  • Eliminate findViewById calls by using @BindView on fields.
  • Group multiple views in a list or array. Operate on all of them at once with actions, setters, or properties.
  • Eliminate anonymous inner-classes for listeners by annotating methods with @OnClick and others.
  • Eliminate resource lookups by using resource annotations on fields.

简单的使用代码如下:

class ExampleActivity extends Activity {
  @BindView(R.id.user) EditText username;
  @BindView(R.id.pass) EditText password;

  @BindString(R.string.login_error) String loginErrorMessage;

  @OnClick(R.id.submit) void submit() {
    // TODO call server...
  }

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

Bind使用场景

Activity

具体见上面的示例代码。ButterKnife.bind(activity)

Fragment

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);
    // TODO Use fields...
    return view;
  }

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

注意,使用ButterKnife.bind(fragment, view)。根据文档,由于Fragment的特殊性,在onCreateView进行bind时,需要在onDestroyView中进行解绑。

Adapter的ViewHolder使用

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);
    }
  }
}

还有一个使用的细节觉得蛮有意思,默认情况下,使用@Bind和监听器时,如果目标View不存在就会抛出异常。为了避免这种行为,可以用@Nullable注解(Field)和@Optional注解(methods)。

具体的使用文档参考:http://jakewharton.github.io/butterknife/

App模块编译配置

在app模块的build.gradle中,添加如下依赖。

dependencies {
  implementation 'com.jakewharton:butterknife:8.8.1'
  annotationProcessor 'com.jakewharton:butterknife-compiler:8.8.1'
}

注意:If you are using Kotlin, replace annotationProcessor with kapt.

Library模块编译配置

随着代码复杂度的增加,多组件随之出现,这也给ButterKnife的使用带来了麻烦。参考官方文档,步骤如下:
一、在lib模块的buildscript增加如下代码

buildscript {
  repositories {
    mavenCentral()
   }
  dependencies {
    classpath 'com.jakewharton:butterknife-gradle-plugin:8.8.1'
  }
}

二、在lib模块中使用

apply plugin: 'com.android.library'
apply plugin: 'com.jakewharton.butterknife'

三、通过R2而不是R来引用

class ExampleActivity extends Activity {
  @BindView(R2.id.user) EditText username;
  @BindView(R2.id.pass) EditText password;
...
}

填坑记

在多个Lib中使用R2时,Android Studio自动添加在引用始终是第一个添加的module(也可能是最底层编译依赖的模块,未测试),此时可通过直接添加import 模块名.R2来解决。傻傻的我非得用快捷键自动添加引用,浪费自己的时间哦。

注意switch-case语句的使用,在library中不能使用资源id作为case值,否则会出现Validates using resource IDs in a switch statement in Android library module异常。解决方法就是用if-else代替,并注意在代码中使用R来引用资源id

@OnClick({R2.id.textView, R2.id.button1, R2.id.button2, R2.id.button3, R2.id.image})
    public void onViewClicked(View view) {
        int i = view.getId();
        if (i == R.id.textView) {
        } else if (i == R.id.button1) {
        } else if (i == R.id.button2) {
        } else if (i == R.id.button3) {
        } else if (i == R.id.image) {
        }
    }

在使用中写出了一段代码,将一个Activity中的两个动态View分别调用bin d(this,view),但是其中一个view在运行时绑定的对象示例为null。可参考这个文章,通过ViewHolder来解决。https://segmentfault.com/q/1010000009989285

参考文章:
Butter Knife —— 最好用的View注入
多个library使用butterknife的坑
Validates using resource IDs in a switch statement in Android library module
butterknife组件化开发library中R类问题的批量解决方案
解决组件化开发butterknife 在 library中使用的坑

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

推荐阅读更多精彩内容

  • afinalAfinal是一个android的ioc,orm框架 https://github.com/yangf...
    passiontim阅读 15,421评论 2 45
  • Jake Wharton 是 Android 大神,同时也是开源狂魔。他开源的项目特点是小而美,且应用广泛,比如 ...
    geniusmart阅读 12,087评论 3 79
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,016评论 25 707
  • 其实你爱与不爱我,并不让我多在意。 我爱你只是我的事情而已,我爱那个少年,也许是他刚提剑下山,满脸稚嫩青涩却满怀热...
    鲸骨鹿枝阅读 132评论 0 0
  • 世界安静了 报站声噪的怕人 从你的方向又来了一趟列车 我却又焦急了一分 幻想着所有可能 又一一排除 你没有来 我还...
    竹门日单阅读 128评论 3 1