Android中ButterKnife的使用

Android中ButterKnife的使用

官方網(wǎng)站

1 簡介

ButterKnife意為“黃油刀”，意思是此開源庫可以讓你的應(yīng)用開發(fā)過程像用刀切黃油一樣干凈利落。此庫的核心功能是通過注解來實現(xiàn)視圖的注入，從而在代碼中避免冗余的方法調(diào)用和丑陋的內(nèi)部類監(jiān)聽器。
簡單的理解“綁定”的概念，就是講View和任意一個對象相互關(guān)聯(lián)，從而在該對象中，不用findViewById就能使用View上的所有子視圖，不用setOnClickListener就能給控件設(shè)置監(jiān)聽。

2 注解

注解(Annotation)是JDK 1.5之后引入的特性，它是一種元數(shù)據(jù)(meta-data)，即描述數(shù)據(jù)的數(shù)據(jù)。元數(shù)據(jù)這個概念比較難理解，簡單的理解，就是對代碼的標注，告訴編譯器某一段代碼需要做怎樣的處理。
其實我們早就見過注解，在方法重寫時，@Override就是一個注解，去掉@Override，代碼一樣可以運行，增加這個注解的好處，一是增加代碼可讀性，二是編譯器能幫你做一些自動檢查，增加代碼健壯性。
Android引入了兩個非常有用的注解，@Nullable和@NonNull，用來標識方法參數(shù)或者方法返回值等是否可以為null。以前編程時，為了避免NullPointerException，最終代碼中往往到處都是if(Obj == null){...}這樣的代碼，這是很糟糕的編碼方式，有了這兩個注解，代碼就清晰多了。
另外Android中注解的一個重要應(yīng)用是代替枚舉類型，這方面可以參考在Toast中的使用。

3 導(dǎo)入項目

在Android Studio中使用，只需添加依賴：

compile 'com.jakewharton:butterknife:7.0.1'

另外最好在build.gradle中關(guān)閉一項lint警告：

lintOptions {
  disable 'InvalidPackage'
}

4 使用說明

ButterKnife通過@Bind注解和視圖Id幫你做兩件事：找到視圖和將視圖轉(zhuǎn)型為對應(yīng)的子類型。例如以下的代碼：

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

ButterKnife不是通過反射，而是通過自動生成代碼來執(zhí)行View的查找，上面的例子中，ButterKnife最終自動生成的代碼大概是這樣的：

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

4.1 資源綁定

ButterKnife預(yù)定義了注解@BindBool, @BindColor, @BindDimen, @BindDrawable, @BindInt, @BindString，用來執(zhí)行資源的綁定。如下所示：

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

4.2 非Activity綁定

除了Activity，你也可以將任意的對象與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;
  }
}

或在適配器中：

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

任何原來需要使用findViewById的地方都可以用ButterKnife.bind替代。
用于綁定的API：
如果使用了MVC模式，將控制器的Activity和視圖綁定，可以用ButterKnife.bind(this, activity)。
將自定義視圖綁定到自身，可以用ButterKnife.bind(this)。

4.3 綁定視圖列表

可以將多個視圖放在List或數(shù)組中。
@Bind({ R.id.first_name, R.id.middle_name, R.id.last_name })
List<EditText> nameViews;
apply方法讓你可以同時操作列表中的所有視圖：

ButterKnife.apply(nameViews, DISABLE);
ButterKnife.apply(nameViews, ENABLED, false);
Action和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è)置View的屬性：

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

4.4 監(jiān)聽接口的綁定

監(jiān)聽器可以自動在方法上配置，如下：

@OnClick(R.id.submit)
public void submit(View view) {
  // TODO submit data to server...
}
監(jiān)聽器方法的參數(shù)是可選的：
@OnClick(R.id.submit)
public void submit() {
  // TODO submit data to server...
}
監(jiān)聽器方法的參數(shù)可以是具體的類型，它會被自動轉(zhuǎn)型：
@OnClick(R.id.submit)
public void sayHi(Button button) {
  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();
  }
}
自定義視圖自己的監(jiān)聽器可以省去ID：
public class FancyButton extends Button {
  @OnClick
  public void onClick() {
    // TODO do something!
  }
}

4.5 綁定的重置

Fragment生命周期和Activity不同，當在onCreateView中綁定視圖后，要在onDestroyView中將這些視圖置為null，ButterKnife提供了Unbinder接口來自動做這件事，如下：

public class FancyFragment extends Fragment {
  @Bind(R.id.button1) Button button1;
  @Bind(R.id.button2) Button button2;
  @Unbinder ButterKnife.Unbinder unbinder;

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

4.6 可選綁定

在默認情況下，如果ID對應(yīng)的視圖沒有找到，會拋異常。要使用可選綁定，添加@Nullable或@Optional注解即可：

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

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

4.7 多方法監(jiān)聽器

如果注解對應(yīng)的監(jiān)聽器有多個回掉方法，可以綁定任意一個方法。每種注解都有默認的回掉方法，可以通過callback參數(shù)指定為其它的回掉方法：

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

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

4.8 其它

對于無法直接綁定視圖的常見，ButterKnife提供了findById方法簡化操作，它通過泛型操作將返回值自動轉(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ù)。

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