Android Studio使用butterknife注解框架插件Android Butterknife Zelezny

知道ButterKnifey这个注解框架之后，就开始试着应用到自己的项目中了，在build.gradle中加入：compile ‘com.jakewharton:butterknife:7.0.1’ 就可以使用了，不用写findViewById了，省了好多麻烦事。不过如果要自己去注解每个对象的话，觉得还是很麻烦的，于是又找到了Android Butterknife Zelezny这个插件（下载插件:http://plugins.jetbrains.com/plugin/7369，也可以从androidstudio的setting-plugins里面搜索下载安装该插件）。这个插件可以一键从 布局文件中 生成对于的 View 声明和 ButterKnife 注解。

如何使用

1、在所使用的布局 ID 上点击右键 (例：R.layout.activity_main)， 然后选择 Generate -> Generate ButterKnife Injections

2、在对话框中选择需要注入的 View， 还有个选项可以给 Adapter 创建一个 ViewHolder。

3、点击 Confirm ， 代码自动生成！

新版的7.0之后的发生了一些变化，小伙伴们要注意下了：新版的 由@InjectView变为了@Bind；ButterKnife.Inject()变为了ButterKnife.Bind()；@InjectResourcesf()分为了@BindString(), @BindColor(), @BindDimen等。没有变化的：@OnClick(), @OnLongClick()等。

下面介绍下用法（参考文档：/article/2591278.html；7.0以下的版本可参考http://stormzhang.com/openandroid/android/2014/01/12/android-butterknife/）

Activity Binding

class ExampleActivity extends Activity {
@Bind(R.id.title) TextView title;
@Bind(R.id.subtitle) TextView subtitle;
@Bind(R.id.footer) TextView footer;

@Override public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.simple_activity);
ButterKnife.bind(this);
// TODO Use fields...
}
}

Fragment Binding

public class FancyFragment extends Fragment {
@Bind(R.id.button1) Button button1;
@Bind(R.id.button2) Button button2;

@Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fancy_fragment, container, false);
ButterKnife.bind(this, view);
// TODO Use fields...
return view;
}
}

ViewHolder binding

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.whatever, parent, false);
holder = new ViewHolder(view);
view.setTag(holder);
}

holder.name.setText("John Doe");
// etc...

return view;
}
static class ViewHolder {
@Bind(R.id.title) TextView name;
@Bind(R.id.job_title) TextView jobTitle;

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

你可以在任何地方调用ButterKnife.bind而不是调用findViewById。

绑定自定义对象，使用一个Activity作为view根节点。如果你使用了像MVC这样的模式你可以使用它的Activity来绑定控制器，借助 ButterKnife.bing(this , activity).

使用ButterKnife.bind(this)绑定一个view的子节点字段.如果你用了节点在你的布局里或者自定义view的构造方法里使用了inflate,你可以立刻调用此方法。或者，从XML反射的来的自定义view类型可以使用它在onFinishInflate回调方法中。

view点击事件

@OnClick(R.id.submit)
public void submit() {
// TODO submit data to server...
}

定义一个具体的类型并且它将会自动的被类型转换

@OnClick(R.id.submit)
public void sayHi(Button button) {
button.setText("Hello!");
}

对同一事件操作时在一个单独的绑定中声明多个ID

@OnClick({ R.id.door1, R.id.door2, R.id.door3 })
public void pickDoor(DoorView door) {
if (door.hasPrizeBehind()) {
Toast.makeText(this, "You win!", LENGTH_SHORT).show();
} else {
Toast.makeText(this, "Try again", LENGTH_SHORT).show();
}
}

自定义view可以绑定在他们自己的监听器上并且不需要具体声明一个ID。

public class FancyButton extends Button {
@OnClick
public void onClick() {
// TODO do something!
}
}

资源绑定

通过预定义的注解（@BindBool, @BindColor, @BindDimen, @BindDrawable, @BindInt, @BindString）结合一个资源 ID以和表示该资源类型的相应的字段。

class ExampleActivity extends Activity {
@BindString(R.string.title) String title;
@BindDrawable(R.drawable.graphic) Drawable graphic;
@BindColor(R.color.red) int red;
@BindDimen(R.dimen.spacer) Float spacer;
// ...
}

View集合中的使用

你可以将多个view组成一个List或数组。

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

apply方法可以一次作用到所有的View

ButterKnife.apply(nameViews, DISABLE);
ButterKnife.apply(nameViews, ENABLED, false);

Action 和 Setter 接口可以指定简单的行为。

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);
}
};

Android的Property（配置信息）也可以被用在apply方法中

ButterKnife.apply(nameViews, View.ALPHA, 0.0f);

重置绑定

Fragment的生命周期与Activity不同，当我们在onCreateView绑定Fragment，在onDestroyView将View 设置为null时，Butter Knife 的 unbind()方法可以帮我们做这些。

public class FancyFragment extends Fragment {
@Bind(R.id.button1) Button button1;
@Bind(R.id.button2) Button button2;

@Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fancy_fragment, container, false);
ButterKnife.bind(this, view);
return view;
}

@Override public void onDestroyView() {
super.onDestroyView();
ButterKnife.unbind(this);
}
}

可选绑定

默认情况下，”@Bind”和”@OnClick”(或者其他监听)监听绑定都是必需的。如果不能找到目标视图，则会引发异常。

为了制止这种行为，创建一个可选的结合，添加一个‘@Nullable’注解字段或方法。

任何名字为@Nullable的注解可以被这样使用。鼓励你使用Android自己的注解库”support-annotations”中的@Nullable注解，参见Android Tools Project.

@Nullable @Bind(R.id.might_not_be_there) TextView mightNotBeThere;

@Nullable @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {

}

多元监听

与方法注解相匹配的监听器有多个回调可以被用来绑定在他们中间的任何一个身上。每一个注解都有默认的回调跟它绑定在一起。可以使用callback参数声明一个可替代的回调。

@OnItemSelected(R.id.list_view)
void onItemSelected(int position) {
// TODO ...
}

@OnItemSelected(value = R.id.maybe_missing, callback = NOTHING_SELECTED)
void onNothingSelected() {
// TODO ...
}