ButterKnife的使用詳解

ButterKnife的使用詳解

1,概述:
ButterKnife則是註解中相對簡單易懂的很不錯的開源框架.
ButterKnife是目前經常使用的一種依託Java註解機制實現輔助代碼生成的框架；用到了註解處理器。
它是一個專一於Android系統的View注入框架,將Android視圖和回調方法綁定到成員變量和方法上；可視化一鍵生成；能夠減小大量的findViewById以及setOnClickListener代碼，是註解中相對簡單易懂的開源框架 。

原理：利用了IOC的(Inverse of Controll)控制反轉結構，2004年後更名爲DI(dependency injection)依賴注入。目的是爲了使類與類之間解耦合，提升系統的可擴展性和可維護性。

翻譯:黃油刀/
英文使用說明地址：http://jakewharton.github.io/butterknife/
API文檔地址：http://jakewharton.github.io/butterknife/javadoc/

 

2,ButterKnife 優點：
1.強大的View綁定和Click事件處理功能，簡化代碼，提高開發效率
2.方便的處理Adapter裏的ViewHolder綁定問題
3.運行時不會影響APP效率，使用配置方便
4.代碼清晰，可讀性強
3,注意事項
使用心得：
1.Activity ButterKnife.bind(this);必須在setContentView();以後，且父類bind綁定後，子類不須要再bind
2.Fragment ButterKnife.bind(this, mRootView);
3.屬性佈局不能用private or static 修飾，不然會報錯
4.setContentView()不能經過註解實現。（其餘的有些註解框架能夠）
官網http://jakewharton.github.io/butterknife/
4,安裝Butterknife插件自動生成功能.
file-->setting-->plugins-->Browse repositories-->
Android ButterKnife Zelezny-->install
-->點擊Restart激活已安裝的插件
5,項目配置：
1,在module的build.gradle 文件中的dependencies標籤中添加代碼以下（導入庫的依賴）:
dependencies {
//compile 'com.jakewharton:butterknife:8.8.1'
implementation 'com.jakewharton:butterknife:8.8.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:8.8.1'
}
6,Butter Knife的註冊綁定
6.1使用注意事項
（注：不理解能夠繼續往下看，都有詳細說明，或者本身動手寫寫就明白了。）
1）在Activity 類中綁定 ：ButterKnife.bind(this);
必須在setContentView();以後綁定；且父類bind綁定後，子類不須要再bind。
2）在非Activity 類（eg：Fragment、ViewHold）中綁定： ButterKnife.bind(this，view);
這裏的this不能替換成getActivity（）。
3）在Activity中不須要作解綁操做，在Fragment 中必須在onDestroyView()中作解綁操做。
4）使用ButterKnife修飾的方法和控件，不能用private or static 修飾，不然會報錯。
5）setContentView()不能經過註解實現。（其餘的有些註解框架能夠）
6）使用Activity爲根視圖綁定任意對象時，若是你使用相似MVC的設計模式你能夠在Activity 調用ButterKnife.bind(this, activity)，來綁定Controller。
7）使用ButterKnife.bind(this，view)綁定一個view的子節點字段。若是你在子View的佈局裏或者自定義view的構造方法裏 使用了inflate,你能夠馬上調用此方法。或者，從XML inflate來的自定義view類型能夠在onFinishInflate回調方法中使用它。

6.2在Activity中綁定ButterKnife
ButterKnife.bind(this);

6.3在Fragment中綁定ButterKnife
ButterKnife.bind(this, view);

6.4在Adapter中綁定ButterKnife
ButterKnife.bind(this, view);
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.testlayout, parent, false);
holder = new ViewHolder(view);
view.setTag(holder);
}

holder.name.setText("諾諾");
// etc...

return view;
}

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

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

 

7,Butter Knife的使用
1.快速生成註解view和onclick代碼
//首先將鼠標放置在初始化view佈局文件的位置上，而後按快捷鍵Shift+Alt+S --> Alt+Insert -->Ctrl+Shif+F12，
//最後選擇生成view和點擊事件。

 

 

