ButterKnife源码初探

Butterknife是一个Android View注入框架，配合Android ButterKnife Zelezny插件能够快速的完成View的初始化操作。相比较之前findViewById()方式来获取view的方式，它不仅简洁了代码，提高了编码效率，而且还避免了大量的强转。本文基于ButterKnife7.0.1版本进行分析。

1，ButterKnife的引入和使用

build.gradle文件下添加butterknife的依赖

dependencies {
    implementation'com.jakewharton:butterknife:7.0.1'
    annotationProcessor 'com.jakewharton:butterknife:7.0.1'
}

需要注意的是我使用的是Android Studio 3.0.1版本，如果你是3.0以下依赖写法不一致，你只需要使用compile'com.jakewharton:butterknife:7.0.1'来添加依赖。

添加完依赖之后，我们来看看ButterKnife的使用

public class MainActivity extends AppCompatActivity {

    @Bind(R.id.show_tip_txt)
    TextView showTipTxt;
    @Bind(R.id.butter_knife_btn)
    Button butterKnifeBtn;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ButterKnife.bind(this);
    }

    @OnClick({R.id.butter_knife_btn})
    void butterBtn(){
        Toast.makeText(this,"点击了我",Toast.LENGTH_LONG).show();
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        ButterKnife.unbind(this);
    }
}

在这里我们看到，ButterKnife.bind(this)需要在setContentView()方法后面，并且@Bind的参数不能用private和static修饰，具体原因后面有分析，ButterKnife是通过@Bind是用来绑定View的Id的，此外它还提供了更多的绑定方法提供给我们，如：BindBool,BindColor,BindDimen,BindDrawable,BindInt,BindString,OnClick等。在这里就不一一的介绍了，读者感兴趣的话，可自行实验。
上面的绑定View在Activity中的使用，其实ButterKnife不仅仅可以在Activity中使用，还可以在View，Dialog中使用，我们看看ButterKnife文件中的定义。

public enum Finder {
    VIEW {
      @Override protected View findView(Object source, int id) {
        return ((View) source).findViewById(id);
      }

      @Override public Context getContext(Object source) {
        return ((View) source).getContext();
      }
    },
    ACTIVITY {
      @Override protected View findView(Object source, int id) {
        return ((Activity) source).findViewById(id);
      }

      @Override public Context getContext(Object source) {
        return (Activity) source;
      }
    },
    DIALOG {
      @Override protected View findView(Object source, int id) {
        return ((Dialog) source).findViewById(id);
      }

      @Override public Context getContext(Object source) {
        return ((Dialog) source).getContext();
      }
    };
    private static  T[] filterNull(T[] views) {
      int end = 0;
      for (int i = 0; i < views.length; i++) {
        T view = views[i];
        if (view != null) {
          views[end++] = view;
        }
      }
      return Arrays.copyOfRange(views, 0, end);
    }

当然在我们不需要的时候，我们还需要解绑操作

 @Override
    protected void onDestroy() {
        super.onDestroy();
        ButterKnife.unbind(this);
    }

2，ButterKnife执行原理

通过上面我们了解到ButterKnife是通过@Bind来绑定View的，先来看看Bind的定义

/**
 * Bind a field to the view for the specified ID. The view will automatically be cast to the field
 * type.
 * 

 * {@literal @}Bind(R.id.title) TextView title;
 * 
 */
@Retention(CLASS) @Target(FIELD)
public @interface Bind {
  /** View ID to which the field will be bound. */
  int[] value();
}

Bind是一个是自定义的annotation文件，需要注意一下它和接口文件的区别：一个@interface ，另外一个interface。
我们先看看Bind上的注解@Rentention，@Target：
@Retention:对Annotation的“生命周期”限制，代表有效期
RetentionPolicy.SOURCE，在源文件中有效
RetentionPolicy.CLASS，在Class文件中有效
RetentionPolicy.RUNTIME，在运行时有效

@Target:规定自定义Annotation所修饰的对象范围
ElementType.CONSTRUCTOR，构造器声明
ElementType.FIELD，成员变量、对象、属性（包括enum实例）
ElementType.LOCAL_VARIABLE，局部变量声明
ElementType.METHOD，方法声明
ElementType.PACKAGE，包声明
ElementType.PARAMETER，参数声明
ElementType.TYPE，类、接口（包括注解类型）或enum声明
默认不设置@Target表示修饰所有。

当你在Build项目工程的时候，
ButterKnife使用了Annotion Processing(注解处理)，因此在编译的时候，Annotation会由APT(Annotation Processing Tool)解析。ButterKnife工程中ButterKnifeProcessor类的process()方法会执行以下操作：
A，扫描Java代码中所有的ButterKnife注解@Bind，@OnClick等；
B，当有扫描到为ButterKnife注解的时候，ButterKnifeProcessor会自动生成一个实现了ViewBinder接口的XX$$ViewBinder的java文件，
C，在生成的ViewBinder中，包含了该类所有注解对于的实现，如@Bind会处理成findViewById，@OnClick处理成setOnClickListener等；

在运行代码的时候，遇到ButterKnife.bind()的时候，Butterknife会加载在编译期生成的ViewBinder类，并调用对应的注解如，@Bind等；
在取消注解的时候，会调用到ViewBinder的unbind方法。

public class MainActivity$$ViewBinder implements ViewBinder {
  @Override public void bind(final Finder finder, final T target, Object source) {
    View view;
    view = finder.findRequiredView(source, 2131165287, "field 'showTipTxt'");
    target.showTipTxt = finder.castView(view, 2131165287, "field 'showTipTxt'");
    view = finder.findRequiredView(source, 2131165219, "field 'butterKnifeBtn' and method 'butterBtn'");
    target.butterKnifeBtn = finder.castView(view, 2131165219, "field 'butterKnifeBtn'");
    view.setOnClickListener(
      new butterknife.internal.DebouncingOnClickListener() {
        @Override public void doClick(
          android.view.View p0
        ) {
          target.butterBtn();
        }
      });
  }

  @Override public void unbind(T target) {
    target.showTipTxt = null;
    target.butterKnifeBtn = null;
  }
}

3，ButterKnife 源码解析

既然View是通过ButterKnife.bind(this)方法来加载ViewBinder类，并调用对应注解的，那我们先看bind(this)方法：

 public static void bind(Activity target) {
    bind(target, target, Finder.ACTIVITY);
  }

static void bind(Object target, Object source, Finder finder) {
    Class targetClass = target.getClass();
    try {
      if (debug) Log.d(TAG, "Looking up view binder for " + targetClass.getName());
      ViewBinder