Butter Knife 簡介

Butter Knife

Butter Knife - Field and method binding for Android views。助你簡化程式碼,方便閱讀。

使用方法

開發 andriod app 的時候,一定有寫過類似的 code:

      class ExampleActivity extends Activity {
        TextView title;
        TextView subtitle;
        TextView footer;

        @Override public void onCreate(Bundle savedInstanceState) {
           super.onCreate(savedInstanceState);
           setContentView(R.layout.simple_activity);


           title = (TextView)findViewById(R.id.title);
           subtitle = (TextView)findViewById(R.id.subtitle);
           footer = (TextView)findViewById(R.id.footer);

           //other codes

        }}

當一個 activity 有很多個 view 的話,便會發覺這些 findViewById() 的 code 變得很長很煩很長很煩很長很煩。

用了 Butter Kinfe ,便可以簡化成

      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);

           // other codes
        }}

@Bind 加上 ButterKnife.bind() 自動指定對應的 view。是不是簡潔了很多?

Fragment 也可使用:

      public class FancyFragment extends Fragment {
        @Bind(R.id.button1) Button button1;
        @Bind(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 {
           @Bind(R.id.title) TextView name;
           @Bind(R.id.job_title) TextView jobTitle;

           public ViewHolder(View view) {
             ButterKnife.bind(this, view);
           }
        }
      }

另外可以將幾個 TextView 放在 List 中:

      @Bind({ R.id.first_name, R.id.middle_name, R.id.last_name })
      List<EditText> nameViews;

也可以用來取代 OnClickListener

      @OnClick(R.id.submit)
      public void submit(View view) {
        // TODO submit data to server...
      }

幾個 Button 當然可以用同一 method 啦

      @OnClick({ R.id.door1, R.id.door2, R.id.door3 })
      public void submit(View view) {
        // TODO submit data to server...
      }

安裝方法

到官網直接下載 jar 或者用 gradle

      compile 'com.jakewharton:butterknife:7.0.1'

      lintOptions {
        disable 'InvalidPackage'
      }

用 IntelliJ IDEA 的朋友可能要到 Setting > Annotation Processors 設定使用 Butter Knife。

如有使用 proguard,記得要加

      -keep class butterknife.** { *; }
      -dontwarn butterknife.internal.**
      -keep class **$$ViewBinder { *; }

      -keepclasseswithmembernames class * {
           @butterknife.* <fields>;
      }

      -keepclasseswithmembernames class * {
           @butterknife.* <methods>;
      }

好處

令 code 精簡,這一點已經足夠了。阿們。

總結

Butter Knife 看似作用不大,實際上不使用它也不會有大影響。但是一用上它便會愛上它的簡潔和方便,現在每個 project 也有使用。它是屬於那種「不用不會有問題,但一用便令人上癮」的類別的 libraries。

連結