编译时注解解析及访问者模式的使用

访问者模式概述

访问者模式是一种将数据操作与数据结构分离的设计模式，它的使用频率不高，但是在aop的开发中，经常会遇到。

设计思想：

软件系统中拥有一个由许多对象构成的、比较稳定的对象结构，这些对象的类都拥有一个accept方法用来接收访问者对象的访问。访问者是一个接口，它拥有一个visit方法，这个方法对访问到的对象结构中不同类型的元素做出不同的处理。在对象的一次访问中，我们遍历整个对象结构，对每一个元素都实施accept方法，在每个元素的accept方法中会调用访问者的visit方法，从而访问者得以处理对象结构的每一个元素，我们可以针对对象结构设计不同的访问者来完成不同的操作，达到区别对待的效果。

使用场景：

对象结构比较稳定，但经常需要在此对象结构上定义新的操作。
需要对一个对象结构中的对象进行很多不同的并且不相关的操作，而需要避免这些操作‘污染’这些对象的类，也不希望在增加新操作时修改这些类。

编译时注解

在Android开发中，注解使用越来越频繁，按照处理时期，可以分为运行时注解和编译时注解。运行时注解由于性能问题被诟病（使用反射导致性能问题），编译时注解的核心原理依赖APT（Annotation Processing Tools）实现，Dagger、ARouter、ButterKnife等都是基于此。编译器注解是如何使用访问者模式的呢？

编译时注解的原理：

在某些代码元素（类型、函数、字段）添加注解，在编译时，编译器会检查AbstractProcessor的子类，并且调用该类型的process方法，然后将添加了注解的所有元素都传递到process方法中，这样开发人员可以在编译期进行相应的处理，比如：可以根据注解生成新的java类或者直接对代码元素进行加工处理。

在编译期处理的时候，是分开进行的。如果在某个处理中产生了新的java源文件，那么就需要另外一个处理来处理新生成的源文件，如此循环，知道没有新文件被生成为止。处理完成之后，再对java代码进行编译。

如图所示：将java源文件编译成class文件，大体要分为三步：

将全部的源码解析成语法树，输入到编译器的符号表中
注解处理器处理注解的过程
分析语法树并生成字节码

Parse and Enter: 词法分析：经过Scanner将源码的字符流解析成Token流

语法分析：根据token流，利用treemaker，以JCTree的子类作为语法节点来构建抽象语法树（AST）。

将java类中的符号输入到符号表中：符号表是由一组符号和符号信息构成的表格，在语法分析中，符号表所登记的内容将用于语义检查和产生中间代码。在目标代码生成阶段，符号表是对符号名进行地址分配的依据。

AST（Abstract Syntax Tree）：是一种用来描述程序代码语法结构的树形表示方式，语法树的每个节点，都表明程序代码中的一个语法结构，如包、类型、修饰符、运算符、接口、返回值均可以是一个语法结构。

Annotation Processing java提供了一组插入式注解处理器的标准API在编译期间对注解进行处理；在注解处理期间可以获取到全部的抽象语法树，能够对抽象语法树进行修改，语法树被修改以后，编译器将回到解析以及填充符号表的过程从新处理，直到全部插入式注解处理器都没有再对语法树进行修改为止。
Analyse And Generte 语义分析：主要任务是对结构正确的源程序进行上下文有关性质的审核。

解语法糖：还原简单的基础语法结构

生成字节码：将前面各个步骤所生成的信息（语法树、符号表）转化为字节码，输出到class文件中。

Mirror API和Element代码元素

APT是一个命令行工具，与之配套的还有一套用来描述程序语义结构的Mirror API,Mirror API(com.sun.mirror.*) 描述的是程序在编译时的静态结构，通过Mirror API可以获取到被注解的Java类型元素的信息，从而提供相应的处理逻辑，具体的处理工作交给APT工具来完成。

对于编译器来说，代码中的元素结构是基本不变的，例如，组成代码的基本元素有包、类、函数、字段、类型参数、变量等，JDK中为这些元素定义了一个基类，Element类，它有以下几个子类

PackageElement：包元素，包含了某个包下的信息，可以获取到包名等
TypeElement：类型元素，如某个字段属于某种类型
ExecutableElement：可执行元素，代表了函数类型的元素
VariableElement：变量元素
TypeParameterElement：类型参数元素

public interface Element extends AnnotatedConstruct {
    //获取元素类型
    ElementKind getKind();
    //获取修饰符（public、static、final等）
    Set<Modifier> getModifiers();
    
    ...
    //接收访问者的访问
    <R, P> R accept(ElementVisitor<R, P> visitor, P p);
}

Element定义了一个代码元素的通用接口，关注一下accept()函数，接收一个ElementVisitor和类型为P的参数，ElementVisitor就是访问者类型，P则用于传递一些额外的参数给Visitor。

看一下ElementVisitor:

public interface ElementVisitor<R, P> {
    //访问元素
    R visit(Element var1, P var2);
    //访问包元素
    R visitPackage(PackageElement var1, P var2);
    //访问类型元素
    R visitType(TypeElement var1, P var2);
    //访问变量元素
    R visitVariable(VariableElement var1, P var2);
    //访问可执行元素
    R visitExecutable(ExecutableElement var1, P var2);
    //访问参数元素
    R visitTypeParameter(TypeParameterElement var1, P var2);
    //处理未知元素类型
    R visitUnknown(Element var1, P var2);

ElementVisitor中定义了多个visit接口函数，每个函数处理一种元素类型，这就是典型的访问者模式。

一个类元素和函数元素是完全不一样的，他们的结构不一样，因此，编译器对他们的操作肯定是不一样的，通过访问者模式正好可以解决数据结构与数据操作分离的问题，避免某些操作‘污染’数据对象类。

当Visitor对元素结构进行访问时，就可以针对不同的类型进行不同的处理

结语

编译器将代码抽象成一个代码元素树，然后在编译时对整棵树进行遍历访问，每个元素都有一个accept方法接收访问者的访问，每个访问者中有对应的visit函数，在每个visit方法中对不同的类型进行不同的处理，这样就达到了差异处理的效果，同时将数据结构和数据操作分离，使得每个类型的职责更加单一。