Butter Knife 8.4.0 用法記錄

Butter Knife的性能與原生差不多,而且使用起來方便。所以,項目中還是比較常用的。記錄一下常見的用法。

1、Android studio配置

1.1、 在項目工程的 build.gradle 文件中 引入android-apt插件:
加入:classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
如下圖:

buildscript {
  repositories {
     ...
   }
  dependencies {
    classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
  }
}

1.2、在Module的 build.gradle里配置:
android-apt插件應用到module的build.gradle中,然后加入相應的依賴包。

apply plugin: 'android-apt'

android {
  ...
}

dependencies {
  compile 'com.jakewharton:butterknife:8.4.0'
  apt 'com.jakewharton:butterknife-compiler:8.4.0'
}

2、使用注解

2.1、在Activity中使用注解

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);      //這個必須有
    // TODO Use fields...
  }
}

相比與緩慢的反射機制,Butter Knife的代碼是生成的,因此不必擔心注解的性能問題。調用 bind來生成這些代碼,你可以查看或調試這些代碼。
例如上面的例子,生成的代碼大致如下所示:

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

注意一點,必須 ButterKnife.bind() 注解才能生效。

2.2、資源注解

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
  // ...
}

通過@BindBool, @BindColor, @BindDimen, @BindDrawable, @BindInt,@BindString可以給變量綁定一個已經定義好的資源。

2.3、在非activity中使用注解

2.3.1、Fragment中使用注解

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

}

Fragment的生命周期與Activity不同。在Fragment中,我們可能會在onCreateView中綁定一個布局,并在onDestroyView中設置所有view為null.此時,你就需要Butter Knife提供的undind函數來做此事。

2.3.2、在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);
      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);
    }
  }
}

2.4、View列表

2.4.1、將多個view組成一組,加到list或者array中

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

2.4.2、設置View的屬性

其中apply方法可以設置view的屬性:

ButterKnife.apply(nameViews, View.ALPHA, 0.0f);    //設置nameViews里每個EditText的ALPHA屬性為0.0f

2.4.3、對列表中每一個元素上進行調用

首先使用ActionSetter接口指定一些簡單的動作:

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

然后調用apply方法對列表中每一個元素上進行調用:

ButterKnife.apply(nameViews, DISABLE);    //設置nameViews里每個EditText的為非活動狀態
ButterKnife.apply(nameViews, ENABLED, true); //設置nameViews里每個EditText的為活動狀態

2.5、監聽器注解

使用方法如下:

@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) {    //必須與R.id.submit指定控件的類型對應
  button.setText("Hello!");
}

多個不同的ID也可以綁定同一個函數。

@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();
  }
}

自定義控件綁定監聽器時不需要ID

public class FancyButton extends Button {
  @OnClick
  public void onClick() {
    // TODO do something!
  }
}

2.6、@Nullable或@optional注釋

在默認情況下, @bind和監聽器的綁定都是需要的,如果目標view沒有找到的話,Butter Knife將會拋出一個異常。
如果你并不想接收到這樣的信息,那么就在你的方法或變量上使用@Nullable注釋字段或@optional注釋。
Note: 關于@Nullable注解,可查看androd官方庫文件Android's "support-annotations" library.

@Nullable @BindView(R.id.might_not_be_there) TextView mightNotBeThere;

@Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() { 
      // TODO ...
}

2.7、ButterKnife.findById

Butter knife仍然包含了findById方法,用于仍需從一個view ,Activity,或者Dialog上 find view的時候。并且它可以自動轉換類型。

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

2.8、其他的監聽器接口

在之前項目中,發現老版本的ButterKnife居然沒有辦法處理RadioGroup的setOnCheckedChangeListener。但是似乎在8.4.0中添加了新的接口了。這里整理一下其他的接口。

Annotation Associated Interface
@OnCheckedChange android.widget.CompoundButton.OnCheckedChangeListener
@OnClick butterknife.internal.DebouncingOnClickListener
@OnEditorAction android.widget.TextView.OnEditorActionListener
@OnFocusChange android.view.View.OnFocusChangeListener
@OnItemClick android.widget.AdapterView.OnItemClickListener
@OnItemLongClick android.widget.AdapterView.OnItemLongClickListener
@OnLongClick android.view.View.OnLongClickListener
@OnTouch android.view.View.OnTouchListener

2.9、寫在最后

ButterKnife還是挺強大的,但是常見的用法應該也就這些了。它還有很多別的用法,可以參考下面的文章。
http://craftedcourses.io/all-about-butter-knife-part-3/

參考:

http://craftedcourses.io/all-about-butter-knife-part-3/
https://github.com/JakeWharton/butterknife
http://jakewharton.github.io/butterknife/
http://www.lxweimin.com/p/9ad21e548b69

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容