Square全家桶正传——偷懒神器ButterKnife及其附属插件的使用

写作原因:程序员喜欢偷懒,对于安卓程序员来说,把时间花在不用动脑筋的findViewById()上简直让人难以忍受。此外大量的点击监听事件的分散化使得代码可读性下降。于是,基于注解的ButterKnife应运而生。

参考链接:

ButterKnife官网:http://jakewharton.github.io/butterknife/

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

ButterKnife-Zelezny地址:https://github.com/avast/android-butterknife-zelezny


简介

先来看看ButterKnife有哪些功能吧,官网上是这样描述的:

  1. 通过使用@BindView来消除调用findViewById();
  2. 可以把多个View放在一个数组或者list中。然后一次性可以同时对这些View的动作,属性等进行操作;
  3. 通过使用@OnClick注解来消除由监听器带来的匿名内部类;
  4. 通过对resource进行注解来消除多余的资源查找代码。

获取ButterKnife:

  1. 在你的项目的build.gradle中加入以下依赖:
buildscript {
  repositories {
    mavenCentral()
   }
  dependencies {
    classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
  }
}
  1. 在你的Module的build.gradle中加入以下依赖:
apply plugin: 'android-apt'

android {
  ...
}

dependencies {
  compile 'com.jakewharton:butterknife:8.1.0'
  apt 'com.jakewharton:butterknife-compiler:8.1.0'
}

注意:apply plugin: 'android-apt'

基本使用

下面的代码演示了ButterKnife的基本使用技巧:

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...
  }
}

包括以下几个步骤:

1.定义UnBinder对象,对待操作元素进行注解:

定义:private UnBinder unBinder;

对View:@BindView(R.id.user) EditText username;

对Resource:@BindString(R.string.login_error) String loginErrorMessage;

(注:资源绑定有以下注解:@BindBool, @BindColor, @BindDimen, @BindDrawable, @BindInt, @BindString)

对监听事件:

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

2.在onCreate方法或者onCreateView方法中调用方法:

unBinder = ButterKnife.bind(this);//如果在Fragment中使用ButterKnife.bind(this,view);

3.在onDestory方法或者onDestoryView中解除绑定:

unBinder = ButterKnife.unbind();

进阶操作:

1.利用ViewList实现同时配置多个View:

①. 将多个View绑定到一个List中:

@BindViews({ R.id.first_name, R.id.middle_name, R.id.last_name })
List<EditText> nameViews;

②. 调用ButterKnife.apply()方法:

ButterKnife.apply(nameViews, DISABLE);
ButterKnife.apply(nameViews, ENABLED, false);
ButterKnife.apply(nameViews, View.ALPHA, 0.0f);

按照官网的思路,上面三行分别是对nameViews中所有View的action,Setter和Property的设置,但是仅仅调用了apply()方法并不能真正修改nameViews中的View,必须完成下一步工作。

③. 实现接口:

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

上面代码已经将action和Setter实现,重写接口内部方法apply或set,在内部实现对nameViews的操作。这样就完成了同时操作多个View的功能。

2. 利用形参直接对当前View进行操作

@OnClick(R.id.submit)
public void sayHi(Button button) {
  button.setText("Hello!");
}

3. 实现多View点击事件的关联(原理同2)

@OnClick({ R.id.door1, R.id.door2, R.id.door3 })
public void pickDoor(DoorView door) {
  if (door.hasPrizeBehind()) {
    Toast.makeText(this, "You win!", LENGTH_SHORT).show();
  } else {
    Toast.makeText(this, "Try again", LENGTH_SHORT).show();
  }
}

4.防止目标View不存在出现exception的请况的发生

@Nullable @BindView(R.id.might_not_be_there) TextView mightNotBeThere;

@Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {
  // TODO ...
}

通过使用@Nullable或者@Optional实现防止因为目标View不存在出现exception的请况的发生。

5. 代替onItemClickListener的注解实现

@OnItemSelected(R.id.list_view)
void onItemSelected(int position) {
  // TODO ...
}

6. 通过LayoutInflater获取View的ButterKnife实现方法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);

注:这个真没觉得哪里简单了。。。

到此我们讲完了ButterKnife的基本使用。怎样不错吧?下面有更强大的东西——ButterKnifeZelezny,配合着这个神器一起使用,可以为我们的项目节省大量时间和增加代码可读性。

ButterKnifeZelezny

下载地址:

http://plugins.jetbrains.com/plugin/7369

关于AS安装插件的问题在这里不多阐述了,不会的自行百度。

基本用法

下面这幅图展示了ButterKnifeZelezny的基本用法。


bkz
bkz

基本步骤:

  1. 有所使用的布局 ID 上点击右键 (例如上图中的 R.layout.activity_settings ), 然后选择 Generate -> Generate ButterKnife Injections
  2. 在对话框中选择需要注入的 View, 还有个选项可以给 Adapter 创建一个 ViewHolder。
  3. 点击 Confirm , 代码自动生成!

总结:

本文只是关于ButterKnife用法的介绍,关于Java中的依赖注解的知识博主仍在学习中,有兴趣参照《Java编程思想》一书关于Annotation的介绍,此外欢迎继续关注博主的Square全家桶系列。

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

推荐阅读更多精彩内容