GitHub項目源碼 https://github.com/JakeWharton/butterknife
官網 http://jakewharton.github.io/butterknife/
ButterKnife 簡介
ButterKnife是一個專注于Android系統的View注入框架,可以減少大量的findViewById以及setOnClickListener代碼,可視化一鍵生成。
ButterKnife 優勢
1、強大的View綁定和Click事件處理功能,簡化代碼,提升開發效率
2、方便的處理Adapter里的ViewHolder綁定問題
3、運行時不會影響APP效率,使用配置方便
4、代碼清晰,可讀性強
使用心得:
1.Activity ButterKnife.bind(this);必須在setContentView();之后,且父類bind綁定后,子類不需要再bind
2.Fragment ButterKnife.bind(this, mRootView);
3.屬性布局不能用private or static 修飾,否則會報錯
4.setContentView()不能通過注解實現。(其他的有些注解框架可以)
如何添加依賴
1)在項目的project 的build.gredle 文件中的dependencies標簽下添加。(添加插件)
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'com.jakewharton:butterknife-gradle-plugin:8.5.1'
}
}
2)在module的build.gredle 文件中添加(官方是這么寫的,目前貌似沒有用到)
apply plugin: 'com.android.library'
apply plugin: 'com.jakewharton.butterknife'
3)在module的build.gredle 文件中的dependencies標簽中添加(導入庫的依賴)
dependencies {
compile 'com.jakewharton:butterknife:8.5.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1'
}
不過使用時,只要加1)3)dependencies就可以使用了,2)可以不用添加
如何使用
常見使用方法:
1)由于每次都要在Activity中的onCreate綁定Activity,所以個人建議寫一個BaseActivity完成綁定,子類繼承即可
注:ButterKnife.bind(this);綁定Activity 必須在setContentView之后:
實現如下(FragmentActivity 實現一樣):
public abstract class BaseActivity extends Activity {
public abstract int getContentViewId();
Unbinder bind;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(getContentViewId());
bin ButterKnife.bind(this);
initAllMembersView(savedInstanceState);
}
protected abstract void initAllMembersView(Bundle savedInstanceState);
@Override
protected void onDestroy() {
super.onDestroy();
ButterKnife.unbind(this);//解除綁定,官方文檔只對fragment做了解綁
}
}
2)綁定fragment
import android.os.Bundle;
import android.support.v4.app.Fragment;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.Button;
import butterknife.BindView;
import butterknife.ButterKnife;
public class ButterknifeFragment extends Fragment {
@BindView( R.id.button1 )
public Button button1 ;
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fragment_butterknife, container, false);
//綁定fragment
ButterKnife.bind( this , view ) ;
button1.setText( "I am a button ");
return view ;
}
}
3)綁定view
- 控件id 注解: @BindView()
@BindView( R.id.button1 )
public Button button1 ;
// 注意:button 的修飾類型不能是:private 或者 static 。 否則會報錯:錯誤: @BindView fields must not be private or static. (com.zyj.wifi.ButterknifeActivity.button1)
- 多個控件id 注解: @BindViews()
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.widget.Button;
import java.util.List;
import butterknife.BindViews;
import butterknife.ButterKnife;
public class Main2Activity extends AppCompatActivity {
@BindViews({ R.id.button1 , R.id.button2 , R.id.button3 })
public List<Button> buttonList ;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main2);
ButterKnife.bind(this);
buttonList.get( 0 ).setText( "hello 1 ");
buttonList.get( 1 ).setText( "hello 2 ");
buttonList.get( 2 ).setText( "hello 3 ");
}
}
4)綁定資源
- @BindString() :綁定string 字符串
package com.zyj.wifi;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.Button;
import butterknife.BindString;
import butterknife.BindView;
import butterknife.ButterKnife;
public class ButterknifeActivity extends AppCompatActivity {
@BindView( R.id.button1 ) //綁定button 控件
public Button button1 ;
@BindString( R.string.app_name ) //綁定string 字符串
String meg;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_butterknife);
//綁定activity
ButterKnife.bind( this ) ;
button1.setText( meg );
}
}
- @BindArray() : 綁定string里面array數組
<resources>
<string name="app_name">WiFi管家</string>
<string-array name="city">
<item>廈門市</item>
<item>福州市</item>
<item>泉州市</item>
<item>漳州市</item>
<item>龍巖市</item>
</string-array>
</resources>
package com.zyj.wifi;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.Button;
import butterknife.BindArray;
import butterknife.BindView;
import butterknife.ButterKnife;
public class ButterknifeActivity extends AppCompatActivity {
@BindView( R.id.button1 ) //綁定button 控件
public Button button1 ;
@BindArray(R.array.city ) //綁定string里面array數組
String [] citys ;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_butterknife);
//綁定activity
ButterKnife.bind( this ) ;
button1.setText( citys[0] );
}
}
- @BindBitmap( ) : 綁定Bitmap 資源
import android.graphics.Bitmap;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.ImageView;
import butterknife.BindBitmap;
import butterknife.BindView;
import butterknife.ButterKnife;
public class ButterknifeActivity extends AppCompatActivity {
@BindView( R.id.imageView ) //綁定ImageView 控件
public ImageView imageView ;
@BindBitmap( R.mipmap.wifi ) //綁定Bitmap 資源
public Bitmap wifi_bitmap ;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_butterknife);
//綁定activity
ButterKnife.bind( this ) ;
imageView.setImageBitmap( wifi_bitmap );
}
}
- @BindColor( ) : 綁定一個顏色值
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.Button;
import butterknife.BindColor;
import butterknife.BindView;
import butterknife.ButterKnife;
public class ButterknifeActivity extends AppCompatActivity {
@BindView( R.id.button1 ) //綁定一個控件
public Button button1 ;
@BindColor( R.color.colorAccent ) int black ; //綁定一個顏色值
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_butterknife);
//綁定activity
ButterKnife.bind( this ) ;
button1.setTextColor( black );
}
}
5)Adapter ViewHolder 綁定
把ViewHolder加一個構造方法,在new ViewHolder的時候把view傳遞進去
static class ViewHolder {
@BindView(R.id.tv_item_test)
TextView tvItemTest;
@BindView(R.id.bt_item_test)
Button btItemTest;
public ViewHolder(View view) {
ButterKnife.bind(this, view);
}
}
item里面Button控件的點擊事件也可以使用注解@OnClick來實現,在適配器里面添加就行,如:
//item的button的點擊事件
@OnClick(R.id.bt_item_test)
void onClick(){
Toast.makeText(context,"點擊了按鈕",Toast.LENGTH_SHORT).show();
}
static class ViewHolder {
@BindView(R.id.tv_item_test)
TextView tvItemTest;
@BindView(R.id.bt_item_test)
Button btItemTest;
public ViewHolder(View view) {
ButterKnife.bind(this, view);
}
}
總體就是:
public class TestAdapter extends BaseAdapter {
private List<String> list;
private Context context;
public TestAdapter(Context context, List<String> list) {
this.list = list;
this.context = context;
}
@Override
public int getCount() {
return list==null ? 0 : list.size();
}
@Override
public Object getItem(int position) {
return list.get(position);
}
@Override
public long getItemId(int position) {
return position;
}
@Override
public View getView(int position, View convertView, ViewGroup parent) {
ViewHolder holder;
if (convertView == null) {
convertView = LayoutInflater.from(context).inflate(R.layout.layout_list_item, null);
holder = new ViewHolder(convertView);
convertView.setTag(holder);
} else {
holder = (ViewHolder) convertView.getTag();
}
holder.textview.setText("item=====" + position);
return convertView;
}
static class ViewHolder {
@BindView(R.id.hello_world)
TextView textview;
public ViewHolder(View view) {
ButterKnife.bind(this, view);
}
}
}
6)點擊事件的綁定:不用聲明view,不用setOnClickLisener()就可以綁定點擊事件
@OnClick( ) : 綁定控件點擊事件
@OnLongClick( ) : 綁定控件長按事件
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.Toast;
import butterknife.ButterKnife;
import butterknife.OnClick;
import butterknife.OnLongClick;
public class ButterknifeActivity extends AppCompatActivity {
@OnClick(R.id.button1 ) //給 button1 設置一個點擊事件
public void showToast(){
Toast.makeText(this, "is a click", Toast.LENGTH_SHORT).show();
}
@OnLongClick( R.id.button1 ) //給 button1 設置一個長按事件
public boolean showToast2(){
Toast.makeText(this, "is a long click", Toast.LENGTH_SHORT).show();
return true ;
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_butterknife);
//綁定activity
ButterKnife.bind( this ) ;
}
}
總結:
事件注解
一共有12個
名稱 作用
- @OnClick 點擊事件
- @OnCheckedChanged 選中,取消選中
- @OnEditorAction 軟鍵盤的功能鍵
- @OnFocusChange 焦點改變
- @OnItemClick item被點擊(注意這里有坑,如果item里面有Button等這些有點擊的控件事件的,需要設置這些控件屬性focusable為false)
- @OnItemLongClick item長按(返回真可以攔截onItemClick)
- @OnItemSelected item被選擇事件
- @OnLongClick 長按事件
- @OnPageChange 頁面改變事件
- @OnTextChanged EditText里面的文本變化事件
- @OnTouch 觸摸事件
- @Optional 選擇性注入,如果當前對象不存在,就會拋出一個異常,為了壓制這個異常,可以在變量或者方法上加入一下注解,讓注入變成選擇性的,如果目標View存在,則注入, 不存在,則什么事情都不做=如下代碼
@Optional
@OnCheckedChanged(R.id.cb_test)
public void onCheckedChanged(CompoundButton buttonView,boolean isChecked){
if(isChecked){
tvTest.setText("被選中了...");
}else{
tvTest.setText("被取消了...");
}
}
綁定注解
有11種
名稱 解析
- @BindViews 綁定多個view id為一個view的list變量
- @BindView 綁定一個view id為一個view 變量
- @BindArray 綁定string里面array數組,@BindArray(R.array.city ) String[] citys ;
- @BindBitmap 綁定圖片資源為Bitmap,@BindBitmap( R.mipmap.wifi ) Bitmap bitmap;
- @BindBool 綁定真假boolean
- @BindColor 綁定color,@BindColor(R.color.colorAccent) int black;
- @BindDimen 綁定Dimen,@BindDimen(R.dimen.borth_width) int mBorderWidth;
- @BindDrawable 綁定Drawable,@BindDrawable(R.drawable.test_pic) Drawable mTestPic;
- @BindFloat 綁定float
- @BindInt 綁定int
- @BindString 綁定一個String id為一個String變量,@BindString( R.string.app_name ) String meg;
ButterKnife更多使用
1)指定多個id綁定事件
例如綁定多個Button的onclick事件,在小括號里面加大括號,然后用逗號分割即可。
@OnClick({R.id.bt_test,R.id.bt_test_two})
public void onClick(View v) {
switch (v.getId()){
case R.id.bt_test:
tvTest.setText("按鈕1被點擊了...");
break;
case R.id.bt_test_two:
tvTest.setText("按鈕2被點擊了...");
break;
}
}
2) 多個view
使用BindViews綁定多個
@BindViews({R.id.tv_test,R.id.tv_test_two,R.id.tv_test_three})
List<TextView> tvList;
使用Action接口或者Setter接口或者View的Property,可以同時設置多個view的屬性
@BindViews({R.id.tv_test,R.id.tv_test_two,R.id.tv_test_three})
List<TextView> tvList;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
ButterKnife.bind(this);
//設置多個view的屬性
//方式1 傳遞值
ButterKnife.apply(tvList,ENABLED,false);
//方式2 指定值
ButterKnife.apply(tvList,DISABLE);
//方式3 設置View的Property
ButterKnife.apply(tvList, View.ALPHA, 0.0f);
}
//Action接口設置屬性
static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
@Override public void apply(View view, int index) {
view.setEnabled(false);
}
};
//Setter接口設置屬性
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);
}
};
3) 自定義View使用注解事件
不用指定id,直接注解OnClick
public class MyButton extends Button {
@OnClick
public void onClick() {
}
}
4)綁定api
- 使用Activity為根視圖綁定任意對象時,如果你使用類似MVC的設計模式你可以在Activity 調用ButterKnife.bind(this, activity),來綁定Controller。
- 使用ButterKnife.bind(this)綁定一個view的子節點字段.如果你在子View的布局里或者自定義view的構造方法里 使用了inflate,你可以立刻調用此方法。或者,從XML inflate來的自定義view類型可以在onFinishInflate回調方法中使用它。
5) 多方法的listener
例如Spinner的setOnItemSelectedListener,他會回調兩個方法:
mSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() {
@Override
public void onItemSelected(AdapterView<?> parent, View view, int position, long id) {
}
@Override
public void onNothingSelected(AdapterView<?> parent) {
}
});
所以這時候如果我們需要注解onNothingSelected,需要在注解參數添加一個callback,
@OnItemSelected(R.id.my_spiner)//默認callback為ITEM_SELECTED
void onItemSelected(int position) {
Toast.makeText(this, "position: " + position, Toast.LENGTH_SHORT).show();
}
@OnItemSelected(value = R.id.my_spiner, callback = OnItemSelected.Callback.NOTHING_SELECTED)
void onNothingSelected() {
Toast.makeText(this, "Nothing", Toast.LENGTH_SHORT).show();
}
注意的是Spinner中只要有數據,默認都會選中第0個數據,所以想進入到onNothingSelected()方法,就需要把Adapter中的數據都清空
6) 使用findById
Butter knife仍然包含了findById方法,用于仍需從一個view ,Activity,或者Dialog上 find view的時候。并且它可以自動轉換類型。
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);
7 )代碼混淆
-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }
-keepclasseswithmembernames class * {
@butterknife.* <fields>;
}
-keepclasseswithmembernames class * {
@butterknife.* <methods>;
}
zelezny : Butterknife插件的使用
使用連接 https://github.com/avast/android-butterknife-zelezny
- 插件安裝
搜索一下,直接安裝即可
- 插件的使用
安裝完成插件后,會提示重啟AS,重啟完后,可以寫一個布局并且新建一個代碼類測試下。測試的過程中要注意的是,需要將光標移到setContentView(R.layout.acty_login),將光標放到R.layout.acty_login,然后右鍵Generate就有了。要注意一定要將光標放在R.layout.acty_login上面。
參照:
http://blog.csdn.net/niubitianping/article/details/54893571