標籤：註解 butterknife 視圖注入 injectview optional
介紹
ButterKnife通過@InjectView和視圖的ID註解的變數去找到並自動轉換為你布局上相應的布局視圖。
class ExampleActivity extends Activity {
@InjectView(R.id.title) TextView title;
@InjectView(R.id.subtitle) TextView subtitle;
@InjectView(R.id.footer) TextView footer;
@Override public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.simple_activity);
ButterKnife.inject(this);
// TODO Use "injected" views...
}
}
與緩慢的反射機制不同的是，產生的代碼是用來執行視圖的查表（查詢檢視表）操作。調用Inject方法產生的程式碼可以查看且調試。上面例子中的代碼可以粗略等同於下面：
public void inject(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);
}
非activity注入
你也可以提供自己的根視圖對任意對象執行注入：
public class FancyFragment extends Fragment {
@InjectView(R.id.button1) Button button1;
@InjectView(R.id.button2) Button button2;
@Override View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fancy_fragment, container, false);
ButterKnife.inject(this, view);
// TODO Use "injected" views...
return view;
}
}
另外一個用法是，在列表適配器中簡化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 {
@InjectView(R.id.title) TextView name;
@InjectView(R.id.job_title) TextView jobTitle;
public ViewHolder(View view) {
ButterKnife.inject(this, view);
}
}
}
你可以在上面例子中查看其行為的實現。你可以在任意可以使用findViewById的地方使用ButterKnife.inject。
其他提供的注入API：
可以使用activity作為根視圖對任意對象進行注入。如果你使用了類似MVC的架構，你可以通過在控制器（C）的activity使用ButterKnife.inject(this, activity)對其進行注入。
可以使用ButterKnife.inject(this)對子視圖進行注入。如果你在布局中使用<merge>標籤而且載入了自訂控制項，可以在後面立即調用它。或者通過xml載入的自訂視圖，可以在onFinishInflate()回調中使用它。
視圖列
你可以把多個視圖集中到列表或者數組中。
@InjectViews({ 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 Action<View> DISABLE = new Action<>() {
@Override public void apply(View view, int index) {
view.setEnabled(false);
}
}
static final Setter<View, Boolean> ENABLED = new Setter<>() {
@Override public void set(View view, Boolean value, int index) {
view.setEnabled(value);
}
}
Android的內建屬性也可以用apply方法。
ButterKnife.apply(nameViews, View.ALPHA, 0);
點擊監聽注入
點擊監聽也可以自動化佈建到方法。
@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();
}
}
注入重設
fragment比起activity有更加不同的聲明周期，當在fragment的onCreateView裡注入時，應該在onDestroyView裡設定視圖為空白。ButterKnife有一個重設方法可以自動做這個操作。
public class FancyFragment extends Fragment {
@InjectView(R.id.button1) Button button1;
@InjectView(R.id.button2) Button button2;
@Override View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fancy_fragment, container, false);
ButterKnife.inject(this, view);
// TODO Use "injected" views...
return view;
}
@Override void onDestroyView() {
super.onDestroyView();
ButterKnife.reset(this);
}
}
可選注入
預設情況下，@InjectView和@OnClick是必須的（此處的必須應該是對應後面一句話而言的）。如果目標視圖未找到會拋異常。為了禁止這種行為的出現並建立一個可選的注入，添加@Optional註解到值或方法上。
@Optional @InjectView(R.id.might_not_be_there) TextView mightNotBeThere;
@Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {
// TODO ...
}
多回調監聽
有多個回調的相應監聽的註解可以被用來綁定它們中的任意一個。每個註解都有其對應的預設回調。指定任意一個使用callback參數。
@OnItemSelected(R.id.list_view)
void onItemSelected(int position) {
// TODO ...
}
@OnItemSelected(value = R.id.maybe_missing, callback = NOTHING_SELECTED)
void onNothingSelected() {
// TODO ...
}
額外獎勵
包含的兩個簡化代碼的findById方法仍需要在view或activity查詢檢視表。它使用generics推斷傳回型別並自動執行轉換。
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添加靜態引入會更加有趣。介紹
ButterKnife通過@InjectView和視圖的ID註解的變數去找到並自動轉換為你布局上相應的布局視圖。
class ExampleActivity extends Activity {
@InjectView(R.id.title) TextView title;
@InjectView(R.id.subtitle) TextView subtitle;
@InjectView(R.id.footer) TextView footer;
@Override public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.simple_activity);
ButterKnife.inject(this);
// TODO Use "injected" views...
}
}
與緩慢的反射機制不同的是，產生的代碼是用來執行視圖的查表（查詢檢視表）操作。調用Inject方法產生的程式碼可以查看且調試。上面例子中的代碼可以粗略等同於下面：
public void inject(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);
}
非activity注入
你也可以提供自己的根視圖對任意對象執行注入：
public class FancyFragment extends Fragment {
@InjectView(R.id.button1) Button button1;
@InjectView(R.id.button2) Button button2;
@Override View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fancy_fragment, container, false);
ButterKnife.inject(this, view);
// TODO Use "injected" views...
return view;
}
}
另外一個用法是，在列表適配器中簡化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 {
@InjectView(R.id.title) TextView name;
@InjectView(R.id.job_title) TextView jobTitle;
public ViewHolder(View view) {
ButterKnife.inject(this, view);
}
}
}
你可以在上面例子中查看其行為的實現。你可以在任意可以使用findViewById的地方使用ButterKnife.inject。
其他提供的注入API：
可以使用activity作為根視圖對任意對象進行注入。如果你使用了類似MVC的架構，你可以通過在控制器（C）的activity使用ButterKnife.inject(this, activity)對其進行注入。
可以使用ButterKnife.inject(this)對子視圖進行注入。如果你在布局中使用<merge>標籤而且載入了自訂控制項，可以在後面立即調用它。或者通過xml載入的自訂視圖，可以在onFinishInflate()回調中使用它。
視圖列
你可以把多個視圖集中到列表或者數組中。
@InjectViews({ 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 Action<View> DISABLE = new Action<>() {
@Override public void apply(View view, int index) {
view.setEnabled(false);
}
}
static final Setter<View, Boolean> ENABLED = new Setter<>() {
@Override public void set(View view, Boolean value, int index) {
view.setEnabled(value);
}
}
Android的內建屬性也可以用apply方法。
ButterKnife.apply(nameViews, View.ALPHA, 0);
點擊監聽注入
點擊監聽也可以自動化佈建到方法。
@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();
}
}
注入重設
fragment比起activity有更加不同的聲明周期，當在fragment的onCreateView裡注入時，應該在onDestroyView裡設定視圖為空白。ButterKnife有一個重設方法可以自動做這個操作。
public class FancyFragment extends Fragment {
@InjectView(R.id.button1) Button button1;
@InjectView(R.id.button2) Button button2;
@Override View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fancy_fragment, container, false);
ButterKnife.inject(this, view);
// TODO Use "injected" views...
return view;
}
@Override void onDestroyView() {
super.onDestroyView();
ButterKnife.reset(this);
}
}
可選注入
預設情況下，@InjectView和@OnClick是必須的（此處的必須應該是對應後面一句話而言的）。如果目標視圖未找到會拋異常。為了禁止這種行為的出現並建立一個可選的注入，添加@Optional註解到值或方法上。
@Optional @InjectView(R.id.might_not_be_there) TextView mightNotBeThere;
@Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {
// TODO ...
}
多回調監聽
有多個回調的相應監聽的註解可以被用來綁定它們中的任意一個。每個註解都有其對應的預設回調。指定任意一個使用callback參數。
@OnItemSelected(R.id.list_view)
void onItemSelected(int position) {
// TODO ...
}
@OnItemSelected(value = R.id.maybe_missing, callback = NOTHING_SELECTED)
void onNothingSelected() {
// TODO ...
}
額外獎勵
包含的兩個簡化代碼的findById方法仍需要在view或activity查詢檢視表。它使用generics推斷傳回型別並自動執行轉換。
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添加靜態引入會更加有趣。
Android視圖注入庫:butterknife
