简介
注意:7.0版本与8.0版本方法名有所改动,整体业务逻辑和原理没什么变动
注意:
2017-5之前
需在
gradle进行好几项配置,而
2017-5之后只需添加以下两行依赖即可
2017-5的配置
compile 'com.jakewharton:butterknife:8.6.0'
annotationProcessor 'com.jakewharton:butterknife-compiler:8.6.0'
特点:
- 采用注解的方式实现
- 强大的View绑定和Click事件处理功能,简化代码,提升开发效率
- 方便的处理Adapter里的ViewHolder绑定问题
- 运行时不会影响APP效率,使用配置方便
- 代码清晰,可读性强
使用心得:
- Activity中ButterKnife.bind(this);必须在setContentView();之后,且父类bind绑定后,子类不需要再bind
- Fragment中为ButterKnife.bind(this, mRootView);
- 成员不能用private or static 修饰,否则会报错
使用准备
一、
AS中将注解和字段放在一行的设置:
settings-->editor-->code style-->java-->wrapping and braces-->Field annotation
二、
.gradle配置
1、在app层级的build.gradle文件的头部添加【
apply plugin: 'com.neenbedankt.android-apt'
】
2、
在app层级的build.gradle文件的
dependencies中添加如下依赖:
compile 'com.jakewharton:butterknife:8.1.0'
apt 'com.jakewharton:butterknife-compiler:8.1.0'
3、在project层级的
build.
gradle文件
的
dependencies中添加如下依赖
【classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'】
最后,同步Gradle,你就可以愉快地使用ButterKnife了。
三、使用zelezny插件
可一键生成所有定义id的组件的声明及onclick事件
,不用手动写。
在AndroidStudio->File->Settings->Plugins->搜索【Zelezny】下载添加即可。
使用时,在要导入注解的Activity 或 Fragment 或 ViewHolder的【layout】资源代码上,右键—>Generate
—>
Generate ButterKnife Injections
功能
1、绑定Activity或Fragment,父类中绑定后子类不需要再绑定
public class SimpleFragment extends Fragment {
@BindView(R.id.fragment_text_view) TextView mTextView;
private Unbinder unbinder;
public SimpleFragment() {
}
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fragment_simple, container, false);
unbinder = ButterKnife.bind(this, view);//绑定Activity为ButterKnife.bind(this);
mTextView.setText("TextView in Fragment are found!");
return view;
}
@Override
public void onDestroyView() {
unbinder.unbind();//解除绑定,官方文档只对fragment做了解绑
super.onDestroyView();
}
}
2、绑定资源
@BindView(R.id.app_name) TextView mTextView;//view
@BindString(R.string.app_name) String appName;//sting
@BindColor(R.color.red) int textColor;//颜色
@BindDrawable(R.mipmap.ic_launcher) Drawable drawable;//drawble
@BindDrawable(R.drawable.selector_image) Drawable selector;
3、点击事件的绑定
a.直接绑定一个方法
@OnClick(R.id.submit)
public void submit(View view) { }
b.所有监听方法的参数是可选的
@OnClick(R.id.submit)
public void submit() { }
c.定义一个特定类型,它将自动被转换
@OnClick(R.id.submit)
public void sayHi(Button button) { }
d.多个view统一处理同一个点击事件,很方便,避免抽方法重复调用的麻烦
@OnClick({ R.id.door1, R.id.door2, R.id.door3 })
public void pickDoor(DoorView door) { }
e.自定义view可以绑定自己的监听,不指定id
public class FancyButton extends Button {
@OnClick
public void onClick() { }
}
f.给EditText加addTextChangedListener(即添加多回调方法的监听的使用方法),利用指定回调,实现想回调的方法即可,哪个注解不会用点进去看下源码上的注释就会用了
@OnTextChanged(value = R.id.mobileEditText, callback = OnTextChanged.Callback.BEFORE_TEXT_CHANGED)
void beforeTextChanged(CharSequence s, int start, int count, int after) { }
@OnTextChanged(value = R.id.mobileEditText, callback = OnTextChanged.Callback.TEXT_CHANGED)
void onTextChanged(CharSequence s, int start, int before, int count) { }
@OnTextChanged(value = R.id.mobileEditText, callback = OnTextChanged.Callback.AFTER_TEXT_CHANGED)
void afterTextChanged(Editable s) { }
4、Adapter的ViewHolder 绑定
static class ViewHolder {
@Bind(R.id.hello_world)
TextView textview;
public ViewHolder(View view) {
ButterKnife.bind(this, view);
}
}
5、对一组View进行统一操作
a
.装入一个list
@Bind({ R.id.first_name, R.id.middle_name, R.id.last_name }) List<EditText> nameViews;
static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
@Override public void apply(View view, int index) {
view.setEnabled(false);
}
};
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);
}
};
ButterKnife.apply(nameViews, DISABLE);
ButterKnife.apply(nameViews, ENABLED, false);
6、可选绑定:默认情况下,“绑定”和“监听”绑定都是必需的。如果不能找到目标视图,则将抛出异常。所以做空处理
@Nullable @Bind(R.id.might_not_be_there) TextView mightNotBeThere;
@Nullable @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() { }
7、代码混淆
-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }
-keepclasseswithmembernames class * {
@butterknife.* <fields>;
}
-keepclasseswithmembernames class * {
@butterknife.* <methods>;
}
Activity
public class SimpleActivity extends AppCompatActivity {
@BindView(R.id.simple_activity_text_view) TextView mTextView; //this field should not be declared private or static
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_simple);
ButterKnife.bind(this);// ButterKnife.inject(this) should be called after setContentView()
mTextView.setText("View视图的绑定");
}
@OnClick(R.id.simple_activity_button)
void onButtonClick(View view) { //the method should not be declared private or static
//you can write the parameter (View view) as above or just write onButtonClick() leave parameters empty, both are ok
Toast.makeText(this, "事件绑定", Toast.LENGTH_SHORT).show();
}
//bind event to CheckBox
@OnCheckedChanged(R.id.simple_activity_checkbox)
void onCheckedChanged(CompoundButton button, boolean checked) {
Toast.makeText(this, "CheckBox状态改变了:" + checked, Toast.LENGTH_SHORT).show();
}
}
Fragment
public class SimpleFragment extends Fragment {
@BindView(R.id.fragment_text_view) TextView mTextView;
private Unbinder unbinder;
public SimpleFragment() {
}
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fragment_simple, container, false);
unbinder = ButterKnife.bind(this, view);
mTextView.setText("TextView in Fragment are found!");
return view;
}
@Override
public void onDestroyView() {
unbinder.unbind();
super.onDestroyView();
}
}
ListView
public class ListViewActivity extends AppCompatActivity {
@BindView(R.id.my_list_view) ListView mListView;
private PersonAdapter adapter;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_list_view);
ButterKnife.bind(this);
adapter = new PersonAdapter(this, MockDataUtils.getPersons());
mListView.setAdapter(adapter);
}
@OnItemClick(R.id.my_list_view)
void onItemClick(int position) {//though there are 4 parameters, you can just write the one you want to use
Toast.makeText(this, "点击事件: " + adapter.getItem(position).getName(), Toast.LENGTH_SHORT).show();
}
@OnItemLongClick(R.id.my_list_view)
boolean onItmeLongClick(int position) {
Toast.makeText(this, "长点击事件:" + adapter.getItem(position).getName(), Toast.LENGTH_SHORT).show();
if (position % 2 == 0) return true;
else return false; //if return false, the onItemClick() will be invoked反射调用 when touch up
}
}
Adapter
public class PersonAdapter extends BaseAdapter {
@Override
public View getView(int position, View convertView, ViewGroup parent) {
ViewHolder holder;
if (convertView == null) {
convertView = mInflater.inflate(R.layout.person_item_layout, null);
holder = new ViewHolder(convertView);
convertView.setTag(holder);
} else holder = (ViewHolder) convertView.getTag();
Person person = getItem(position);
if (null != person) {
holder.name.setText(person.getName());
}
return convertView;
}
static class ViewHolder {
@BindView(R.id.person_name) TextView name;
public ViewHolder(View view) {
ButterKnife.bind(this, view);
}
}
}
2017-5-23