Android 浅析 ButterKnife (一) 使用

发表于   |  

前言

Linus Benedict Torvalds : RTFSC – Read The Funning Source Code

概括

Field and method binding for Android views which uses annotation processing to generate boilerplate code for you.
ButterKnife是一个用注解的方式生成公式化的代码将Android view的域和方法绑定一起的库。

使用

Step 1 gradle

1
2
3
dependencies {
    compile 'com.jakewharton:butterknife:7.0.1'
}

在Gradle中添加butterknife库。

Step 2 Bind

1
2
3
4
5
6
7
8
9
10
11
12
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...
  }
}

这段代码是帮你简化我们平常书写繁琐的findViewById()操作，在代码实际编译中的时候会自动转换成我们熟悉的代码，例子中的代码在实际编译中会生成这些代码：

1
2
3
4
5
public void bind(ExampleActivity activity) {
  activity.subtitle = (android.widget.TextView) activity.findViewById(2130968578);
  activity.footer = (android.widget.TextView) activity.findViewById(2130968579);
  activity.title = (android.widget.TextView) activity.findViewById(2130968577);
}

资源的BINDING

在对资源的Bind方法中有许多不同的注解可以用：
@BindBool, @BindColor, @BindDimen, @BindDrawable, @BindInt, @BindString
这些可以帮你在资源使用前绑定资源的id。

1
2
3
4
5
6
7
class ExampleActivity extends Activity {
  @BindString(R.string.title) String title;
  @BindDrawable(R.drawable.graphic) Drawable graphic;
  @BindColor(R.color.red) int red; // int or ColorStateList field
  @BindDimen(R.dimen.spacer) Float spacer; // int (for pixel size) or float (for exact value) field
  // ...
}

ButterKnife的简单实用方法就是这些了，非常简单，接下来我们深入的看看深入使用方法。

非Activity中使用

在非Activity中也可以同过绑定view 来实行绑定资源。

1
2
3
4
private void initFloatWinCollectPage() {
    View view = findViewById(R.id.floatwin_collectpage_layout);
    ButterKnife.bind(this, view);
}

当然这种绑定也可以用在holder这些繁琐的操作上面，在getview的函数里不断的绑定view也只需要一个操作就实现了。

批量操作

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// 方法一
@Bind({ R.id.first_name, R.id.middle_name, R.id.last_name })
List<EditText> nameViews;
// 方法二
ButterKnife.apply(nameViews, DISABLE);
ButterKnife.apply(nameViews, ENABLED, false);
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, View.ALPHA, 0.0f);
当然也可以对资源的属性进行操作了。

LISTENER 绑定

1
2
3
4
5
6
7
8
@OnClick(R.id.submit)
public void submit(View view) {
}
@OnClick(R.id.submit)
public void sayHi(Button button) {
  button.setText("Hello!");
}

通过绑定可以快速的将一个方法和控件联系在一起。

当然也可以将多个id绑定到一个方法里：

1
2
3
4
5
@OnClick({ R.id.door1, R.id.door2, R.id.door3 })
public void pickDoor(DoorView door) {
  if (door.hasPrizeBehind()) {} 
  else {}
}

BINDING RESET

在绑定取消的时候调用unbind方法
ButterKnife.unbind(this);

OPTIONAL BINDINGS

默认情况下，@Bind和监听绑定是必需的。如果目标视图不能找到一个异常将被抛出。
为了抑制这种行为，创造一个可选的绑定，添加注释@Nullable到方法最外边。
@Nullable @Bind(R.id.might_not_be_there) TextView mightNotBeThere;

总结

最后，要细看ButterKnife的代码应该直接看源码：
https://github.com/JakeWharton/butterknife