注解库, JakeWharton大神的杰作

Note:文章基于8.5.1版本,不同的版本之间用法可能会稍有差异,实际版本使用以官方文档为主

项目地址:https://github.com/JakeWharton/butterknife
文档地址:http://jakewharton.github.io/butterknife/

有什么用?

初始化View,资源,绑定View事件.不用去写findViewById(...), setOn...Listener(...),只需要加上一行注解,配合Studio插件:Android ButterKnife Zelezny,自动生成View注解, 大爱

怎么用?

• 引入ButterKnife
• 添加/声明对应的注解

引入ButterKnife

在早期版本引入只需要一行代码,后来库的分拆,增加,优化,使得稍显麻烦.新手上手时,动不动会整出个空指针很正常.只需要注意区分项目的build.gradle,主程序的Module的build.gradle,依赖Module的Build.gradle:

• 项目的build.gradle:在项目的根目录下
• 主程序的build.gradle:通常是一个名为app Module下的build.gradle,文件第一行是:apply plugin: 'com.android.application',这名代码的意思是用来声明这个Module是主程序Module
• 依赖Module的build.gradle:一个项目通常只有一个主程序Module,其它的就是依赖Module,当然,是可以建多个主程序Module的,文件第一行代码是:apply plugin: 'com.android.library',用来声明这是一个依赖Module

在Module的build.gradle中添加
如果你要在哪个Module中使用,就不需要在哪个Module中添加

dependencies {
  compile 'com.jakewharton:butterknife:8.5.1'
  annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1'
}

在项目的build.gradle中添加

buildscript {
  repositories {
     mavenCentral()
  }
  dependencies {
    classpath 'com.jakewharton:butterknife-gradle-plugin:8.5.1'
  }
}

在主程序依赖Module的build.gradle中添加

apply plugin: 'com.android.library'
apply plugin: 'com.jakewharton.butterknife'

Note:在依赖Module中使用,声明注解时用R2替代R, Like this

class ExampleActivity extends Activity {
  @BindView(R2.id.user) EditText username;
  @BindView(R2.id.pass) EditText password;
  ...
}

添加/声明对应的注解

在Activity中绑定View

class ExampleActivity extends Activity {
  @BindView(R.id.title) TextView title;
  @BindView(R.id.subtitle) TextView subtitle;
  @BindView(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...
  }
}

只要在TextView title;加了@BindView(R.id.title),这个title就和布局simple_activity.xm中的id为title的TextView控件绑定了,并且帮你实例化了,就可以直接用它的相关方法:title.setXxx(..)之类.相当于帮你写了,title = (TextView)this.findViewById(R.id.title);这段代码,实际上在build项目的时候它就去生成了包含这样代码的文件,目录:项目名->Module名->build->generated->source->apt->debug->对应的包名下一些XXX$$ViewBinder的类,代码大致如下:

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

资源文件绑定

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
  // ...
}

在非Activity中呢

在Activity中使用的是:ButterKnife.bind(this);
有非Activity中则是使用:ButterKnife.bind(this, view);
Fragment中使用

public class FancyFragment extends Fragment {
  @BindView(R.id.button1) Button button1;
  @BindView(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;
  }
}

在Adapter的ViewHolder中使用

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 {
    @BindView(R.id.title) TextView name;
    @BindView(R.id.job_title) TextView jobTitle;

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

View列表

你可以一次性将多个views绑定到一个List或数组中：

@BindViews({ 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);

实现ButterKnife.Action或ButterKnife.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);
  }
};

apply函数还提供设置View属性的方法:

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

支持的属性大概如下:

• ALPHA - 透明度
• TRANSLATION_X - 平移(相对于自身控件)
• TRANSLATION_Y
• TRANSLATION_Z
• X - 平移(相对于父控件)
• Y
• Z
• ROTATION - 角度
• ROTATION_X
• ROTATION_Y
• SCALE_X - 缩放
• SCALE_Y

上面说的大多是基于View控件,资源的绑定,看下源代码这个版本大概就下面这些:

• BindArray
• BindBitmap
• BindBool
• BindDimen
• BindDrawable
• BindInt
• BindString
• BindView
• BindViews

基于事件的绑定

给一个id设置OnClick事件,不用写xxx.setOnClickListener(...)了:

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

方法名是自己定义的,没有过多要求,参数中的View也是可选的,可以加,可以不加:

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

还可以为回调中的View加上指定的类型,但不要乱来,本来是个Button,非要写个TextView,Like this:

@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!
  }
}

控件事件的绑定列表大致如下:

• OnCheckedChanged
• OnClick
• OnEditorAction
• OnFocusChange
• OnItemClick
• OnItemLongClick
• OnItemSelected
• OnLongClick
• OnPageChange
• OnTextChanged
• OnTouch

解绑

上面的内容一直在说绑定绑定绑定,ButterKnife.bind(this);是有返回值的,返回一个Unbinder对象,你需要在合适的生命周期里去解绑,调用它的unbind()函数,比如,Activity中的onDestroy方法,Fragment的onDestroyView方法

public class FancyFragment extends Fragment {
  @BindView(R.id.button1) Button button1;
  @BindView(R.id.button2) Button button2;
  private Unbinder unbinder;

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

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

可选的绑定

情况是这样的:上面说的绑定View,绑定资源,绑定事件,如果绑定的目标id没有找到,这时候ButterKnife就会抛出异常,为了�抑制这种情况的发生,可以使用Android自带注解库中的@Nullable来添加到Field上,和ButterKnife中的@Optional添加到Method上

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

@Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {
  // TODO ...
}

最后

Butter Knife提供了一个findViewById的简化代码:findById,用这个方法可以在View,Activity和Dialog中找到想要View,而且,该方法使用的泛型来对返回值进行转换,也就是说,你可以省去findViewById前面的强制转换了.强迫症的福因:

View view = LayoutInflater.from(context).inflate(R.layout.thing, null);
TextView firstName = ButterKnife.findById(view, R.id.first_name);
TextView lastName = ButterKnife.findById(view, R.id.last_name);
ImageView photo = ButterKnife.findById(view, R.id.photo);