Butter Knife:一個安卓視圖注入框架
2014年5月8日 星期四
14:52
官網： http://jakewharton.github.io/butterknife/
GitHub地址： https://github.com/JakeWharton/butterknife
JavaDocs地址： http://jakewharton.github.io/butterknife/javadoc/
注：本隨筆翻譯自官網，做了一些整理和注釋。來自我的OneNote筆記
大綱：
- @InjectView (Activity，Fragment)
- @InjectViews
- apply
- @OnClick
- reset
- @Optional
- @OnItemSelected
- TextView firstName = ButterKnife.findById(view, R.id.first_name);
Activity的注入方法：
| //基本使用方法：在onCreate方法中調用ButterKnife.inject(this)，然后就可以調用注解了 class ExampleActivity extends Activity { @InjectView(R.id.title) TextView title; @InjectView(R.id.subtitle) TextView subtitle; @InjectView(R.id.footer) TextView footer;
@Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.simple_activity); ButterKnife.inject(this); // TODO Use "injected" views... } } |
這個注入不是通過反射實現了（反射比較慢），而是直接生成代碼。上面的三個注入最后生成如下的代碼
| public void inject(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); } |
Fragment的注入方法：
| public class FancyFragment extends Fragment { @InjectView(R.id.button1) Button button1; @InjectView(R.id.button2) Button button2;
@Override View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { View view = inflater.inflate(R.layout.fancy_fragment, container, false); //僅僅是這里的區別 ButterKnife.inject(this, view); // TODO Use "injected" views... return view; } } |
簡化ViewHolder的使用
| public class MyAdapter extends BaseAdapter { @Override public View getView(int position, View view, ViewGroup parent) { //ViewHolder是一個普通的類，這個類包含了一個Adapter需要的所有View，然后設置到了tag中，方便復用 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 convertView; } //這里是ViewHolder：可以這樣進行注入 static class ViewHolder { @InjectView(R.id.title) TextView name; @InjectView(R.id.job_title) TextView jobTitle;
public ViewHolder(View view) { ButterKnife.inject(this, view); } } } |
注入一個View列表：@InjectViews
| //注入一個View列表 @InjectViews({ R.id.first_name, R.id.middle_name, R.id.last_name }) List<EditText> nameViews; //調用apply方法批量給View設置屬性 ButterKnife.apply(nameViews, DISABLE); ButterKnife.apply(nameViews, ENABLED, false); //其中，DISABLE和ENABLED是兩個接口的實現：Action，Setter static final Action<View> DISABLE = new Action<>() { @Override public void apply(View view, int index) { view.setEnabled(false); } } static final Setter<View, Boolean> ENABLED = new Setter<>() { @Override public void set(View view, Boolean value, int index) { view.setEnabled(value); } } ////View所有的屬性都可以在apply方法中調用 ButterKnife.apply(nameViews, View.ALPHA, 0); |
點擊監聽器的注入：OnClickListener -> @OnClick
| //簡單使用 @OnClick(R.id.submit)ren public void submit() { // TODO submit data to server... } //你可以傳入一個參數，Butter Knife會自動將注入的View轉換為對應的類型 @OnClick(R.id.submit) public void sayHi(Button button) { button.setText("Hello!"); } //當然，也可以指定多個視圖的IDs，用來進行通用的處理 @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(); } } |
注入的重置：reset
Fragment中，我們需要在onDestroyView中設置這些View為null，但是只要調用reset方法，Butter Knife會自動執行這個步驟。
| public class FancyFragment extends Fragment { @InjectView(R.id.button1) Button button1; @InjectView(R.id.button2) Button button2;
@Override View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { View view = inflater.inflate(R.layout.fancy_fragment, container, false); ButterKnife.inject(this, view); // TODO Use "injected" views... return view; }
@Override void onDestroyView() { super.onDestroyView(); ButterKnife.reset(this); } } |
可選的注入 @Optional
默認情況下，@InjectView和@OnClick注入是必須了，所以，如果找不到目標View就會拋出異常。如果想抑制這種情況，可以通過@Optional注解：
| @Optional @InjectView(R.id.might_not_be_there) TextView mightNotBeThere;
@Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() { // TODO ... } |
多方法的監聽@OnItemSelected
有些監聽注解響應的方法有多個回調函數，所以，我們可以通過指定回調參數來實現多個回調方法的綁定。
| @OnItemSelected(R.id.list_view) void onItemSelected(int position) { // TODO ... }
@OnItemSelected(value = R.id.maybe_missing, callback = NOTHING_SELECTED) void onNothingSelected() { // TODO ... } |
BONUS：其實就是一個方便的靜態方法而已
一般我們實例化一個View的時候是通過findById(id)，然后強制轉換實現的，這樣的代碼看着不雅觀。所以，ButterKnife有一個方法自動幫我們進行這樣的轉換（Context可以為View和Activity），如下面的例子：
| 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); |
最新版本：5.0.1
集成方法
Maven：
| <dependency> <groupId>com.jakewharton</groupId> <artifactId>butterknife</artifactId> <version>5.0.1</version> </dependency> |
Gradle：
- 添加依賴
| compile 'com.jakewharton:butterknife:5.0.1' |
- 消除lint warning
| lintOptions { disable 'InvalidPackage' } |
- Some configurations may also require additional exclusions.
| packagingOptions { exclude 'META-INF/services/javax.annotation.processing.Processor' } |
Procuard配置：(這個配置是為了打包apk的時候不至於把你的那些貌似沒有用過的程序片段給刪掉了)
| -dontwarn butterknife.internal.** -keep class **$$ViewInjector { *; } -keepnames class * { @butterknife.InjectView *;} |