ButterKnife從嚴(yán)格意義講不算是依賴注入框架,它只是專注于Android系統(tǒng)的View注入框架,并不支持其他方面的注入。它可以減少大量的findViewById以及setOnCLickListener代碼,簡化代碼并提升開發(fā)效率,下面簡單的介紹一下如何使用ButterKnife。
(1)添加依賴庫
在Moudle:app的build.gradle文件中添加如下代碼:
android {
...
// Butterknife requires Java 8.
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
dependencies {
...
implementation 'com.jakewharton:butterknife:10.1.0'
annotationProcessor 'com.jakewharton:butterknife-compiler:10.1.0'
}
最新版本的butterknife貌似用到了androdx,如果配置報錯的話可以嘗試在AndroidManifest.xml的application中添加兩句:
<application
android:appComponentFactory=""
tools:replace="android:appComponentFactory"
....
/>
然后在gradle.properties中添加兩句:
android.useAndroidX=true
android.enableJetifier=true
(2)綁定控件
用注解@BindView綁定控件id,代碼如下所示:
public class MainActivity extends AppCompatActivity {
@BindView(R.id.textView)
TextView tv_text; //1
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
ButterKnife.bind(this);
tv_text.setText("BindView");
}
}
需要注意的是上面代碼注釋1處的TextView的類修飾符不能是private或者static,否則會報錯。
用注解@BindViews綁定多個控件id,代碼如下所示:
public class MainActivity extends AppCompatActivity {
@BindViews({R.id.btn_1,R.id.btn_2,R.id.btn_3})
List<Button> buttonList;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
ButterKnife.bind(this);
buttonList.get(0).setText("button1");
buttonList.get(1).setText("button2");
buttonList.get(2).setText("button3");
}
}
(3)綁定資源
可以用注解@BindString、@BindArray、@BindBool、@BindColor、@BindDimen、@BindDrawable和@BindBitmap。這里拿@BindString、@BindArray和@BindDimen來進(jìn)行舉例:
@BindString(R.string.app_name)
String appName;
@BindArray(R.array.swordsman)
String[] swordsman;
@BindDimen(R.dimen.activity_horizontal_margin)
float margin;
(4)綁定監(jiān)聽
用@onClick來對“點擊事件”進(jìn)行監(jiān)聽,同理也可以用@onLongClick來對“長按事件”進(jìn)行監(jiān)聽,如下所示:
@OnClick(R.id.btn_1)
public void showToast(){
Toast.makeText(this,"onclick",Toast.LENGTH_SHORT).show();
}
@OnLongClick(R.id.btn_2)
public boolean setText(Button button){
button.setText("長按事件");
return true;
}
用@onTextChanged來監(jiān)聽EditText,如下所示:
@OnTextChanged(value = R.id.editText, callback = OnTextChanged.Callback.BEFORE_TEXT_CHANGED)
void beforeTextChanged(CharSequence s, int start, int count, int after) {
}
@OnTextChanged(value = R.id.editText, callback = OnTextChanged.Callback.TEXT_CHANGED)
void onTextChanged(CharSequence s, int start, int count, int after) {
}
@OnTextChanged(value = R.id.editText, callback = OnTextChanged.Callback.AFTER_TEXT_CHANGED)
void afterTextChanged(CharSequence s, int start, int count, int after) {
}
用@onTouch處理觸摸事件,如下所示:
@OnTouch(R.id.btn_3)
public boolean onTouch(View view, MotionEvent event) {
return true;
}
使用@OnItemClick對列表item的點擊事件進(jìn)行監(jiān)聽,如下所示:
@OnItemClick(R.id.lv_list)
void onItemClick(int position) {
Toast.makeText(this, "onItemClick" + position, Toast.LENGTH_SHORT).show();
}
(5)可選綁定
@BindView或者其他的注解操作符,如果不能找到目標(biāo)資源,則會引發(fā)異常。為了防止異常,可以添加@Nullable注解:
@Nullable
@BindView(R.id.btn_1)
Button btn1;
在Fragment和Adapter中使用ButterKnife
除了前面在Activity中使用ButterKnife之外,我們還可以在Fragment中使用它,如下所示:
@BindView(R.id.tv_toptext)
TextView tv_toptext;
@Override
public View onCreateView(LayoutInflater inflater,ViewGroup container,Bundle savedInstance){
View view = inflater.inflate(R.layout.fragment_moon,container,false);
ButterKnife.bind(this,view);
return view;
}
同樣,在Adapter中我們也需要引用控件資源,也可以使用ButterKnife,如下所示:
public class SwordsmanAdapter extends ArrayAdapter<Swordsman> {
...
@Override
public View getView(int position,View convertView,ViewGroup parent) {
...
}
class ViewHolder {
@BindView(R.id.tv_name)
TextView tv_name;
public ViewHolder(View view){
ButterKnife.bind(this,view);
}
}
}