2.使用注意事項
1）ButterKinfe的註解標籤因版本不一樣而有所變化。8.0.0以前的Bind標籤在8.0.0以後變成了BindView，
2）默認狀況下，@bind和 listener 的綁定是必需的。若是沒法找到目標視圖，將拋出一個異常。
要抑制此行爲並建立可選綁定，能夠將@Nullable註解添加到字段中，或將@Optional註解添加到方法。

 

3.綁定註解
@BindView---->綁定一個view；id爲一個view 變量
@BindView(R.id.tv_fm1)
TextView tvFm1;
@BindViews ---->綁定多個view；id爲一個view的list變量
@BindViews({ R.id.btn1,R.id.btn2 })
List<Button> buttons;
@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;

 

 

4,事件註解
@OnClick---->點擊事件
@OnCheckedChanged ---->選中，取消選中
@OnEditorAction ---->軟鍵盤的功能鍵
@OnFocusChange ---->焦點改變
@OnItemClick item---->被點擊(注意這裏有坑，若是item裏面有Button等這些有點擊的控件事件的，須要設置這些控件屬性focusable爲false)
@OnItemLongClick item---->長按(返回真能夠攔截onItemClick)
@OnItemSelected ---->item被選擇事件
@OnLongClick ---->長按事件
@OnPageChange ---->頁面改變事件
@OnTextChanged ---->EditText裏面的文本變化事件
@OnTouch ---->觸摸事件

 

 

5,綁定view

1）@BindView() : 佈局id 註解
@BindView( R2.id.button)
public Button button;
button 的修飾類型不能是：private 或者 static 。

2）@BindViews(): 佈局內多個控件 id 註解
@BindViews({ R2.id.button1, R2.id.button2, R2.id.button3})
public List<Button> buttonList ;
ButterKnife.bind(this);
buttonList.get( 0 ).setText( "hello 1 ");
buttonList.get( 1 ).setText( "hello 2 ");
buttonList.get( 2 ).setText( "hello 3 ");

 

 

 

6.綁定資源
1）@BindString() ：綁定string 字符串
@BindString(R2.string.app_name) //綁定資源文件中string字符串
String str;
button.setText( str );

2）@BindArray() : 綁定string裏面array數組
@BindArray(R2.array.city) //綁定string裏面array數組
String [] citys ;
button.setText(citys[0]);

3）@BindBitmap( ) : 綁定Bitmap 資源
@BindBitmap(R2.drawable.bm)//綁定Bitmap 資源
public Bitmap bitmap ;
imageView.setImageBitmap(bitmap);
drawable文件夾下的圖片使用R或R2引用都沒問題；可是mipmap文件夾下的圖片資源引用目前只能使用R

4）@BindColor( ) : 綁定一個顏色值
@BindColor( R2.color.colorAccent ) //具體色值在color文件中
int black ; //綁定一個顏色值
button.setTextColor( black );

 

 

 

7,點擊事件綁定
不用聲明view，不用setOnClickLisener（）就能夠綁定點擊事件
1）綁定事件
@OnClick( ) : 綁定控件點擊事件
@OnLongClick( ) ： 綁定控件長按事件
@OnClick(R2.id.button1 ) //給 button1 設置一個點擊事件
public void showToast(){
Toast.makeText(this, "is a click", Toast.LENGTH_SHORT).show();
}

@OnLongClick( R2.id.button1 )//給 button1 設置一個長按事件
public boolean showToast2(){
Toast.makeText(this, "is a long click", Toast.LENGTH_SHORT).show();
return true ;
}

2）指定多個id綁定事件
@OnClick({R.id.ll_product_name, R.id.ll_product_lilv, R.id.ll_product_qixian, R.id.ll_product_repayment_methods})
public void onViewClicked(View view) {
switch (view.getId()) {
case R.id.ll_product_name:
System.out.print("我是點擊事件1");
break;
case R.id.ll_product_lilv:
System.out.print("我是點擊事件2");
break;
case R.id.ll_product_qixian:
System.out.print("我是點擊事件3");

break;
case R.id.ll_product_repayment_methods:
System.out.print("我是點擊事件4");
break;
}
}
多條點擊事件不能夠用R2的方式
若是必定要使用R2的寫法，能夠單一逐次寫

