【无标题】

以前在工作中也用到过Lombok，但是对其原理不了解。Lombok真是个让人又爱又恨的插件，它可以让程序员优雅的实现getter、setter、toString和构造方法等方法，使代码更加精简，但是因为没安装插件或者插件版本问题导致项目报错。
今天正好看到一篇文章，讲解了一下Lombok的基本原理。于是跟着手敲了一遍代码加深学习印象，中间也遇到一些问题。
Lombok的原理简单一句话来讲，就是在*.java文件编译成*.class字节码文件过程中的注解处理阶段，给对应的字节码文件添加需要生成的方法。具体的实现原理文末参考文章中写的挺详细。

编写代码
下面开始编码，首先要新建一个注解，指定其作用目标和保留策略。

@Retention(RetentionPolicy.SOURCE)//只保留在源代码 ，编译期或运行期擦除
@Target(ElementType.TYPE)//修饰类
public @interface MyData {
}

我的这个@MySetter注解让其作用在类上，并且在编译后不保留。
Java Annotation对应的 Retention 有3种，在 RetentionPolicy 中定义，有3种：

SOURCE 注解保留在源代码中，但是编译的时候会被编译器所丢弃。比如@Override， @SuppressWarnings；
CLASS 这是默认的 policy。注解会被保留在 class 文件中，但是在运行时期间就不会识别这个注解；
RUNTIME 注解会被保留在 class 文件中，同时运行时期间也会被识别。所以可以使用反射机制获取注解信息。比如 @Deprecated。
关于RetentionPolicy更多详细介绍

在写完这个注解后，要实现一个自定义的注解处理器。这个处理器要继承AbstractProcessor类，并且要重写其中的init()和process()方法。抽象类中已经有了init()方法的一个默认实现，这里要在其基础上扩展。
package cn.mucang.demo_lombok;

import com.sun.source.tree.Tree;
import com.sun.tools.javac.api.JavacTrees;
import com.sun.tools.javac.code.Flags;
import com.sun.tools.javac.code.Type;
import com.sun.tools.javac.processing.JavacProcessingEnvironment;
import com.sun.tools.javac.tree.JCTree;
import com.sun.tools.javac.tree.TreeMaker;
import com.sun.tools.javac.tree.TreeTranslator;
import com.sun.tools.javac.util.*;

import javax.annotation.processing.*;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic;
import java.util.Set;

@SupportedSourceVersion(SourceVersion.RELEASE_8)
@SupportedAnnotationTypes(“cn.mucang.demo_lombok.MyData”)
public class MyDataProcessor extends AbstractProcessor {

private Messager messager; // 编译时期输入日志的
private JavacTrees javacTrees; // 提供了待处理的抽象语法树
private TreeMaker treeMaker; // 封装了创建AST节点的一些方法
private Names names; // 提供了创建标识符的方法

@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
    super.init(processingEnv);
    this.messager = processingEnv.getMessager();
    this.javacTrees = JavacTrees.instance(processingEnv);
    Context context = ((JavacProcessingEnvironment) processingEnv).getContext();
    this.treeMaker = TreeMaker.instance(context);
    this.names = Names.instance(context);
}

@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
    Set<? extends Element> elementsAnnotatedWith = roundEnv.getElementsAnnotatedWith(MyData.class);
    elementsAnnotatedWith.forEach(e -> {
        JCTree tree = javacTrees.getTree(e);
        tree.accept(new TreeTranslator() {
            @Override
            public void visitClassDef(JCTree.JCClassDecl jcClassDecl) {
                List<JCTree.JCVariableDecl> jcVariableDeclList = List.nil();
                // 在抽象树中找出所有的变量
                for (JCTree jcTree : jcClassDecl.defs) {
                    if (jcTree.getKind().equals(Tree.Kind.VARIABLE)) {
                        JCTree.JCVariableDecl jcVariableDecl = (JCTree.JCVariableDecl) jcTree;
                        jcVariableDeclList = jcVariableDeclList.append(jcVariableDecl);
                    }
                }
                // 对于变量进行生成方法的操作
                jcVariableDeclList.forEach(jcVariableDecl -> {
                    messager.printMessage(Diagnostic.Kind.NOTE, jcVariableDecl.getName() + " has been processed");
                    jcClassDecl.defs = jcClassDecl.defs.prepend(makeGetterMethodDecl(jcVariableDecl));
                });
                super.visitClassDef(jcClassDecl);
            }
        });
    });
    return true;
}

private JCTree.JCMethodDecl makeGetterMethodDecl(JCTree.JCVariableDecl jcVariableDecl) {
    ListBuffer<JCTree.JCStatement> statements = new ListBuffer<>();
    // 生成表达式 例如 this.a = a;
    JCTree.JCExpressionStatement aThis = makeAssignment(treeMaker.Select(treeMaker.Ident(
            names.fromString("this")), jcVariableDecl.getName()), treeMaker.Ident(jcVariableDecl.getName()));
    statements.append(aThis);
    JCTree.JCBlock block = treeMaker.Block(0, statements.toList());

    // 生成入参
    JCTree.JCVariableDecl param = treeMaker.VarDef(treeMaker.Modifiers(Flags.PARAMETER),
            jcVariableDecl.getName(), jcVariableDecl.vartype, null);
    List<JCTree.JCVariableDecl> parameters = List.of(param);

    // 生成返回对象
    JCTree.JCExpression methodType = treeMaker.Type(new Type.JCVoidType());
    return treeMaker.MethodDef(treeMaker.Modifiers(Flags.PUBLIC),
            getNewMethodName(jcVariableDecl.getName()), methodType, List.nil(),
            parameters, List.nil(), block, null);

}

private Name getNewMethodName(Name name) {
    String s = name.toString();
    return names.fromString("get" + s.substring(0, 1).toUpperCase() + s.substring(1, name.length()));
}

private JCTree.JCExpressionStatement makeAssignment(JCTree.JCExpression lhs, JCTree.JCExpression rhs) {
    return treeMaker.Exec(
            treeMaker.Assign(
                    lhs,
                    rhs
            )
    );
}

}

有点需要注意的是，这里的许多类都是tools.jar包里的，甚至包括List类。在导入这个包的时候，一开始是导不进来的。一般在JDK的lib目录下会有tools.jar这个包，但是一般情况下IDEA没有把他加到classpath下，这里需要给它加上包的路径，有好几种方法。
方法一：Project Structure -> SDKs -> classpath里新增上这个 jar 包

方法二：Project Structure -> Modules -> 新增一个module source
方法三：Project Structure -> Libraries -> 新增一个java Lib
最后创建一个MyEntity 的测试类

package cn.mucang.demo_lombok;

import java.util.Date;

@MyData
public class MyEntity {

private String name;
private Integer age;
private Date date;

}

测试
写完 Java 代码后，用终端进入代码的目录，然后输入 Java 编译指令。

cd .\cn\mucang\demo_lombok
使用 tools.jar 编译自定义的注解器
javac -encoding utf8 -cp C:\Java\jdk1.8.0_202\lib\tools.jar MyData*.java -d .
这里最后有个.是表示在当前目录下生成 class 文件

使用自定义的注解处理器编译MyEntity类
javac -processor cn.mucang.demo_lombok.MyDataProcessor MyEntity.java