android注入之ButterKnife的使用

注入的话相信大家应该都是很熟悉的，他不仅把代码的结构简洁化，还能减少很大一部分的findviewByid的代码量 ，但是平时看到的注入都是封装在一个大的框架中的，比如xUtils，这里我们来介绍下一个独立的小框架 .jar包的下载地址 (这里说的是5.0的包)

1.配置Eclipse

在使用ButterKnife需要先配置一下Eclipse。

项目右键-Properties-Java Complier-Annotation Processing 确保设置和下图一致

接着展开Annotation Processing选择Factory Path,选中Enable project specific settings。然后点击 Add JARs…,选中ButterKnife的jar包

然后点击ok保存设置，Eclipse将问你是否重新构建新项目，点击Yes。

确保你项目的根目录里有一个.apt_generated的文件夹，文件夹中包含YOURACTIVITY$$ViewInjector.java这样的文件。

2 使用注解

2.1 在Activity中使用注解

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

  @Override public void onCreate(Bundle savedInstanceState) {
    super .onCreate(savedInstanceState);
    setContentView(R.layout.simple_activity);
    ButterKnife.inject( this );
    // TODO Use "injected" views...
  }
}

2.2 Fragment中使用注解

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

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

2.3 Adapter中使用注解

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

  static class ViewHolder {
    @InjectView(R.id.title) TextView name;
    @InjectView(R.id.job_title) TextView jobTitle;

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

2.4事件注入

点击事件注入

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

多个控件具有相同的事件

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

2.5重置注入

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

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

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

2.6 可选注入

默认情况下@InjectView和@OnClick注入是必选的，如果view未找到将出现异常。为了避免出现异常，添加一个@Optional注解。

2.7其它

ButterKnife还包含了两个findById方法。

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

3 混淆

为避免混淆的时代码被移除，所以要在proguard-project.txt中添加如下代码避免混淆

-dontwarn butterknife.internal.**
-keep class **$$ViewInjector { *; }
-keepnames class * { @butterknife.InjectView *;}

扩展阅读

Butterknife

Butterknife中文 

版本7.0.0中，现在注解已经不叫@InjectView了，而叫@Bind，感觉更贴合语义。同时注册的方式也从

ButterKnife.inject(this);

变成了

ButterKnife.bind(this);

关于7.0.0的ButterKnife的各种用法和功能，可以参考ButterKnife的github上的主页：

http://jakewharton.github.io/butterknife/

注，在windows下，某些eclipse版本无法选择 Compiler/Annotation Processing"。下面是两个版本的比较。

adt-bundle-windows-x86_64-20140702 (较新的版本，不可以)
adt-bundle-windows-x86_64-20131030 (2013年的版本，可以)

原因是谷歌在bundled版本中移除了Annotation Processing 选项，目的是为了锁定到他们自己新出的注解系统中： /extras/android/support/annotations/android-support-annotations.jar

github上的解决办法是安装如下图所示的东西：

当然换成android studio应该更好解决

可以让你在添加Butterkinfe注解时偷偷懒，直接点击几下鼠标既可以完成注解的增加，同时还是图形化的操作，可以说，大大的减轻了开发负担。尤其是当你的layout中有很多很多的view需要通过findviewbyid来获得引用时。实际上如果不用这个插件而通过手打加ButtefKnife注解的方式，要是view很多启示也挺麻烦的，不是吗？

 

首先看看如何在Android Studio上安装该插件，直接看图：

安装好后需要restart你的Android Studio。

在使用此插件前，需要已经导入了butterknife的jar（或者在build.gradle中已经加入：compile'com.jakewharton:butterknife:7.0.0'）

 

随后，在你需要导入注解的Activity或者Fragment或者ViewHolder的layout资源代码上，右击，选择 Generate 然后Generate ButterKnife Injections，这时候生成类似于下列的选择框：

Element为view的类型，ID为layout中资源的id名字，Variable Name即为你在代码中引用出来的变量名，点击Confirm后即可。

 

下面是Android ButterKnife Zelezny的github上的一个动态使用流程图：