一、概述
butterknife是一款as的功能強大插件。有了它，你幾乎可以和findViewById說byebye了。
二、使用
github地址：https://github.com/avast/android-butterknife-zelezny
三、問題解決
Generate ButterKnife Injections 不出現的問題解決
1、下載后重啟須重啟as，方生效
2、打開Gradle App，添加 compile 'com.jakewharton:butterknife:7.0.1'依賴
3、請務必將鼠標光標懸停在R.layout.xxx處，點擊右鍵！請詳細參閱https://github.com/avast/android-butterknife-zelezny
ButterKnife基本使用
Butter Knife處理字段和方法綁定.
重要更新: 目前(2016.4.29), ButterKnife的最新版本是8.0.1.
以下原文是針對ButterKnife v6.1.0的, v8.0.1主要的不同在以下幾個關鍵詞:
@InjectView -> @BindView
@InjectViews -> @BindViews
ButterKnife.inject(this) -> ButterKnife.bind(this)
ButterKnife.reset(this) ->
private Unbinder unbinder;
unbinder = ButterKnife.bind(this, view);
@Override
public void onDestroyView() {
unbinder.unbind();
super.onDestroyView();
}
配置:
用gradle配置的時候加入:
compile 'com.jakewharton:butterknife:6.1.0'
注意是加在Module:
app的gradle文件中.
加上之后不用運行什么命令,直接Sync一下就可以在External Libraries里面看到butterknife.
功能1: 再也不用寫findViewById()啦.
以前的:
mTextView1 = (TextView) findViewById(R.id.butter_text_view_1);
現在可以這樣實現:
首先在變量聲明的時候加上注解:
@InjectView(R.id.butter_text_view_2) TextView mTextView2;
如果id找不到,會在編譯的時候報錯.
之后在設置好布局之后調用ButterKnife.inject():
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.demo_butter_knife);
//using butter knife
ButterKnife.inject(this);
}
之后View對象就可以直接使用了.
需要注意的是View變量聲明的時候不能為
private或者static.
除了Activity之外,你可以提供其他的View Root,來獲取對象(執行注入).
還可以用來簡化Adapter里面的ViewHolder:
ButterKnife in Fragment
在Fragment中也可以使用ButterKnife來獲取View:
public class SimpleFragment extends Fragment {
@InjectView(R.id.fragment_text_view)
TextView mTextView;
public SimpleFragment() {
}
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fragment_simple, container, false);
ButterKnife.inject(this, view);
mTextView.setText("TextView in Fragment are found!");
return view;
}
}
ButterKnife in Adapter ViewHolder
Adapter有一種常用的優化策略,就是使用ViewHolder來減少findViewById()的重復調用.
以前寫過相關的博文:
http://www.cnblogs.com/mengdd/p/3254323.html
用了ButterKnife之后, ViewHolder的使用可以變成這樣:
@Override
public View getView(int position, View convertView, ViewGroup parent) {
ViewHolder holder;
if (convertView == null) {
convertView = mInflater.inflate(R.layout.person_item_layout, null);
holder = new ViewHolder(convertView);
convertView.setTag(holder);
} else {
holder = (ViewHolder) convertView.getTag();
}
Person person = getItem(position);
if (null != person) {
holder.name.setText(person.getName());
holder.age.setText(String.valueOf(person.getAge()));
holder.location.setText(person.getLocation());
holder.work.setText(person.getWork());
}
return convertView;
}
static class ViewHolder {
@InjectView(R.id.person_name)
TextView name;
@InjectView(R.id.person_age)
TextView age;
@InjectView(R.id.person_location)
TextView location;
@InjectView(R.id.person_work)
TextView work;
public ViewHolder(View view) {
ButterKnife.inject(this, view);
}
}
可以看到ViewHolder類加了一個帶參數View的構造方法,用注解標記每個字段,再也不需要在
getView()方法里調用findViewById()方法了.
功能2: 再也不用寫setOnClickListener()啦.
比如之前的:
finishButton.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
finish();
}
});
現在可以寫成:
@OnClick(R.id.basic_finish_a_button)
void finishA(View view) {
finish();
}
注意這里方法仍然不能是
private和static, 並且可以有一個參數View,也可不寫.
所有listener的參數都是optional的,可以寫,也可以不寫.
並且寫的時候可以直接寫一個具體的子類,比如參數View可以寫成Button,這里的cast是自動完成的.
注意還是需要調用一下
ButterKnife.inject(this);
否則事件綁定不成功.
忘記調用ButterKnife.inject(this);對於findView來說會報錯,但是對於綁定事件來說不會報錯,只是沒有事情發生.
除了點擊事件@OnClick,還有ListView的點擊
@OnItemClick, CheckBox的@OnCheckedChanged等等.
可以一次指定多個id,為多個View綁定一個事件處理方法,比如:
//you can bind listener to multiple views
@OnClick({R.id.button_enable, R.id.button_disable, R.id.button_alpha_0, R.id.button_alpha_1})
void editViewsClicked() {
Toast.makeText(this, "You click the Button!", Toast.LENGTH_SHORT).show();
}
功能3: 組建View List: 把多個View放在一起用
可以同時獲取多個View,放在一個List中:
@InjectViews({R.id.label_first_name, R.id.label_middle_name, R.id.label_last_name})
List<TextView> labelViews;
@InjectViews({R.id.first_name, R.id.middle_name, R.id.last_name})
List<EditText> nameViews;
注意id用逗號分隔,大括號包圍,外面才是小括號.
apply()方法允許你為一組對象批量地設置值.
apply()方法共有3種形式:
public static <T extends View> void apply(List<T> list, Action<? super T> action) public static <T extends View, V> void apply(List<T> list, Setter<? super T, V> setter, V value) public static <T extends View, V> void apply(List<T> list, Property<? super T, V> setter, V value)
即Action, Setter和Property三種.
其中Action和Setter都是ButterKnife的類,需要繼承,寫自己的子類實現,然后傳入對象.
Setter的第三個參數可以指定要set到什么值.
Property是Android中的類:
https://developer.android.com/reference/android/util/Property.html
具體的使用可以參見例子:
其他實用方法
1.注入重置(Injection Rest):
可以用
reset()方法將ButterKnife注入的View引用設置為null.
比如在Fragment的onCreateView()里調用ButterKnife.inject()方法注入了一些View,在
onDestroyView()里想把它們置為null,可以直接調用ButterKnife.reset(this);方法.
2.選擇性注入(Optional Injection):
默認情況下,@InjectView和listener的注入都是必須的,如果target view沒有被發現,則會報錯.
為了抑制這種行為,可以用
@Optional注解來標記field和方法,讓注入變成選擇性的,如果targetView存在,則注入, 不存在,則什么事情都不做.
當布局被復用時,這個@Optional注解很有用.
3.多方法的listener(Multi-method Listeners):
有一些View的listener是有多個回調方法的,比如Spinner的onItemSelectedListener:
mSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() {
@Override
public void onItemSelected(AdapterView<?> parent, View view, int position, long id) {
}
@Override
public void onNothingSelected(AdapterView<?> parent) {
}
});
方法注解可以用來綁定到這些方法中的任何一個.
每一個注解有一個默認的callback,指定它綁定到什么方法上;可以通過callback參數指定為一個特定的方法.
比如:
沒有指定callback,默認對應onItemSelected()方法:
@OnItemSelected(R.id.my_spinner)
//default callback : ITEM_SELECTED
void onItemSelected(int position) {
Toast.makeText(this, "position: " + position, Toast.LENGTH_SHORT).show();
}
指定了callback,對應onNothingSelected()方法:
@OnItemSelected(value = R.id.my_spinner, callback = OnItemSelected.Callback.NOTHING_SELECTED)
void onNothingSelected() {
Toast.makeText(this, "Nothing", Toast.LENGTH_SHORT).show();
}
注意的是Spinner中只要有數據,默認都會選中第0個數據,所以想進入到onNothingSelected()方法,就需要把Adapter中的數據都清空.
具體完整例子見:
4.findById()方法
ButterKnife.findById()可以用來獲取Activity,Dialog或View中的任何View.
ButterKnife自動完成了類型轉換,所以獲取出來以后不用進行顯式強轉,直接賦值給具體的View類型引用即可.
Resources:
Sample Project:
Introduction:
http://jakewharton.github.io/butterknife/