【譯】butterknife中文官方使用文檔

英文原文鏈接:
http://jakewharton.github.io/butterknife/
中文譯文鏈接butterknife
http://blog.csdn.net/androidmsky/article/details/56282777

butterknife可以說是一個非常強大的視圖綁定庫,大大簡化代碼,並且不會因爲反射而影響APP性能,所以推薦大家使用,看了一下butterknife的官方文檔和例子寫的很好,所以特翻譯過來方便大家查閱,請多指教。

下面爲譯文:

介紹

使用@BindView這個註釋和一個view的ID來自動的匹配到佈局中的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...
  }
}

代替耗時的反射,通過產生代碼來實現view的查找,可以叫做委託綁定併產生可見且可調式的代碼。
上面的例子產生的代碼大致如下:

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

資源綁定

用@BindBool, @BindColor, @BindDimen, @BindDrawable,@BindInt, @BindString
綁定默認的資源。綁定自定義的類型需要屬性匹配。

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

沒有活動的 綁定

你也可以綁定隨意的對象,但是必須提供你的view根節點

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中簡化view holder的例子

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

你可以在提供的示例中看到它的實現

其他的綁定APIs

如果活動是視圖的根節點,如果你使用MVC的設計模式,你可以在控制器中使用ButterKnife.bind(this, activity).來完成綁定

用ButterKnife.bind(this)來綁定子視圖,如果你在佈局中使用了merge標籤在一個自定義的視圖裏你可以立刻使用,或者從xml中填充自定義視圖,可以在onFinishInflate()回調中使用。

視圖列表

你可以吧視圖放在一個數組或者列表裏

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

動作和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);
  }
};

一個安卓的屬性方法也可以一同使用。

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

監聽器綁定

監聽器也可以簡單自然的綁定在方法中

@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) {
  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!
  }
}

綁定重置

Fragment有和activity不一樣的生命週期,當綁定一個fragment的在onCreate,在銷燬時(onDestroyView)

設置視圖們變爲空,Butter Knife返回一個Unbinderinstance當你調用綁定方法,並在合適的地方調用解綁方法。

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可以能會拋異常。
要抑制此行爲並創建可選綁定,添加一個@Nullable註釋在字段前,或者 @Optional在方法前。
注意:任何註釋@Nullable可以被用在字段前,Android’s “support-annotations” library也是鼓勵這麼使用。

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

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



}

多元監聽

方法前的註釋可以有多元化的監聽回調,每個註釋可以默認回調它的綁定,具體制定一個參數(int position)

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

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

額外的優勢

也包含findById方法使代碼簡單,來找到視圖活動彈窗的views。它使用泛型來判斷類型並自動轉換。

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並且享受它們的快樂吧。

下載

GRADLE

compile 'com.jakewharton:butterknife:8.5.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1'

END

歡迎加作者自營安卓開發交流羣:

308372687
這裏寫圖片描述

我的Github
https://github.com/AndroidMsky

博主原創譯文歡迎轉載並註明作者和出處

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章