3）自定義View使用註解事件
不用指定id，直接註解OnClick
public class MyButton extends Button {
@OnClick
public void onClick() {}
}

 

 

8,.使用findById
Butter Knife仍然包含了findById()方法，用於仍需從一個view ，Activity，或者Dialog上初始化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 iv = ButterKnife.findById(view, R.id.iv);

 

 

9,設置多個view的屬性
容許您當即對列表中的全部視圖進行操做
apply()

Action和Setter接口容許指定簡單的行爲
Action和Setter接口
public class ButterknifeActivity extends AppCompatActivity {

@BindViews({R2.id.first_name, R2.id.middle_name, R2.id.last_name})
List<EditText> nameViews;

@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_butterknife);

//綁定activity
ButterKnife.bind(this);
//看不懂的小夥伴，多敲幾遍代碼，實際操做一下天然就懂了。相信我！若是你重複敲了10遍以上的代碼，並認真思考了還沒懂，歡迎給我評論留言。

//設置多個view的屬性
//方式1：傳遞值
ButterKnife.apply(nameViews, DISABLE);
//方式2：指定值
ButterKnife.apply(nameViews, ENABLED, false);
////方式3 設置View的Property
ButterKnife.apply(nameViews, View.ALPHA, 0.0f);//一個Android屬性也能夠用於應用的方法。
}

