Android 淺析 ButterKnife (一) 使用
前言
Linus Benedict Torvalds : RTFSC – Read The Fucking Source Code
概括
Field and method binding for Android views which uses annotation processing to generate boilerplate code for you.
ButterKnife是一個(gè)用注解的方式生成公式化的代碼將Android view的域和方法綁定一起的庫(kù)佩谣。
使用
Step 1 gradle
dependencies {
compile 'com.jakewharton:butterknife:7.0.1'
}
在Gradle中添加butterknife
庫(kù)。
Step 2 Bind
class ExampleActivity extends Activity {
@Bind(R.id.title) TextView title;
@Bind(R.id.subtitle) TextView subtitle;
@Bind(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...
}
}
這段代碼是幫你簡(jiǎn)化我們平常書(shū)寫(xiě)繁瑣的findViewById()
操作酬诀,在代碼實(shí)際編譯中的時(shí)候會(huì)自動(dòng)轉(zhuǎn)換成我們熟悉的代碼有梆,例子中的代碼在實(shí)際編譯中會(huì)生成這些代碼:
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);
}
資源的BINDING
在對(duì)資源的Bind方法中有許多不同的注解可以用:
@BindBool, @BindColor, @BindDimen, @BindDrawable, @BindInt, @BindString
這些可以幫你在資源使用前綁定資源的id。
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
// ...
}
ButterKnife的簡(jiǎn)單實(shí)用方法就是這些了醉箕,非常簡(jiǎn)單钾腺,接下來(lái)我們深入的看看深入使用方法。
非Activity中使用
在非Activity中也可以同過(guò)綁定view 來(lái)實(shí)行綁定資源讥裤。
private void initFloatWinCollectPage() {
View view = findViewById(R.id.floatwin_collectpage_layout);
ButterKnife.bind(this, view);
}
當(dāng)然這種綁定也可以用在holder這些繁瑣的操作上面放棒,在getview的函數(shù)里不斷的綁定view也只需要一個(gè)操作就實(shí)現(xiàn)了。
批量操作
// 方法一
@Bind({ R.id.first_name, R.id.middle_name, R.id.last_name })
List<EditText> nameViews;
// 方法二
ButterKnife.apply(nameViews, DISABLE);
ButterKnife.apply(nameViews, ENABLED, false);
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);
}
};
這兩個(gè)方法都可以對(duì)資源進(jìn)行批量操作己英,第一種是批量的賦值操作间螟,第二種是對(duì)資源的批量顯示或隱藏操作。
ButterKnife.apply(nameViews, View.ALPHA, 0.0f);
當(dāng)然也可以對(duì)資源的屬性進(jìn)行操作了损肛。
LISTENER 綁定
@OnClick(R.id.submit)
public void submit(View view) {
}
@OnClick(R.id.submit)
public void sayHi(Button button) {
button.setText("Hello!");
}
通過(guò)綁定可以快速的將一個(gè)方法和控件聯(lián)系在一起厢破。
當(dāng)然也可以將多個(gè)id綁定到一個(gè)方法里:
@OnClick({ R.id.door1, R.id.door2, R.id.door3 })
public void pickDoor(DoorView door) {
if (door.hasPrizeBehind()) {}
else {}
}
BINDING RESET
在綁定取消的時(shí)候調(diào)用unbind
方法
ButterKnife.unbind(this);
OPTIONAL BINDINGS
默認(rèn)情況下,@Bind和監(jiān)聽(tīng)綁定是必需的治拿。如果目標(biāo)視圖不能找到一個(gè)異常將被拋出摩泪。
為了抑制這種行為,創(chuàng)造一個(gè)可選的綁定忍啤,添加注釋@Nullable到方法最外邊加勤。
@Nullable @Bind(R.id.might_not_be_there) TextView mightNotBeThere;
總結(jié)
最后仙辟,要細(xì)看ButterKnife的代碼應(yīng)該直接看源碼:
https://github.com/JakeWharton/butterknife