编译时注解 - ButterKnife源码分析和手写

大学刚出来实习那会，自己写了一个运行时的 ViewById 和 OnClick 注解，用来解决 findViewById 和 setOnClickListener 。其实也是参考 xUtils 的源码，后来加了很多的功能扩展，如网络检测等等。关键是那时 xUtils 并没有插件，自己学着写了插件。这个在外包公司能省不少事，技术总监开会说谁谁怎么怎么样，大家要像他学习啊。工资一下涨了不少，装 B 的技能瞬间提升了一个档次。隔年回学校拿了毕业证，公司就关门了，这是干垮的第一家。

后来 ButterKnife 火了，相信很多人都用过，说什么没有用反射，而且自带插件也不要写代码。我第一反应是蒙的，很好奇不用反射也行？这么厉害。今天我就带大家来了解一下 ButterKnife 的源码，自己动手去写，相信这样会有更深层次的理解，自己手写不代表我们重复去造轮子。也不是没事干，而是知识是用来唤醒智慧的，我们可以把这些知识用到其他地方，比如我们绕过微信支付的局限性，自动读取生成配置代码等等。从源码中汲取营养，这个还是蛮重要。

1. ButterKnife 原理分析

分析源码之前我们首先要会使用，这里就不做详细介绍，如果不太会的哥们可以去看看别人的文章。网上也有很多分析源码的文章，都可以看看，我其实也是看了很多这方面的文章。找到 github 地址，都有教我们怎么使用。当我们点击运行的时候，仔细找找我们能找到这么一些代码：

// Generated code from Butter Knife. Do not modify!
package com.darren.architect_day05;

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.textView1 = Utils.findRequiredViewAsType(source, R.id.tv1, "field 'textView1'", TextView.class);
    target.textView2 = Utils.findRequiredViewAsType(source, R.id.tv2, "field 'textView2'", TextView.class);
  }

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

    target.textView1 = null;
    target.textView2 = null;
  }
}

看到这里我想很多人都应该懂了，其实当我们每次点击运行的时候， 都会去扫描运行时的注解，然后自动生成这么一个类，是自动生成的不是我们自己写的。规则大概就像上面这样，xxx_ViewBinding 作为类名，实现 Unbinder 在 xxx_ViewBinding 的构造函数里面去 findViewById 或者 setOnclickListener。我们只要在 MainActivity 中去实例化一个 MainActivity_ViewBinding 对象，那么我们 MainActivity 里面的所有属性就都会被赋值了。这个目前来看完全没有涉及到任何反射，那么我们只需要去了解怎么生成代码岂不就行了。我们按照这个思路，自己动手来写一个 ButterKnife 。

2. apt 生成代码

怎么自动生成代码，这个其实在 thinking in java 这本书中有提到，这个属于 mirror 板块的知识。实在不行嘞，我们可以参考 ButterKnife 的写法。我们新建一个 Java 工程，注意一定要是一个 Java 工程，否则待会有可能找不到类。

新建 ButterKnifeProcessor 继承 AbstractProcessor

@AutoService(Processor.class)
public class ButterKnifeProcessor extends AbstractProcessor {

    /**
     * 用来指定支持的 AnnotationTypes
     *
     * @return
     */
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> types = new LinkedHashSet<>();
        for (Class<? extends Annotation> annotation : getSupportedAnnotations()) {
            types.add(annotation.getCanonicalName());
        }
        return types;
    }

    /**
     * 参考了 ButterKnife 的写法
     *
     * @return
     */
    private Set<Class<? extends Annotation>> getSupportedAnnotations() {
        Set<Class<? extends Annotation>> annotations = new LinkedHashSet<>();
        annotations.add(BindView.class);
        return annotations;
    }

    /**
     * 用来指定支持的 SourceVersion
     *
     * @return
     */
    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        // 调试打印
        System.out.println("------------------------------------>");
        System.out.println("------------------------------------>");
        return false;
    }
}

