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();
    }
注意這裏方法仍然不能是privatestatic, 並且可以有一個參數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到什麼值.
 
 
具體的使用可以參見例子:
 
 

其他實用方法

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