/*
* Action接口設置屬性
*/
static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
@Override
public void apply(View view, int index) {
view.setEnabled(false);//目的是使多個view都具有此屬性
}
};
/*
* 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);//目的是使多個view都具有此屬性，可變boolean值是能夠傳遞的
}
};
}
8,Butter Knife的代碼混淆
在混淆文件中，添加以下代碼：
-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }

-keepclasseswithmembernames class * {
@butterknife.* <fields>;
}

-keepclasseswithmembernames class * {
@butterknife.* <methods>;
}

代碼實現：

 

 1 public class MainActivity extends AppCompatActivity {
 2 
 3     @BindView(R.id.tv)
 4     TextView tv;
 5 
 6     @Override
 7     protected void onCreate(Bundle savedInstanceState) {
 8         super.onCreate(savedInstanceState);
 9         setContentView(R.layout.activity_main);
10         ButterKnife.bind(this);
11         tv.setText("ButterKnife,在Activity中使用!");
12     }
13 
14 
15     @OnClick(R.id.tv)
16     public void onViewClicked() {
17         DemonstrateUtil.showToastResult(this,"佈局中含有Fragment!");
18     }
19 }

 

 

 

 

 

 

 

 1 public class TempActivity extends AppCompatActivity {
 2 
 3     @BindView(R.id.btn)
 4     Button btn;
 5     @BindView(R.id.tv)
 6     TextView tv;
 7     @BindView(R.id.iv)
 8     ImageView iv;
 9 
10     @Override
11     protected void onCreate(Bundle savedInstanceState) {
12         super.onCreate(savedInstanceState);
13         setContentView(R.layout.activity_temp);
14         ButterKnife.bind(this);
15         tv.setTextColor(getResources().getColor(R.color.colorAccent));
16         tv.setText("ButterKnife!");
17     }
18 
19     @OnClick(R.id.btn)
20     public void onViewClicked() {
21         DemonstrateUtil.showLogResult("OnClick");
22         DemonstrateUtil.showToastResult(this,"OnClick");
23     }

 

 

 

 

 1 public class Temp2Activity extends AppCompatActivity {
 2 
 3     @BindView(R.id.iv1)
 4     ImageView iv1;
 5     @BindView(R.id.tv1)
 6     TextView tv1;
 7 
 8     @Override
 9     protected void onCreate(Bundle savedInstanceState) {
10         super.onCreate(savedInstanceState);
11         setContentView(R.layout.activity_temp2);
12         ButterKnife.bind(this);
13     }
14 
15     @OnClick(R.id.tv1)
16     public void onViewClicked() {
17     }
18 }

 

 

 

 1 public class MyAdapter extends BaseAdapter {
 2 
 3 
 4 
 5     private List<ItemInfo> mList;
 6 
 7     public MyAdapter(List<ItemInfo> list) {
 8         mList = list;
 9     }
10 
11     @Override
12     public int getCount() {
13         return mList == null ? 0 : mList.size();
14     }
15 
16     @Override
17     public Object getItem(int position) {
18         return mList.get(position);
19     }
20 
21     @Override
22     public long getItemId(int position) {
23         return position;
24     }
25 
26     @Override
27     public View getView(int position, View convertView, ViewGroup parent) {
28         ViewHolder viewHolder = null;
29         if (convertView == null) {
30             convertView = View.inflate(parent.getContext(), R.layout.item_list, null);
31             viewHolder = new ViewHolder(convertView);
32             convertView.setTag(viewHolder);
33         } else {
34             viewHolder = (ViewHolder) convertView.getTag();
35         }
36         viewHolder.tvItem.setText(mList.get(position).name);
37         if (position % 2 == 0) {
38             viewHolder.iv.setImageBitmap(viewHolder.bitmap);
39         }else {
40             viewHolder.iv.setImageResource(R.mipmap.ic_launcher_round);
41         }
42         return convertView;
43     }
44 
45     static class ViewHolder {
46         @BindView(R.id.tv_item)
47         TextView tvItem;
48         @BindView(R.id.iv)
49         ImageView iv;
50         @BindBitmap(R.mipmap.ic_launcher)
51         Bitmap bitmap;
52         ViewHolder(View view) {
53             ButterKnife.bind(this, view);
54         }
55     }
56 
57 }

 

 

 

 1 public class BlankFragment extends Fragment {
 2 
 3 
 4     @BindView(R.id.tv_fm1)
 5     TextView tvFm1;
 6     Unbinder unbinder;
 7     @BindViews({ R.id.btn1,R.id.btn2 })
 8     List<Button> buttons;
 9     @BindColor(R.color.colorAccent)
10     int colorAccent;
11 
12 
13     @Override
14     public View onCreateView(LayoutInflater inflater, ViewGroup container,
15                              Bundle savedInstanceState) {
16         View view = View.inflate(getContext(), R.layout.fragment_blank, null);
17         unbinder = ButterKnife.bind(this, view);
18         tvFm1.setText("fragment中使用ButterKnife!");
19         tvFm1.setTextColor(colorAccent);
20         Button btn2 = buttons.get(1);
21         btn2.setText("適配器使用ButterKnife");
22         return view;
23     }
24 
25     @Override
26     public void onDestroyView() {
27         super.onDestroyView();
28         unbinder.unbind();
29     }
30 
31     @OnClick({R.id.btn1, R.id.btn2})
32     public void onViewClicked(View view) {
33         switch (view.getId()) {
34             case R.id.btn1:
35                 DemonstrateUtil.showToastResult(getContext(),"fragment中的第1個按鈕!");
36                 break;
37             case R.id.btn2:
38                 startActivity(new Intent(getActivity(),AdpActivity.class));
39                 break;
40         }
41     }
42 }

 

 

 

 1 public class AdpActivity extends AppCompatActivity {
 2 
 3     @BindView(R.id.lv)
 4     ListView lv;
 5 
 6     @BindArray(R.array.names)
 7     String[] names;
 8 
 9     @Override
10     protected void onCreate(Bundle savedInstanceState) {
11         super.onCreate(savedInstanceState);
12         setContentView(R.layout.activity_adp);
13         ButterKnife.bind(this);
14         List<ItemInfo> list = new ArrayList<>();
15         for (int i = 0; i < names.length; i++) {
16             ItemInfo info = new ItemInfo();
17             info.name = names[i];
18             info.age = "age"+i;
19             list.add(info);
20         }
21         lv.setAdapter(new MyAdapter(list));
22     }
23 
24 }