Android ButterKnife使用

該框架是一個綁定註解的框架,能夠簡化安卓中findViewById()和設置監聽器等代碼,簡單實用,可參考官網鏈接:http://jakewharton.github.io/butterknife/html

但願你們多多交流學習,讓安卓開發更加方便java

注意 :目前butterknife的版本已經升級,新版本的使用方式和舊版本有所區別,請你們看好本身所使用的butterknife版本吧android

簡介:git

使用 @Bind註解並傳入一個View ID,Butter Knife 就能夠找到而且自動地對你的佈局中的View進行轉換並綁定到類成員上。github

classExampleActivityextendsActivity {@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);
    // TODO Use fields...
  }
}

相比與緩慢的反射機制,Butter Knife的代碼是生成的,所以沒必要擔憂註解的性能問題。調用bind來生成這些代碼,你能夠查看或調試這些代碼。編程

資源綁定

綁定資源到類成員上可使用@BindBool@BindColor@BindDimen@BindDrawable@BindInt@BindString。使用時對應的註解須要傳入對應的id資源,例如@BindString你須要傳入R.string.id_string的字符串的資源id。數組

classExampleActivityextendsActivity {@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中使用綁定

Butter Knife提供了bind的幾個重載,只要傳入根佈局,即可以在任何對象中使用註解綁定。app

 

public classFancyFragmentextendsFragment {@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;
  }
}
在ListView的Adapter中,咱們經常會使用ViewHolder:
static classViewHolder {@Bind(R.id.title) TextView name;
    @Bind(R.id.job_title) TextView jobTitle;

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

 

提供的其餘綁定API:框架

  • 使用Activity在任意對象中進行綁定。若是你使用了相似MVC的編程模式,你可使用ButterKnife.bind(this, activity)在Controller中進行綁定ide

  • 使用ButterKnife.bind(this)綁定一個佈局的子佈局到變量上。若是你在佈局中使用了<merge>標籤而且在自定義的控件構造時inflate這個佈局,你能夠在inflate以後當即調用它。或者,你能夠在onFinishInflate()回調中使用它。


 

View 列表

你能夠一次性將多個views綁定到一個List或數組中:

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

使用這種綁定時,你可使用apple函數。該函數至關於將在這個列表中每個元素上進行調用:

ButterKnife.apply(nameViews, DISABLE);
ButterKnife.apply(nameViews, ENABLED, false);

ActionSetter接口可以讓你指定一些簡單的動做:

staticfinal ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
  @Overridepublicvoidapply(View view, int index){
    view.setEnabled(false);
  }
};
staticfinal ButterKnife.Setter<View, Boolean> ENABLED = new ButterKnife.Setter<View, Boolean>() {
  @Overridepublicvoidset(View view, Boolean value, int index){
    view.setEnabled(value);
  }
};

Android的Property也可使用到apple方法中:

ButterKnife.apply(nameViews, View.ALPHA, 0.0f);

監聽器綁定

在Butter Knife中,監聽器也自動地配置到方法上:

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

監聽器全部的參數都是可選的:

@OnClick(R.id.submit)
publicvoidsubmit(){
  // TODO submit data to server...
}

定義一個其餘的類型,Butter Knife也能識別:

@OnClick(R.id.submit)
publicvoidsayHi(Button button){
  button.setText("Hello!");
}

同時指定多個id的控件到同一個事件監聽上:

@OnClick({ R.id.door1, R.id.door2, R.id.door3 })
publicvoidpickDoor(DoorView door){
  if (door.hasPrizeBehind()) {
    Toast.makeText(this, "You win!", LENGTH_SHORT).show();
  } else {
    Toast.makeText(this, "Try again", LENGTH_SHORT).show();
  }
}

自定義View綁定事件監聽時無需ID:

public classFancyButtonextendsButton {@OnClick
  public void onClick() {
    // TODO do something!
  }
}

Fragment綁定注意:

Fragment的生命週期與Activity不一樣。在Fragment中,咱們可能會在onCreateView中綁定一個佈局,並在onDestroyView中設置全部view爲null.此時,你就須要Butter Knife提供的undind函數來作此事。

public classFancyFragmentextendsFragment {@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;
  }

  @Override public void onDestroyView() {
    super.onDestroyView();
    ButterKnife.unbind(this);
  }
}

對於包含多個方法的監聽器

當一個監聽器包含多個回調函數時,使用方法注入可以對其中任何一個函數進行綁定。每個註解都會綁定到一個默認的回調。固然,你也能夠指定callback參數:

@OnItemSelected(R.id.list_view)
voidonItemSelected(int position){
  // TODO ...
}

@OnItemSelected(value = R.id.maybe_missing, callback = NOTHING_SELECTED)
voidonNothingSelected(){
  // TODO ...
}

簡單的findViewById

Butter Knife提供了一個findViewById的簡化代碼findById,用這個方法能夠在ViewActivityDialog中找到想要View,並且,該方法使用的泛型來對返回值進行轉換,也就是說,你能夠省去findViewById前面的強制轉換了。

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

使用

Butter Knife的代碼和例子均可以在GitHub上找到:Butter Knife GitHub

查看Butter Knife的API文檔如今也能夠查看:Butter Knife Javadoc

MAVEN

聲明如下依賴庫:

<dependency>
  <groupId>com.jakewharton</groupId>
  <artifactId>butterknife</artifactId>
  <version>(insert latest version)</version>
</dependency>

GRADLE

我在android studio 2.2中添加這個庫的時候也報了Error:Could not find com.android.support:support-annotations:24.1.0.這個錯誤,但願找到解決方法的同窗指出。

compile 'com.jakewharton:butterknife:(insert latest version)'

注意在build.gradle中取消lint的以下警告:

lintOptions {
  disable 'InvalidPackage'
}

你也有可能須要以下配置:

packagingOptions {
  exclude 'META-INF/services/javax.annotation.processing.Processor'
}

ProGuard

Butter Knife使用動態生成的代碼,這可能使ProGuard認爲這些代碼是無用的。爲了不這些代碼被混淆,你能夠添加以下代碼到你的ProGuard中:

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

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

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

 

詳情查看原文章:http://www.jianshu.com/p/9ad21e548b69

相關文章
相關標籤/搜索