ButterKnife-ButterKnife原理

Java注解

Java 定义了一套注解，共有 7 个，3 个在 java.lang 中，剩下 4 个在 java.lang.annotation 中。

1. 作用在代码的注解是

• @Override - 检查该方法是否是重载方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。
• @Deprecated - 标记过时方法。如果使用该方法，会报编译警告。
• @SuppressWarnings - 指示编译器去忽略注解中声明的警告。

2. 作用在其他注解的注解(或者说 元注解)是:

• @Retention - 标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问。
• @Documented - 标记这些注解是否包含在用户文档中。
• @Target - 标记这个注解应该是哪种 Java 成员。
• @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

3. 从 Java 7 开始，额外添加了 3 个注解:

• @SafeVarargs - Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
• @FunctionalInterface - Java 8 开始支持，标识一个匿名函数或函数式接口。
• @Repeatable - Java 8 开始支持，标识某注解可以在同一个声明上使用多次。

@Retention保留时间：有三类值可以选择，SOURCE RUNTIME CLASS。

• SOURCE 源码时保留：使用此类的注解多为标记注解，比如 @Override、@Deprecated、@SuppressWarnings 等。
• RUNTIME 运行时保留：程序在运行过程中，使用这些 Annotation, 比如我们常用的 @Test。
• CLASS 编译时保留：Java 文件在编译时由 apt 自动解析，需要自定义类继承自 AbstractProcessor 并重写 Process 函数。比如 ButterKnife 中使用的 @BindView, @OnClick 等就是声明为 CLASS 的。

ButterKnifeProcessor

之前，在项目中加入ButterKnife的时候，我们在build.gradle中添加过两行代码，其中有一行为：

annotationProcessor 'com.jakewharton:butterknife-compiler:10.1.0'

其实这一行的作用就是注册了一个注解处理器，在注册完处理器之后，ART就会在编译源码时，调用注册过的处理器。

注：APT（Annotation processing tool）是在编译时，扫描和处理注解的一个构建工具，可以在编译源代码时额外生成 Java 源代码。

所以当 java 文件进行编译时，ButterKnifeProcessor 的 process() 方法被调用，该方法会查找所有ButterKnife的注解，生成相关的 ViewBinder 类，用于将 View 或者 Listener 进行绑定。process方法代码如下：

@Override public boolean process(Set<? extends TypeElement> elements, RoundEnvironment env) {
    
    // 查找并解析注解
    Map<TypeElement, BindingClass> targetClassMap = findAndParseTargets(env);
    
    // 去除注解的键值
    for (Map.Entry<TypeElement, BindingClass> entry : targetClassMap.entrySet()) {
      TypeElement typeElement = entry.getKey();
      BindingClass bindingClass = entry.getValue();

    // 生成源代码
      try {
        bindingClass.brewJava().writeTo(filer);
      } catch (IOException e) {
        error(typeElement, "Unable to write view binder for type %s: %s", typeElement,
            e.getMessage());
      }
    }
  return true;
}

ViewBinder

位置：D:\MyFlutter\ButterKnife\app\build\generated\source\apt\debug\com\echo\butterknife，根据具体项目而定。
Activity代码如下：

public class MainActivity extends AppCompatActivity {

    @BindView(R.id.text_view)
    TextView mTextView;

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

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

对应的ViewBinder 如下：

public class MainActivity_ViewBinding implements Unbinder {
  private MainActivity target;

  @UiThread
  public MainActivity_ViewBinding(MainActivity target) {
    this(target, target.getWindow().getDecorView());
  }

  @UiThread
  public MainActivity_ViewBinding(MainActivity target, View source) {
    this.target = target;

    target.mTextView = Utils.findRequiredViewAsType(source, R.id.text_view, "field 'mTextView'", TextView.class);
  }

  @Override
  @CallSuper
  public void unbind() {
    MainActivity target = this.target;
    if (target == null) throw new IllegalStateException("Bindings already cleared.");
    this.target = null;

    target.mTextView = null;
  }
}

其中，target.mTextView = Utils.findRequiredViewAsType(source, R.id.text_view, "field 'mTextView'", TextView.class)注入了这一个View对象。
可以看出，使用ButterKnife本质上还是findViewById()的方式，而不是利用反射。

绑定

 ButterKnife.bind(MainActivity.this);

其实就是调用了对应ViewBinder的方法。