Butter Knife經常使用用法總結

早就聽過Butter Knife這個神器，公司最近新開了一個項目，用到了這個框架，但也只是簡單使用自動綁定控件，昨天抽時間看了下官網，發現這個框架還能夠作其餘不少的工做，來提升開發效率，總結一下經常使用用法。

一 導入

dependencies {
  compile 'com.jakewharton:butterknife:8.5.1'
  annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1'
}複製代碼

目前最新版爲8.5.1

二 用法

• 單個控件綁定

  class ExampleActivity extends Activity {
    @BindView(R.id.title) TextView title;//@BindView註解加控件id標註要查找的控件
    @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 ExampleActivity extends Activity {
    @BindString(R.string.title) String title;//@BindString註解加資源id標註要查找的資源
    @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
    // ...
  }複製代碼

• 根據自定義的根佈局來自動綁定佈局裏的控件

  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);//自動綁定Activity根部局控件的時候直接傳this便可
      // TODO Use fields...
      return view;
    }
  }複製代碼

• 在adapter裏綁定控件

  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);//item佈局
        holder = new ViewHolder(view);//傳給ViewHolder
        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);//其實就是根據咱們本身提供的根佈局來綁定控件
      }
    }
  }複製代碼

• 控件集合綁定

  @BindViews({ R.id.first_name, R.id.middle_name, R.id.last_name })
  List<EditText> nameViews;複製代碼

• 同時操做多個控件

  ButterKnife.apply(nameViews, DISABLE);
  ButterKnife.apply(nameViews, ENABLED, false);複製代碼

  DISABLE,ENABLED是ButterKnife提供的一種數據類型ButterKnife.Action ，它是一個接口，須要咱們根據需求實現其中的apply()方法，這裏：

  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);
    }
  };複製代碼

  注意：ButterKnife.apply具備多個重載方法，例如還能夠設置屬性等：

  ButterKnife.apply(nameViews, View.ALPHA, 0.0f);複製代碼

• 單個控件事件綁定

  @OnClick(R.id.submit)//註解控件
  public void test(View view) {//點擊控件後觸發的方法，參數可選
    // TODO submit data to server...
  }複製代碼

• 多個控件事件綁定

  @OnClick({ R.id.door1, R.id.door2, R.id.door3 })
  public void test(View view) {
    switch(view.getId()){
      case R.id.door1:
        //todo something
        break;
      case R.id.door2:
        //todo something
        break;
      case R.id.door3:
        //todo something
        break;
      default:
        break;
    }
  }複製代碼

• 綁定重置
  與Activity相比，Fragment的視圖具備不一樣的生命週期，在onCreateView中綁定視圖的時候，Butter Knife會返回一個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);//返回unbinder對象
      // TODO Use fields...
      return view;
    }
  
    @Override public void onDestroyView() {
      super.onDestroyView();
      unbinder.unbind();//解除綁定
    }
  }複製代碼

• 可選綁定（OPTIONAL BINDINGS）
  一般，控件綁定與事件綁定咱們都須要，可是若是沒有找不到目標view的話會報錯，爲了不這種狀況，能夠用@Nullable和@Optional這兩個註解，若是找不到目標view存在，就自動綁定，不存在，也不會出錯。

  @Nullable @BindView(R.id.might_not_be_there) TextView mightNotBeThere;
  
  @Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {
    // TODO ...
  }複製代碼

• ButterKnife.findById()
  Butter Knife提供了一個findById()的方法，它主要用來簡化控件類型轉化：

  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);複製代碼

  findById()有兩個參數，第一個是目標view，有三種類型：View,Activity,Dialog，第二個參數是要查找的控件id。它主要是經過返回泛型來自動執行類型轉換。
• 自動生成綁定的插件
  最後推薦一個插件android butterknife zelezny，能夠自動生成綁定代碼：

具體用法請參考： blog.csdn.net/dreamliveme…

參考：

1. jakewharton.github.io/butterknife…
2. github.com/JakeWharton…