android ButterKnife 解決重復findViewById

簡介：

程序員都是懶惰的，不想寫一大堆像下面這樣的代碼

class ExampleActivity extends Activity {
TextView title;
TextView subtitle;
TextView footer;

@Override public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.simple_activity);
title = (TextView) findViewById(R.id.title);
subtitle = (TextView) findViewById(R.id.subtitle);
footer = (TextView) findViewById(R.id.footer);

// TODO Use views...
}
}

　　

　　

這樣很不好，因此我們就找到了一個方法，使用魔法一般的注解，來濃縮代碼，就像下面這樣

class ExampleActivity extends Activity {
@Magic(R.id.title) TextView title;
@Magic(R.id.subtitle) TextView subtitle;
@Magic(R.id.footer) TextView footer;

@Override public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.simple_activity);
// TODO Use "injected" views...
}
}
　　

　　

 

然而，這樣雖然看起來很酷，很Magic，不過還是會帶來嚴重的運行時的問題

於是，我們就利用javac 編譯器中一大利器來生成前面例子中的findViewById的引用，並且繼續保持代碼的精簡 ，繼續看下面的代碼

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

　　

在原本Magic的地方使用inject 方法來替代，下面是該方法的一段代表（This method delegates to generated code 不明），可以看並debug

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

　　

 

（這段可以忽略嗎？貌似翻譯不對，看不太懂）有些人稱這個為視圖注入，並加到了傳統的依賴注入框架中，也許在術語上有錯誤，不過或許有一點作用.......

 

NON-ACTIVITY INJECTION

我們可以對任意的View對象使用注入，當然了，需要提供view root的對象

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

　　

另外一個用處是簡化list adapter中的View Holder模式，這個例子可以在提供的sample中看到

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

static class ViewHolder {
@InjectView(R.id.title) TextView name;
@InjectView(R.id.job_title) TextView jobTitle;

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

　　

　　

其他的API（這段真心建議看一下原版）

-當使用activity作為view root節點時，你如果使用的是像MVC設計模式，你可以將控制器注入，使用它的acitvity並通過ButterKnife.inject(this, activity)方法 -將一個子View對象字段注入，使用ButterKnife.inject(this)（在前面例子的onCreate方法中就是，不懂的可以參考這個），如果你在一個layout 的構造方法中使用<merge>標簽並且，inflate了一個自定義View，立即調用這個方法。或者，如果是從xml中inflate自定義view， 可以使用這個方法---onLayoutInflated()

CLICK LISTENER INJECTION

 

Click listener 也可以被注入

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

　　

也可以加一個view對象，特定的類型會被自動轉換

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

　　

INJECTION RESET

Fragments 有比Avtivity更多的生命周期 ，如果需要在onCreateView中注入一個fragment，在onDestroyView中銷毀它

Butter Knife 有一個reset 方法自動實現它

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

　　

OPTIONAL INJECTIONS

默認情況下 @InjectView和@OnClick都是必須加上的，如果當前對象不存在，就會拋出一個異常

為了壓制這個異常，可以在變量或者方法上加入一下注解

@Optional @InjectView(R.id.might_not_be_there) TextView mightNotBeThere;

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

　　

 

這段看不太懂，大意估計是除了以上注入方法之外還有一種，類型會自動轉換，需要靜態導入ButterKnife.findById

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

　　

　　

 

Download：當前版本 4.0.1

 

具體：http://github.com/JakeWharton/butterknife

jar包：http://repo1.maven.org/maven2/com/jakewharton/butterknife/4.0.1/butterknife-4.0.1.jar

 

Maven配置：如果你是用maven開發的童鞋，請自覺加上如下依賴

<dependency>
<groupId>com.jakewharton</groupId>
<artifactId>butterknife</artifactId>
<version>4.0.1</version>
</dependency>

 

IDE的配置

 

IntelliJ IDEA — 如果你是用外部工具管理工程 (如 Maven pom.xml) 應該能正常工作, 不然就看看這個 http://jakewharton.github.io/butterknife/ide-idea.html
Eclipse — http://jakewharton.github.io/butterknife/ide-eclipse.html

PROGUARD

使用注入會導致ProGuard 認為變量未被使用，因此，需要在ProGuard 中加入如下字段

-dontwarn butterknife.internal.**
-keep class **$$ViewInjector { *; }
-keepnames class * { @butterknife.InjectView *;}
　　

轉 http://www.it165.net/pro/html/201404/12375.html