ButterKnife的使用詳解
1,概述:
ButterKnife則是注解中相對(duì)簡(jiǎn)單易懂的很不錯(cuò)的開源框架.
ButterKnife是目前常用的一種依托Java注解機(jī)制實(shí)現(xiàn)輔助代碼生成的框架;用到了注解處理器。
它是一個(gè)專注于Android系統(tǒng)的View注入框架,將Android視圖和回調(diào)方法綁定到成員變量和方法上;可視化一鍵生成;可以減少大量的findViewById以及setOnClickListener代碼,是注解中相對(duì)簡(jiǎn)單易懂的開源框架 。
原理:利用了IOC的(Inverse of Controll)控制反轉(zhuǎn)結(jié)構(gòu),2004年后改名為DI(dependency injection)依賴注入。目的是為了使類與類之間解耦合,提高系統(tǒng)的可擴(kuò)展性和可維護(hù)性。
翻譯:黃油刀/
英文使用說(shuō)明地址:http://jakewharton.github.io/butterknife/
API文檔地址:http://jakewharton.github.io/butterknife/javadoc/
GitHub源碼地址:
https://github.com/JakeWharton/butterknife/blob/master/CHANGELOG.md#version-800-2016-04-25
2,ButterKnife 優(yōu)勢(shì):
- 1.強(qiáng)大的View綁定和Click事件處理功能,簡(jiǎn)化代碼,提升開發(fā)效率
- 2.方便的處理Adapter里的ViewHolder綁定問(wèn)題
- 3.運(yùn)行時(shí)不會(huì)影響APP效率,使用配置方便
- 4.代碼清晰,可讀性強(qiáng)
3,注意事項(xiàng)
使用心得:
1.Activity ButterKnife.bind(this);必須在setContentView();之后,且父類bind綁定后,子類不需要再bind
2.Fragment ButterKnife.bind(this, mRootView);
3.屬性布局不能用private or static 修飾,否則會(huì)報(bào)錯(cuò)
4.setContentView()不能通過(guò)注解實(shí)現(xiàn)。(其他的有些注解框架可以)
4,安裝Butterknife插件自動(dòng)生成功能.
- java代碼插件
file-->
setting-->
plugins-->
Browse repositories-->
Android ButterKnife Zelezny-->
install-->
點(diǎn)擊Restart激活已安裝的插件
- kotlin代碼插件
Android ButterKnife Injections (Support Kotlin)
5,項(xiàng)目配置:
1,在module的build.gradle 文件中的dependencies標(biāo)簽中添加代碼如下(導(dǎo)入庫(kù)的依賴):
dependencies {
annotationProcessor 'com.jakewharton:butterknife:10.2.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:10.2.1'
implementation 'com.jakewharton:butterknife:10.2.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:10.2.1'
//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的注冊(cè)綁定
- 6.1使用注意事項(xiàng)
(注:不理解可以繼續(xù)往下看,都有詳細(xì)說(shuō)明,或者自己動(dòng)手寫寫就明白了。)- 1)在Activity 類中綁定 :
必須在setContentView();之后綁定;且父類bind綁定后,子類不需要再bind。
- 1)在Activity 類中綁定 :
ButterKnife.bind(this);
2)在非Activity 類(eg:Fragment、ViewHold)中綁定: ButterKnife.bind(this,view);
這里的this不能替換成getActivity()。3)在Activity中不需要做解綁操作,在Fragment 中必須在onDestroyView()中做解綁操作。
4)使用ButterKnife修飾的方法和控件,不能用private or static 修飾,否則會(huì)報(bào)錯(cuò)。
5)setContentView()不能通過(guò)注解實(shí)現(xiàn)。(其他的有些注解框架可以)
6)使用Activity為根視圖綁定任意對(duì)象時(shí),如果你使用類似MVC的設(shè)計(jì)模式你可以在Activity 調(diào)用ButterKnife.bind(this, activity),來(lái)綁定Controller。
7)使用ButterKnife.bind(this,view)綁定一個(gè)view的子節(jié)點(diǎn)字段。如果你在子View的布局里或者自定義view的構(gòu)造方法里 使用了inflate,你可以立刻調(diào)用此方法?;蛘?,從XML inflate來(lái)的自定義view類型可以在onFinishInflate回調(diào)方法中使用它。
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代碼
首先將鼠標(biāo)放置在初始化view布局文件的位置上,然后按快捷鍵
Alt+Insert -->Generate Butterknife Injections
最后選擇生成view和點(diǎn)擊事件。
2.使用注意事項(xiàng)
1)ButterKinfe的注解標(biāo)簽因版本不同而有所變化。8.0.0之前的Bind標(biāo)簽在8.0.0之后變成了BindView,
2)默認(rèn)情況下,@bind和 listener 的綁定是必需的。如果無(wú)法找到目標(biāo)視圖,將拋出一個(gè)異常。
要抑制此行為并創(chuàng)建可選綁定,可以將@Nullable注解添加到字段中,或?qū)Optional注解添加到方法。
3.綁定view注解
@BindView---->綁定一個(gè)view;id為一個(gè)view 變量
修飾類型不能是:private 或者 static
@BindView(R.id.tv_fm1)
TextView tvFm1;
@BindViews ---->綁定多個(gè)view
@BindViews: 布局內(nèi)多個(gè)控件 id 注解
@BindViews({ R.id.button1, R.id.button2, R.id.button3})
public List<Button> buttonList ;
代碼中的實(shí)力使用
buttonList.get( 0 ).setText( "hello 1 ");
buttonList.get( 1 ).setText( "hello 2 ");
buttonList.get( 2 ).setText( "hello 3 ");
4.綁定資源注解
@BindString ---->綁定一個(gè)String
@BindString(R.string.app_name )
String meg;
@BindString(R.string.app_name) //綁定資源文件中string字符串
String str;
button.setText( str );
@BindArray---->綁定string里面array數(shù)組;
@BindArray(R.array.city )
String[] citys ;
@BindBitmap---->綁定圖片資源為Bitmap;
@BindBitmap(R.mipmap.wifi )
Bitmap bitmap;
@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;
@BindBool ---->綁定boolean值
@BindFloat ---->綁定float
@BindInt ---->綁定int
5,ButterKnife事件注解
@OnClick---->點(diǎn)擊事件,點(diǎn)擊事件綁定
不用聲明view,不用setOnClickLisener()就可以綁定點(diǎn)擊事件
//給 button1 設(shè)置一個(gè)點(diǎn)擊事件
@OnClick(R.id.button1 )
public void showToast(){
Toast.makeText(this, "is a click", Toast.LENGTH_SHORT).show();
}
指定多個(gè)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("我是點(diǎn)擊事件1");
break;
case R.id.ll_product_lilv:
System.out.print("我是點(diǎn)擊事件2");
break;
case R.id.ll_product_qixian:
System.out.print("我是點(diǎn)擊事件3");
break;
case R.id.ll_product_repayment_methods:
System.out.print("我是點(diǎn)擊事件4");
break;
}
}
@OnCheckedChanged ---->選中,取消選中
@OnCheckedChanged({R.id.rb_praise, R.id.rb_tread})
void OnCheckedChangeListener(CompoundButton view, boolean ischanged) {
switch (view.getId()) {
case R.id.rb_praise:
if (ischanged) {
Toast.makeText(this, "贊了!", Toast.LENGTH_SHORT).show();
}
break;
case R.id.rb_tread:
if (ischanged) {
Toast.makeText(this, "踩了!", Toast.LENGTH_SHORT).show();
}
break;
default:
break;
}
}
@OnEditorAction ---->軟鍵盤的功能鍵
@OnFocusChange ---->焦點(diǎn)改變
@OnItemClick item---->被點(diǎn)擊(注意這里有坑,如果item里面有Button等這些有點(diǎn)擊的控件事件的,需要設(shè)置這些控件屬性focusable為false)
@OnItemLongClick item---->長(zhǎng)按(返回真可以攔截onItemClick)
@OnItemSelected ---->item被選擇事件
@OnLongClick ---->綁定控件長(zhǎng)按事件
//給 button1 設(shè)置一個(gè)長(zhǎng)按事件
@OnLongClick( R.id.button1 )
public boolean showToast2(){
Toast.makeText(this, "is a long click", Toast.LENGTH_SHORT).show();
return true ;
}
@OnPageChange ---->頁(yè)面改變事件
@OnTextChanged ---->EditText里面的文本變化事件
@OnTextChanged(R.id.et_photo_describe)
public void onTextChanged(CharSequence text) {
ImageInfo imageInfo = mImageInfos.get(mPosition);
if (imageInfo != null) {
imageInfo.photoDescribe = text.toString();
}
}
@OnTouch ---->觸摸事件
@OnTouch(R.id.recycler_view3)
public boolean onRvTouch(View v, MotionEvent event){
if (event.getAction() == MotionEvent.ACTION_UP) {
layoutView3.performClick(); //模擬父控件的點(diǎn)擊
}
return false;
}
6,使用findById
Butter Knife仍然包含了findById()方法,用于仍需從一個(gè)view ,Activity,或者Dialog上初始化view的時(shí)候,
并且它可以自動(dòng)轉(zhuǎn)換類型。
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,設(shè)置多個(gè)view的屬性
允許您立即對(duì)列表中的所有視圖進(jìn)行操作
apply()
Action和Setter接口允許指定簡(jiǎn)單的行為
Action和Setter接口
public class ButterknifeActivity extends AppCompatActivity {
@BindViews({R.id.first_name, R.id.middle_name, R.id.last_name})
List<EditText> nameViews;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_butterknife);
//綁定activity
ButterKnife.bind(this);
//看不懂的小伙伴,多敲幾遍代碼,實(shí)際操作一下自然就懂了。相信我!如果你重復(fù)敲了10遍以上的代碼,并認(rèn)真思考了還沒(méi)懂,歡迎給我評(píng)論留言。
//設(shè)置多個(gè)view的屬性
//方式1:傳遞值
ButterKnife.apply(nameViews, DISABLE);
//方式2:指定值
ButterKnife.apply(nameViews, ENABLED, false);
////方式3 設(shè)置View的Property
ButterKnife.apply(nameViews, View.ALPHA, 0.0f);//一個(gè)Android屬性也可以用于應(yīng)用的方法。
}
/*
* Action接口設(shè)置屬性
*/
static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
@Override
public void apply(View view, int index) {
view.setEnabled(false);//目的是使多個(gè)view都具備此屬性
}
};
/*
* Setter接口設(shè)置屬性
*/
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);//目的是使多個(gè)view都具備此屬性,可變boolean值是可以傳遞的
}
};
}
7,Butter Knife的代碼混淆
在混淆文件中,添加如下代碼:
-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }
-keepclasseswithmembernames class * {
@butterknife.* <fields>;
}
-keepclasseswithmembernames class * {
@butterknife.* <methods>;
}
附錄:
ButterKnife
https://github.com/zhang721688/ButterKnife