转: Square全家桶正传——偷懒神器ButterKnife及其附属插件的使用
另一篇:Android注解神器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有哪些功能吧,官网上是这样描述的:
- 通过使用@BindView来消除调用findViewById();
- 可以把多个View放在一个数组或者list中。然后一次性可以同时对这些View的动作,属性等进行操作;
- 通过使用@OnClick注解来消除由监听器带来的匿名内部类;
- 通过对resource进行注解来消除多余的资源查找代码。
获取ButterKnife:
-
在你的项目的build.gradle中加入以下依赖:
1
2
3
4
5
6
7
8buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
}
} -
在你的Module的build.gradle中加入以下依赖:
1 | apply plugin: 'android-apt' |
注意:apply plugin: ‘android-apt’
基本使用
下面的代码演示了ButterKnife的基本使用技巧:
1 | class ExampleActivity extends Activity { |
包括以下几个步骤:
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)
对监听事件:
1 | @OnClick(R.id.submit) void submit() { |
2.在onCreate方法或者onCreateView方法中调用方法:
unBinder = ButterKnife.bind(this);//如果在Fragment中使用ButterKnife.bind(this,view);
3.在onDestory方法或者onDestoryView中解除绑定:
unBinder = ButterKnife.unbind();
进阶操作:
1.利用ViewList实现同时配置多个View:
①. 将多个View绑定到一个List中:
1 | @BindViews({ R.id.first_name, R.id.middle_name, R.id.last_name }) |
②. 调用ButterKnife.apply()方法:
1 | ButterKnife.apply(nameViews, DISABLE); |
按照官网的思路,上面三行分别是对nameViews中所有View的action,Setter和Property的设置,但是仅仅调用了apply()方法并不能真正修改nameViews中的View,必须完成下一步工作。
③. 实现接口:
1 | static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() { |
上面代码已经将action和Setter实现,重写接口内部方法apply或set,在内部实现对nameViews的操作。这样就完成了同时操作多个View的功能。
2. 利用形参直接对当前View进行操作
1 | @OnClick(R.id.submit) |
3. 实现多View点击事件的关联(原理同2)
1 | @OnClick({ R.id.door1, R.id.door2, R.id.door3 }) |
4.防止目标View不存在出现exception的请况的发生
1 | @Nullable @BindView(R.id.might_not_be_there) TextView mightNotBeThere; |
通过使用@Nullable或者@Optional实现防止因为目标View不存在出现exception的请况的发生。
5. 代替onItemClickListener的注解实现
1 | @OnItemSelected(R.id.list_view) |
6. 通过LayoutInflater获取View的ButterKnife实现方法findById:
1 | View view = LayoutInflater.from(context).inflate(R.layout.thing, null); |
注:这个真没觉得哪里简单了。。。
到此我们讲完了ButterKnife的基本使用。怎样不错吧?下面有更强大的东西——ButterKnifeZelezny,配合着这个神器一起使用,可以为我们的项目节省大量时间和增加代码可读性。
ButterKnifeZelezny
下载地址:
http://plugins.jetbrains.com/plugin/7369
关于AS安装插件的问题在这里不多阐述了,不会的自行百度。
基本用法
下面这幅图展示了ButterKnifeZelezny的基本用法。
![bkz](https://github.com/avast/android-butterknife-zelezny/blob/master/img/zelezny_animated.gif?raw=true)
基本步骤:
- 有所使用的布局 ID 上点击右键 (例如上图中的 R.layout.activity_settings ), 然后选择 Generate -> Generate ButterKnife Injections
- 在对话框中选择需要注入的 View, 还有个选项可以给 Adapter 创建一个 ViewHolder。
- 点击 Confirm , 代码自动生成!
总结:
本文只是关于ButterKnife用法的介绍,关于Java中的依赖注解的知识博主仍在学习中,有兴趣参照《Java编程思想》一书关于Annotation的介绍,此外欢迎继续关注博主的Square全家桶系列。