BufferKnife作為框架式編程的重要組成部分,使用BufferKnife能夠極大的精簡View層面的代碼量,並為MVP/MVC方式提供輔助。
一、配置
compile 'com.jakewharton:butterknife:(insert latest version)'
annotationProcessor 'com.jakewharton:butterknife-compiler:(insert latest version)'
二、使用
Android 開發過程中,我們需要寫大量的findViewById()和setonclicktListener()等事件, 那么現在有一個框架可以很好的解決這個問題 ---- BufferKnife。BufferKnife可以大量精簡代碼,而且不影響性能,可以通過查看Butter Knife了解到,其自定義注解的實現都是限定為RetentionPolicy.CLASS,也就是到編譯出.class文件為止有效,在運行時不會額外消耗性能。
2.1 基本用法
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); // 必須在設置好布局事件后綁定當前的Activity // TODO Use fields... } }
上面的慢反射代碼執行下來生成的class代碼如下:
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); }
2.2 資源綁定
可以使用@BindBool
, @BindColor
, @BindDimen
, @BindDrawable
, @BindInt
, @BindString來預綁定一些資源到對應的字段。
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綁定時多傳遞一個參數即可,即根View:
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; } }
Butter Knife 還有另一個用途就是簡化List的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); } } }
基本上你想調用findViewById的方法的地方應該都是可以設置ButterKnife.bind的。
使用ButterKnife.bind(這)將視圖的孩子綁定到字段中。 如果您在布局中使用<merge>標簽,並在自定義視圖構造函數中展開,則可以立即調用它。 或者,從XML擴展的自定義視圖類型可以在onFinishInflate()回調中使用它。
提供的其他的綁定的APIs:
- 使用Activity作為視圖根來綁定任意對象。如果你使用類似MVC 的模式,你可以使用ButterKnife.bind(this, activity)來綁定控制器。
ButterKnife還可以處理View Lists:
你可以將多個view分組到List或者Array:
@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的Action
和 Setter
接口允許你做一些特定的操作。
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); } };
Anroid的一些屬性也可以和apply方法一起使用。
ButterKnife.apply(nameViews, View.ALPHA, 0.0f);
2.3 監聽綁定
使用ButterKnife可以自動將監聽配置到方法上。如下:
@OnClick(R.id.submit) public void submit(View view) { // TODO submit data to server... }
監聽方法的參數是可選的。如下:
@OnClick(R.id.submit) public void submit() { // TODO submit data to server... }
定義一個特定的類型, 它能夠被自動轉換。如下:
@OnClick(R.id.submit) public void sayHi(Button button) { button.setText("Hello!"); }
一次綁定可以處理多個事件:
@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(); } }
自定義Views可以不同指定ID來綁定到自己的監聽器:
public class FancyButton extends Button { @OnClick public void onClick() { // TODO do something! } }
2.4 綁定重置
Fragments和Activity有不同的生命周期。在fragment的onCreateView綁定了之后,要在onDestroyView中置為null。BufferKnife在你調用了bind之后返回給了你一個Unbinder實例。你需要做的事情就是在適當的生命周期內調用unbind方法。
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(); } }
2.5 可選綁定
默認情況下,@Bind和監聽器綁定都是必需的。 如果找不到目標視圖,將拋出異常。
要抑制此行為並創建可選綁定,請將@Nullable注釋添加到字段或將@Optional注釋添加到方法中。
注意:任何名為@Nullable的注釋都可用於字段。 我們鼓勵使用Android的“支持注釋”庫中的@Nullable注釋。
@Nullable @BindView(R.id.might_not_be_there) TextView mightNotBeThere; @Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() { // TODO ... }
2.6 多方法監聽器
方法注釋,其相應的偵聽器具有多個回調,可以用於綁定到任何一個。 每個注釋都有一個默認的回調,它綁定到。 使用回調參數指定備用。
@OnItemSelected(R.id.list_view) void onItemSelected(int position) { // TODO ... } @OnItemSelected(value = R.id.maybe_missing, callback = NOTHING_SELECTED) void onNothingSelected() { // TODO ... }
2.7 Bonus
還包括findById方法,它簡化了仍然必須在View,Activity或Dialog上查找視圖的代碼。 它使用泛型來推斷返回類型並自動執行轉換。
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.findById添加靜態導入,並享受更多樂趣。
參考資料:https://www.jianshu.com/p/3678aafdabc7