Android ButterKnife使用

该框架是一个绑定注解的框架，能够简化安卓中findViewById（）和设置监听器等代码，简单实用，可参考官网链接：http://jakewharton.github.io/butterknife/

但愿你们多多交流学习，让安卓开发更加方便

注意 ：目前butterknife的版本已经升级，新版本的使用方式和旧版本有所区别，请你们看好本身所使用的butterknife版本吧

简介：

使用 @Bind注解并传入一个View ID，Butter Knife 就能够找到而且自动地对你的布局中的View进行转换并绑定到类成员上。

classExampleActivityextendsActivity {@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...
  }
}

相比与缓慢的反射机制，Butter Knife的代码是生成的，所以没必要担忧注解的性能问题。调用bind来生成这些代码，你能够查看或调试这些代码。

资源绑定

绑定资源到类成员上可使用@BindBool、@BindColor、@BindDimen、@BindDrawable、@BindInt、@BindString。使用时对应的注解须要传入对应的id资源，例如@BindString你须要传入R.string.id_string的字符串的资源id。

classExampleActivityextendsActivity {@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中使用绑定

Butter Knife提供了bind的几个重载，只要传入根布局，即可以在任何对象中使用注解绑定。

 

public classFancyFragmentextendsFragment {@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;
  }
}

在ListView的Adapter中，咱们经常会使用ViewHolder：

static classViewHolder {@Bind(R.id.title) TextView name;
    @Bind(R.id.job_title) TextView jobTitle;

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

 

提供的其余绑定API:

• 使用Activity在任意对象中进行绑定。若是你使用了相似MVC的编程模式，你可使用ButterKnife.bind(this, activity)在Controller中进行绑定

• 使用ButterKnife.bind(this)绑定一个布局的子布局到变量上。若是你在布局中使用了<merge>标签而且在自定义的控件构造时inflate这个布局，你能够在inflate以后当即调用它。或者，你能够在onFinishInflate()回调中使用它。

 

View 列表

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

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

使用这种绑定时，你可使用apple函数。该函数至关于将在这个列表中每个元素上进行调用：

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

而Action和Setter接口可以让你指定一些简单的动做：

staticfinal ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
  @Overridepublicvoidapply(View view, int index){
    view.setEnabled(false);
  }
};
staticfinal ButterKnife.Setter<View, Boolean> ENABLED = new ButterKnife.Setter<View, Boolean>() {
  @Overridepublicvoidset(View view, Boolean value, int index){
    view.setEnabled(value);
  }
};

Android的Property也可使用到apple方法中：

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

监听器绑定

在Butter Knife中，监听器也自动地配置到方法上：

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

监听器全部的参数都是可选的：

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

定义一个其余的类型，Butter Knife也能识别：

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

同时指定多个id的控件到同一个事件监听上：

@OnClick({ R.id.door1, R.id.door2, R.id.door3 })
publicvoidpickDoor(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 classFancyButtonextendsButton {@OnClick
  public void onClick() {
    // TODO do something!
  }
}

Fragment绑定注意:

Fragment的生命周期与Activity不一样。在Fragment中，咱们可能会在onCreateView中绑定一个布局，并在onDestroyView中设置全部view为null.此时，你就须要Butter Knife提供的undind函数来作此事。

public classFancyFragmentextendsFragment {@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;
  }

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

对于包含多个方法的监听器

当一个监听器包含多个回调函数时，使用方法注入可以对其中任何一个函数进行绑定。每个注解都会绑定到一个默认的回调。固然，你也能够指定callback参数：

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

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

简单的findViewById

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

若是你只是使用这个方法，可使用静态引入ButterKnife.findById。

使用

Butter Knife的代码和例子均可以在GitHub上找到：Butter Knife GitHub

查看Butter Knife的API文档如今也能够查看：Butter Knife Javadoc

MAVEN

声明如下依赖库：

<dependency>
  <groupId>com.jakewharton</groupId>
  <artifactId>butterknife</artifactId>
  <version>(insert latest version)</version>
</dependency>

GRADLE

我在android studio 2.2中添加这个库的时候也报了Error:Could not find com.android.support:support-annotations:24.1.0.这个错误，但愿找到解决方法的同窗指出。

compile 'com.jakewharton:butterknife:(insert latest version)'

注意在build.gradle中取消lint的以下警告：

lintOptions {
  disable 'InvalidPackage'
}

你也有可能须要以下配置：

packagingOptions {
  exclude 'META-INF/services/javax.annotation.processing.Processor'
}

ProGuard

Butter Knife使用动态生成的代码，这可能使ProGuard认为这些代码是无用的。为了不这些代码被混淆，你能够添加以下代码到你的ProGuard中：

-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }

-keepclasseswithmembernames class * {
    @butterknife.* <fields>;
}

-keepclasseswithmembernames class * {
    @butterknife.* <methods>;
}

 

详情查看原文章：http://www.jianshu.com/p/9ad21e548b69