ButterKnife使用詳解

注解庫, JakeWharton大神的杰作

Note:文章基于8.5.1版本,不同的版本之間用法可能會稍有差異,實際版本使用以官方文檔為主

項目地址:https://github.com/JakeWharton/butterknife
文檔地址:http://jakewharton.github.io/butterknife/

有什么用?

初始化View,資源,綁定View事件.不用去寫findViewById(...), setOn...Listener(...),只需要加上一行注解,配合Studio插件:Android ButterKnife Zelezny,自動生成View注解, 大愛

怎么用?

  • 引入ButterKnife
  • 添加/聲明對應(yīng)的注解

引入ButterKnife

在早期版本引入只需要一行代碼,后來庫的分拆,增加,優(yōu)化,使得稍顯麻煩.新手上手時,動不動會整出個空指針很正常.只需要注意區(qū)分項目的build.gradle,主程序的Module的build.gradle,依賴Module的Build.gradle:

  • 項目的build.gradle:在項目的根目錄下
  • 主程序的build.gradle:通常是一個名為app Module下的build.gradle,文件第一行是:apply plugin: 'com.android.application',這名代碼的意思是用來聲明這個Module是主程序Module
  • 依賴Module的build.gradle:一個項目通常只有一個主程序Module,其它的就是依賴Module,當(dāng)然,是可以建多個主程序Module的,文件第一行代碼是:apply plugin: 'com.android.library',用來聲明這是一個依賴Module

在Module的build.gradle中添加
如果你要在哪個Module中使用,就不需要在哪個Module中添加

dependencies {
  compile 'com.jakewharton:butterknife:8.5.1'
  annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1'
}

在項目的build.gradle中添加

buildscript {
  repositories {
     mavenCentral()
  }
  dependencies {
    classpath 'com.jakewharton:butterknife-gradle-plugin:8.5.1'
  }
}

在主程序依賴Module的build.gradle中添加

apply plugin: 'com.android.library'
apply plugin: 'com.jakewharton.butterknife'

Note:在依賴Module中使用,聲明注解時用R2替代R, Like this

class ExampleActivity extends Activity {
  @BindView(R2.id.user) EditText username;
  @BindView(R2.id.pass) EditText password;
  ...
}

添加/聲明對應(yīng)的注解

在Activity中綁定View

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

只要在TextView title;加了@BindView(R.id.title),這個title就和布局simple_activity.xm中的id為title的TextView控件綁定了,并且?guī)湍銓嵗?就可以直接用它的相關(guān)方法:title.setXxx(..)之類.相當(dāng)于幫你寫了,title = (TextView)this.findViewById(R.id.title);這段代碼,實際上在build項目的時候它就去生成了包含這樣代碼的文件,目錄:項目名->Module名->build->generated->source->apt->debug->對應(yīng)的包名下一些XXX$$ViewBinder的類,代碼大致如下:

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

資源文件綁定

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

在非Activity中呢

在Activity中使用的是:ButterKnife.bind(this);
有非Activity中則是使用:ButterKnife.bind(this, view);
Fragment中使用

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);
    // 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 {
    @BindView(R.id.title) TextView name;
    @BindView(R.id.job_title) TextView jobTitle;

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

你可以一次性將多個views綁定到一個List或數(shù)組中：

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

apply函數(shù)可以讓集合中的View執(zhí)行相同的操作:

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

實現(xiàn)ButterKnife.Action或ButterKnife.Setter接口,如果你在項目中有這樣的需求:

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函數(shù)還提供設(shè)置View屬性的方法:

ButterKnife.apply(nameViews, View.ALPHA, 0.0f);
支持的屬性大概如下:
  • ALPHA - 透明度
  • TRANSLATION_X - 平移(相對于自身控件)
  • TRANSLATION_Y
  • TRANSLATION_Z
  • X - 平移(相對于父控件)
  • Y
  • Z
  • ROTATION - 角度
  • ROTATION_X
  • ROTATION_Y
  • SCALE_X - 縮放
  • SCALE_Y

上面說的大多是基于View控件,資源的綁定,看下源代碼這個版本大概就下面這些:

  • BindArray
  • BindBitmap
  • BindBool
  • BindDimen
  • BindDrawable
  • BindInt
  • BindString
  • BindView
  • BindViews

基于事件的綁定

給一個id設(shè)置OnClick事件,不用寫xxx.setOnClickListener(...)了:

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

方法名是自己定義的,沒有過多要求,參數(shù)中的View也是可選的,可以加,可以不加:

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

還可以為回調(diào)中的View加上指定的類型,但不要亂來,本來是個Button,非要寫個TextView,Like this:

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

當(dāng)然,也可以為多個控件id設(shè)置為同一個回調(diào)方法:

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

在自定義View中使用,不需要指定id:

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

控件事件的綁定列表大致如下:

  • OnCheckedChanged
  • OnClick
  • OnEditorAction
  • OnFocusChange
  • OnItemClick
  • OnItemLongClick
  • OnItemSelected
  • OnLongClick
  • OnPageChange
  • OnTextChanged
  • OnTouch

解綁

上面的內(nèi)容一直在說綁定綁定綁定,ButterKnife.bind(this);是有返回值的,返回一個Unbinder對象,你需要在合適的生命周期里去解綁,調(diào)用它的unbind()函數(shù),比如,Activity中的onDestroy方法,Fragment的onDestroyView方法

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

可選的綁定

情況是這樣的:上面說的綁定View,綁定資源,綁定事件,如果綁定的目標(biāo)id沒有找到,這時候ButterKnife就會拋出異常,為了?抑制這種情況的發(fā)生,可以使用Android自帶注解庫中的@Nullable來添加到Field上,和ButterKnife中的@Optional添加到Method上

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

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

最后

Butter Knife提供了一個findViewById的簡化代碼:findById,用這個方法可以在View,Activity和Dialog中找到想要View,而且,該方法使用的泛型來對返回值進(jìn)行轉(zhuǎn)換,也就是說,你可以省去findViewById前面的強制轉(zhuǎn)換了.強迫癥的福因:

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);
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 179,029評論 25贊 709
  • 寫在前面：該文檔使用7.0版本，8.0版本方法名有所改動，建議看官方文檔，整體業(yè)務(wù)邏輯和原理沒什么變動，官網(wǎng) 在A...
    RunningTeemo閱讀 711評論 0贊 0
  • 版權(quán)聲明 原創(chuàng)作者：谷哥的小弟博客地址：http://blog.csdn.net/lfdfhl 參考資料 http...
    谷哥的小弟閱讀 492評論 0贊 0
  • 美麗人生
    靜游f閱讀 177評論 1贊 0
  • 我們生活在喧囂嘈雜的社會，每天睜開眼睛可能沒有期待的鳥語花香，鬧鐘聲嘶力竭的叫著提醒我們開始新的一天。吃飯上班工作...
    artemis_5e76閱讀 265評論 0贊 1

友情鏈接更多精彩內(nèi)容