ButterKnife
从严格意义讲不算是依赖注入框架,它只是专注于Android
系统的View
注入框架,并不支持其他方面的注入。它可以减少大量的findViewById
以及setOnCLickListener
代码,简化代码并提升开发效率,下面简单的介绍一下如何使用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
来进行举例:
@BindString(R.string.app_name)
String appName;
@BindArray(R.array.swordsman)
String[] swordsman;
@BindDimen(R.dimen.activity_horizontal_margin)
float margin;
(4)绑定监听
用@onClick
来对“点击事件”进行监听,同理也可以用@onLongClick
来对“长按事件”进行监听,如下所示:
@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
来监听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
的点击事件进行监听,如下所示:
@OnItemClick(R.id.lv_list)
void onItemClick(int position) {
Toast.makeText(this, "onItemClick" + position, Toast.LENGTH_SHORT).show();
}
(5)可选绑定
@BindView
或者其他的注解操作符,如果不能找到目标资源,则会引发异常。为了防止异常,可以添加@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);
}
}
}