注解庫(kù), JakeWharton大神的杰作
Note:文章基于8.5.1版本,不同的版本之間用法可能會(huì)稍有差異,實(shí)際版本使用以官方文檔為主
項(xiàng)目地址:https://github.com/JakeWharton/butterknife
文檔地址:http://jakewharton.github.io/butterknife/
有什么用?
初始化View,資源,綁定View事件.不用去寫(xiě)findViewById(...), setOn...Listener(...),只需要加上一行注解,配合Studio插件:Android ButterKnife Zelezny,自動(dòng)生成View注解, 大愛(ài)
怎么用?
- 引入ButterKnife
- 添加/聲明對(duì)應(yīng)的注解
引入ButterKnife
在早期版本引入只需要一行代碼,后來(lái)庫(kù)的分拆,增加,優(yōu)化,使得稍顯麻煩.新手上手時(shí),動(dòng)不動(dòng)會(huì)整出個(gè)空指針很正常.只需要注意區(qū)分項(xiàng)目的build.gradle,主程序的Module的build.gradle,依賴Module的Build.gradle:
- 項(xiàng)目的build.gradle:在項(xiàng)目的根目錄下
- 主程序的build.gradle:通常是一個(gè)名為app Module下的build.gradle,文件第一行是:apply plugin: 'com.android.application',這名代碼的意思是用來(lái)聲明這個(gè)Module是主程序Module
- 依賴Module的build.gradle:一個(gè)項(xiàng)目通常只有一個(gè)主程序Module,其它的就是依賴Module,當(dāng)然,是可以建多個(gè)主程序Module的,文件第一行代碼是:apply plugin: 'com.android.library',用來(lái)聲明這是一個(gè)依賴Module
在Module的build.gradle中添加
如果你要在哪個(gè)Module中使用,就不需要在哪個(gè)Module中添加
dependencies {
compile 'com.jakewharton:butterknife:8.5.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1'
}
在項(xiàng)目的build.gradle中添加
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'com.jakewharton:butterknife-gradle-plugin:8.5.1'
}
}
在主程序依賴Module的build.gradle中添加
apply plugin: 'com.android.library'
apply plugin: 'com.jakewharton.butterknife'
Note:在依賴Module中使用,聲明注解時(shí)用R2替代R, Like this
class ExampleActivity extends Activity {
@BindView(R2.id.user) EditText username;
@BindView(R2.id.pass) EditText password;
...
}
添加/聲明對(duì)應(yīng)的注解
在Activity中綁定View
class ExampleActivity extends Activity {
@BindView(R.id.title) TextView title;
@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);
// TODO Use fields...
}
}
只要在TextView title;加了@BindView(R.id.title),這個(gè)title就和布局simple_activity.xm中的id為title的TextView控件綁定了,并且?guī)湍銓?shí)例化了,就可以直接用它的相關(guān)方法:title.setXxx(..)之類.相當(dāng)于幫你寫(xiě)了,title = (TextView)this.findViewById(R.id.title);這段代碼,實(shí)際上在build項(xiàng)目的時(shí)候它就去生成了包含這樣代碼的文件,目錄:項(xiàng)目名->Module名->build->generated->source->apt->debug->對(duì)應(yīng)的包名下一些XXX$$ViewBinder的類,代碼大致如下:
public void bind(ExampleActivity activity) {
activity.subtitle = (android.widget.TextView) activity.findViewById(2130968578);
activity.footer = (android.widget.TextView) activity.findViewById(2130968579);
activity.title = (android.widget.TextView) activity.findViewById(2130968577);
}
資源文件綁定
class ExampleActivity extends Activity {
@BindString(R.string.title) String title;
@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
// ...
}
在非Activity中呢
在Activity中使用的是:ButterKnife.bind(this);
有非Activity中則是使用:ButterKnife.bind(this, view);
Fragment中使用
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);
// TODO Use fields...
return view;
}
}
在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);
}
}
}
View列表
你可以一次性將多個(gè)views綁定到一個(gè)List或數(shù)組中：
@BindViews({ R.id.first_name, R.id.middle_name, R.id.last_name })
List<EditText> nameViews;
apply函數(shù)可以讓集合中的View執(zhí)行相同的操作:
ButterKnife.apply(nameViews, DISABLE);
ButterKnife.apply(nameViews, ENABLED, false);
實(shí)現(xiàn)ButterKnife.Action或ButterKnife.Setter接口,如果你在項(xiàng)目中有這樣的需求:
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);
}
};
apply函數(shù)還提供設(shè)置View屬性的方法:
ButterKnife.apply(nameViews, View.ALPHA, 0.0f);
支持的屬性大概如下:
- ALPHA - 透明度
- TRANSLATION_X - 平移(相對(duì)于自身控件)
- TRANSLATION_Y
- TRANSLATION_Z
- X - 平移(相對(duì)于父控件)
- Y
- Z
- ROTATION - 角度
- ROTATION_X
- ROTATION_Y
- SCALE_X - 縮放
- SCALE_Y
上面說(shuō)的大多是基于View控件,資源的綁定,看下源代碼這個(gè)版本大概就下面這些:
- BindArray
- BindBitmap
- BindBool
- BindDimen
- BindDrawable
- BindInt
- BindString
- BindView
- BindViews
基于事件的綁定
給一個(gè)id設(shè)置OnClick事件,不用寫(xiě)xxx.setOnClickListener(...)了:
@OnClick(R.id.submit)
public void submit(View view) {
// TODO submit data to server...
}
方法名是自己定義的,沒(méi)有過(guò)多要求,參數(shù)中的View也是可選的,可以加,可以不加:
@OnClick(R.id.submit)
public void sayHi(Button button) {
button.setText("Hello!");
}
還可以為回調(diào)中的View加上指定的類型,但不要亂來(lái),本來(lái)是個(gè)Button,非要寫(xiě)個(gè)TextView,Like this:
@OnClick(R.id.submit)
public void sayHi(Button button) {
button.setText("Hello!");
}
當(dāng)然,也可以為多個(gè)控件id設(shè)置為同一個(gè)回調(diào)方法:
@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();
}
}
在自定義View中使用,不需要指定id:
public class FancyButton extends Button {
@OnClick
public void onClick() {
// TODO do something!
}
}
控件事件的綁定列表大致如下:
- OnCheckedChanged
- OnClick
- OnEditorAction
- OnFocusChange
- OnItemClick
- OnItemLongClick
- OnItemSelected
- OnLongClick
- OnPageChange
- OnTextChanged
- OnTouch
解綁
上面的內(nèi)容一直在說(shuō)綁定綁定綁定,ButterKnife.bind(this);是有返回值的,返回一個(gè)Unbinder對(duì)象,你需要在合適的生命周期里去解綁,調(diào)用它的unbind()函數(shù),比如,Activity中的onDestroy方法,Fragment的onDestroyView方法
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();
}
}
可選的綁定
情況是這樣的:上面說(shuō)的綁定View,綁定資源,綁定事件,如果綁定的目標(biāo)id沒(méi)有找到,這時(shí)候ButterKnife就會(huì)拋出異常,為了?抑制這種情況的發(fā)生,可以使用Android自帶注解庫(kù)中的@Nullable來(lái)添加到Field上,和ButterKnife中的@Optional添加到Method上
@Nullable @BindView(R.id.might_not_be_there) TextView mightNotBeThere;
@Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {
// TODO ...
}
最后
Butter Knife提供了一個(gè)findViewById的簡(jiǎn)化代碼:findById,用這個(gè)方法可以在View,Activity和Dialog中找到想要View,而且,該方法使用的泛型來(lái)對(duì)返回值進(jìn)行轉(zhuǎn)換,也就是說(shuō),你可以省去findViewById前面的強(qiáng)制轉(zhuǎn)換了.強(qiáng)迫癥的福因:
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);