上面就这么简单，点击运行apk，如果你能看到下面这个打印，代表配置这方面是没有问题的，如果没有看到任何打印，说明没起作用，要先找找问题：

如果我们在代码的任何地方有注解，都会来到 process 这个方法里面，我们只要在这个方法里面生成代码就可以了，至于注解反射泛型的基础知识这个之前讲过，这里就不做详细的介绍。

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        // 调试打印
        // System.out.println("------------------------------------>");
        // System.out.println("------------------------------------>");

        Set<? extends Element> bindViewElements = roundEnvironment.getElementsAnnotatedWith(BindView.class);

        // 解析 Element
        Map<Element, List<Element>> analysisElementMap = new LinkedHashMap<>();
        for (Element bindViewElement : bindViewElements) {
            Element enclosingElement = bindViewElement.getEnclosingElement();

            List<Element> elements = analysisElementMap.get(enclosingElement);
            if (elements == null) {
                elements = new ArrayList<>();
                analysisElementMap.put(enclosingElement, elements);
            }

            elements.add(bindViewElement);
        }

        // 生成 java 类
        for (Map.Entry<Element, List<Element>> entry : analysisElementMap.entrySet()) {
            Element enclosingElement = entry.getKey();
            List<Element> elements = entry.getValue();

            String classNameStr = enclosingElement.getSimpleName().toString();

            ClassName unbinderClassName = ClassName.get("com.butterknife", "Unbinder");
            // 组装类:  xxx_ViewBinding implements Unbinder
            TypeSpec.Builder typeSpecBuilder = TypeSpec.classBuilder(classNameStr + "_ViewBinding")
                    .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
                    .addSuperinterface(unbinderClassName);

            ClassName callSuperClassName = ClassName.get("android.support.annotation", "CallSuper");
            // 组装unbind 方法
            MethodSpec.Builder unbindMethodBuilder = MethodSpec.methodBuilder("unbind")
                    .addAnnotation(Override.class)
                    .addAnnotation(callSuperClassName)
                    .addModifiers(Modifier.PUBLIC)
                    .returns(TypeName.VOID);

            ClassName uiThreadClassName = ClassName.get("android.support.annotation", "UiThread");
            ClassName parameterClassName = ClassName.bestGuess(classNameStr);
            // 组装构造函数: public xxx_ViewBinding(xxx target)
            MethodSpec.Builder constructorBuilder = MethodSpec.constructorBuilder()
                    .addAnnotation(uiThreadClassName)
                    .addModifiers(Modifier.PUBLIC)
                    .addParameter(parameterClassName, "target");

            // 添加 target.textView1 = Utils.findViewById(target,R.id.tv1);
            for (Element bindViewElement : elements) {
                String filedName = bindViewElement.getSimpleName().toString();
                ClassName utilClassName = ClassName.get("com.butterknife", "Utils");
                int resId = bindViewElement.getAnnotation(BindView.class).value();
                constructorBuilder.addStatement("target.$L = $T.findViewById(target,$L)",
                        filedName, utilClassName, resId);
            }

            typeSpecBuilder.addMethod(constructorBuilder.build());
            typeSpecBuilder.addMethod(unbindMethodBuilder.build());

            try {
                // 写入生成 java 类
                String packageName = mElementUtils.getPackageOf(enclosingElement).getQualifiedName().toString();
                JavaFile.builder(packageName, typeSpecBuilder.build())
                        .addFileComment("ButterKnife自动生成")
                        .build().writeTo(mFiler);
            } catch (IOException e) {
                e.printStackTrace();
                System.out.println("翻车了");
            }
        }

        return false;
    }

最后我们看下生成的类文件，下一篇将利用编译时注解的知识点，生成代码，解决掉我们开发过程中的一些棘手问题。

所有分享大纲：Android进阶之旅 - 系统架构篇

视频讲解地址：周六晚八点