1
在Lombok经常用，但是你知道它的原理是什么吗？和Lombok经常用，但是你知道它的原理是什么吗？(二)两篇文章中介绍了关于Lombok的底层原理，其实总结为一句话来说就是在编译期通过改变抽象语。..
1
在Lombok经常用，但是你知道它的原理是什么吗？和Lombok经常用，但是你知道它的原理是什么吗？(二)两篇文章中介绍了关于Lombok的底层原理，其实总结为一句话来说就是在编译期通过改变抽象语法树而实现的。上面两篇文章已经讲了抽象语法树的相关知识点，如果有不清楚的可以看一下。

本篇涉及到的所有代码都在github上面有
在网上关于如何修改Java的抽象语法树的相关API文档并不多，于是本篇记录一下相关的知识点，以便随后查阅。

一、Java中的屠龙之术

1.1 JCTree的介绍

JCTree是语法树元素的基类，包含一个重要的字段pos，该字段用于指明当前语法树节点（JCTree）在语法树中的位置，因此我们不能直接用new关键字来创建语法树节点，即使创建了也没有意义。此外，结合访问者模式，将数据结构与数据的处理进行解耦，部分源码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
  public abstract class JCTree implements Tree, Cloneable, DiagnosticPosition {

    public int pos = -1;

    ...

    public abstract void accept(JCTree.Visitor visitor);

    ...
}


  ```  
我们可以看到JCTree是一个抽象类，这里重点介绍几个JCTree的子类 
 
 JCStatement：声明语法树节点，常见的子类如下 
   
   JCBlock：语句块语法树节点 
   JCReturn：return语句语法树节点 
   JCClassDecl：类定义语法树节点 
   JCVariableDecl：字段/变量定义语法树节点 
    
 JCMethodDecl：方法定义语法树节点 
 JCModifiers：访问标志语法树节点 
 JCExpression：表达式语法树节点，常见的子类如下 
   
   JCAssign：赋值语句语法树节点 
   JCIdent：标识符语法树节点，可以是变量，类型，关键字等等 
    
 
#### 1.2 TreeMaker介绍
TreeMaker用于创建一系列的语法树节点，我们上面说了创建JCTree不能直接使用new关键字来创建，所以Java为我们提供了一个工具，就是TreeMaker，它会在创建时为我们创建的JCTree对象设置pos字段，所以必须使用上下文相关的TreeMaker对象来创建语法树节点。 
具体的API介绍可以参照，TreeMakerAPI，接下来着重介绍一下常用的几个方法。 
##### TreeMaker.Modifiers
 `TreeMaker.Modifiers` 方法用于创建访问标志语法树节点（JCModifiers），源码如下 
```java
  public JCModifiers Modifiers(long flags) {
    return Modifiers(flags, List.< JCAnnotation >nil());

}

1
2
3
4
5
6
public JCModifiers Modifiers(long flags,
    List<JCAnnotation> annotations) {
        JCModifiers tree = new JCModifiers(flags, annotations);
        boolean noFlags = (flags & (Flags.ModifierFlags | Flags.ANNOTATION)) == 0;
        tree.pos = (noFlags && annotations.isEmpty()) ? Position.NOPOS : pos;
        return tree;

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
 flags：访问标志 
 annotations：注解列表 
 
其中flags可以使用枚举类 `com.sun.tools.javac.code.Flags` 来表示，例如我们可以这样用，就生成了下面的访问标志了。 
  treeMaker.Modifiers(Flags.PUBLIC + Flags.STATIC + Flags.FINAL);

public static final


  ```  
##### TreeMaker.ClassDef
TreeMaker.ClassDef用于创建类定义语法树节点（JCClassDecl）,源码如下： 
```java
  public JCClassDecl ClassDef(JCModifiers mods,
Name name,

1
List<JCTypeParameter> typarams,
JCExpression extending,

1
2
3
List<JCExpression> implementing,
List<JCTree> defs) {
    JCClassDecl tree = new JCClassDecl(mods,
                                 name,
                                 typarams,
                                 extending,
                                 implementing,

1
2
3
                             defs,
                             null);
tree.pos = pos;

}

`mods：访问标志，可以通过```text
TreeMaker.Modifiers

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 name：类名 
 typarams：泛型参数列表 
 extending：父类 
 implementing：实现的接口 
 defs：类定义的详细语句，包括字段、方法的定义等等 
 
##### TreeMaker.MethodDef
TreeMaker.MethodDef用于创建方法定义语法树节点（JCMethodDecl），源码如下 
  public JCMethodDecl MethodDef(JCModifiers mods,
    JCExpression restype,
    List<JCVariableDecl> params,
    List<JCExpression> thrown,
    JCBlock body,
    JCExpression defaultValue) {
        JCMethodDecl tree = new JCMethodDecl(mods,
                                       name,
                                       restype,
                                       thrown,
                                       body,
                                       defaultValue,
}

public JCMethodDecl MethodDef(MethodSymbol m,
    Type mtype,
    JCBlock body) {
        return (JCMethodDecl)
            new JCMethodDecl(
                Modifiers(m.flags(), Annotations(m.getAnnotationMirrors())),
                m.name,
                Type(mtype.getReturnType()),
                TypeParams(mtype.getTypeArguments()),
                Params(mtype.getParameterTypes(), m),
                Types(mtype.getThrownTypes()),
                body,
                null,
                m).setPos(pos).setType(mtype);
}

  ```  
 
 mods：访问标志 
 name：方法名 
 restype：返回类型 
 params：参数列表 
 thrown：异常声明列表 
 body：方法体 
```python
 defaultValue：默认方法（可能是interface中的哪个default）

m：方法符号
mtype：方法类型。包含多种类型，泛型参数类型、方法参数类型、异常参数类型、返回参数类型。

TreeMaker.VarDef

TreeMaker.VarDef用于创建字段/变量定义语法树节点（JCVariableDecl），源码如下

1
public JCVariableDecl VarDef(JCModifiers mods,
JCExpression vartype,

1
2
JCExpression init) {
    JCVariableDecl tree = new JCVariableDecl(mods, name, vartype, init, null);

}

1
2
3
4
public JCVariableDecl VarDef(VarSymbol v,
        return (JCVariableDecl)
            new JCVariableDecl(
                Modifiers(v.flags(), Annotations(v.getAnnotationMirrors())),
            v.name,

1
Type(v.type),
            init,

1
v).setPos(pos).setType(v.type);

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
 name：参数名称 
 vartype：类型 
 init：初始化语句 
 v：变量符号 
 
##### TreeMaker.Ident
TreeMaker.Ident用于创建标识符语法树节点（JCIdent），源码如下 
  public JCIdent Ident(Name name) {
        JCIdent tree = new JCIdent(name, null);
}

public JCIdent Ident(Symbol sym) {
        return (JCIdent)new JCIdent((sym.name != names.empty)
                                ? sym.name
                                : sym.flatName(), sym)
            .setPos(pos)
            .setType(sym.type);
}

public JCExpression Ident(JCVariableDecl param) {
        return Ident(param.sym);
}


  ```  
##### TreeMaker.Return
TreeMaker.Return用于创建return语句（JCReturn），源码如下 
```java
  public JCReturn Return(JCExpression expr) {
        JCReturn tree = new JCReturn(expr);

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
##### TreeMaker.Select
TreeMaker.Select用于创建域访问/方法访问（这里的方法访问只是取到名字，方法的调用需要用TreeMaker.Apply）语法树节点（JCFieldAccess），源码如下 
  public JCFieldAccess Select(JCExpression selected,
    Name selector) 
{
        JCFieldAccess tree = new JCFieldAccess(selected, selector, null);
}

public JCExpression Select(JCExpression base,
    Symbol sym) {
        return new JCFieldAccess(base, sym.name, sym).setPos(pos).setType(sym.type);
}


  `selected：```text
  .
  ``` 运算符左边的表达式 
 selector： `.` 运算符右边的表达式 
 
下面给出一个例子，一语句生成的Java语句就是二语句 
```python
  一. TreeMaker.Select(treeMaker.Ident(names.fromString("this")), names.fromString("name"));

二. this.name

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
##### TreeMaker.NewClass
TreeMaker.NewClass用于创建new语句语法树节点（JCNewClass）,源码如下： 
  public JCNewClass NewClass(JCExpression encl,
    List<JCExpression> typeargs,
    JCExpression clazz,
    List<JCExpression> args,
    JCClassDecl def) {
        JCNewClass tree = new JCNewClass(encl, typeargs, clazz, args, def);
}

  ```  
 
 encl：不太明白此参数的含义，我看很多例子中此参数都设置为null 

 typeargs：参数类型列表 
 clazz：待创建对象的类型 
 args：参数列表 
```python
 def：类定义
TreeMaker.Apply

TreeMaker.Apply用于创建方法调用语法树节点（JCMethodInvocation），源码如下：

1
public JCMethodInvocation Apply(List<JCExpression> typeargs,
JCExpression fn,

1
2
List<JCExpression> args) {
    JCMethodInvocation tree = new JCMethodInvocation(typeargs, fn, args);

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
 fn：调用语句 
 
##### TreeMaker.Assign
TreeMaker.Assign用户创建赋值语句语法树节点（JCAssign），源码如下： 
  ublic JCAssign Assign(JCExpression lhs,
    JCExpression rhs) {
        JCAssign tree = new JCAssign(lhs, rhs);
}

  ```  
 
 lhs：赋值语句左边表达式 
 rhs：赋值语句右边表达式 
 
##### TreeMaker.Exec
TreeMaker.Exec用于创建可执行语句语法树节点（JCExpressionStatement），源码如下： 
```java
  public JCExpressionStatement Exec(JCExpression expr) {
        JCExpressionStatement tree = new JCExpressionStatement(expr);

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
##### TreeMaker.Block
TreeMaker.Block用于创建组合语句的语法树节点（JCBlock），源码如下： 
  public JCBlock Block(long flags,
    List<JCStatement> stats) {
        JCBlock tree = new JCBlock(flags, stats);
}

  ```  
 
 stats：语句列表 
 
#### 1.3 com.sun.tools.javac.util.List介绍
在我们操作抽象语法树的时候，有时会涉及到关于List的操，是这个List不是我们经常使用的 `java.util.List` 而是 `com.sun.tools.javac.util.List` ，这个List比较奇怪，是一个链式的结构，有头结点和尾节点，但是只有尾节点是一个List，这里作为了解就行了。 
```java
  public class List<A> extends AbstractCollection<A> implements java.util.List<A> {
    public A head;
    public List<A> tail;
    private static final List<?> EMPTY_LIST = new List<Object>((Object)null, (List)null) {
        public List<Object> setTail(List<Object> var1) {
            throw new UnsupportedOperationException();
    }

1
2
public boolean isEmpty() {
    return true;
    }
};

1
2
3
List(A head, List<A> tail) {
    this.tail = tail;
    this.head = head;
}

1
2
public static <A> List<A> nil() {
    return EMPTY_LIST;
}

1
2
public List<A> prepend(A var1) {
    return new List(var1, this);
}

1
2
public List<A> append(A var1) {
    return of(var1).prependList(this);
}

1
2
public static <A> List<A> of(A var0) {
    return new List(var0, nil());
}

1
2
public static <A> List<A> of(A var0, A var1) {
    return new List(var0, of(var1));
}

1
2
public static <A> List<A> of(A var0, A var1, A var2) {
    return new List(var0, of(var1, var2));
}

1
2
public static <A> List<A> of(A var0, A var1, A var2, A... var3) {
    return new List(var0, new List(var1, new List(var2, from(var3))));
}

...

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
#### 1.4 com.sun.tools.javac.util.ListBuffer
由于 `com.sun.tools.javac.util.List` 使用起来不方便，所以又在其上面封装了一层，这个封装类是 `ListBuffer` ，此类的操作和我们平时经常使用的 `java.util.List` 用法非常类似。 
  public class ListBuffer<A> extends AbstractQueue<A> {

    public static <T> ListBuffer<T> of(T x) {
        ListBuffer<T> lb = new ListBuffer<T>();
        lb.add(x);
        return lb;
    }

    /** The list of elements of this buffer.
     */
    private List<A> elems;

    /** A pointer pointing to the last element of 'elems' containing data,
     *  or null if the list is empty.
     */
    private List<A> last;

    /** The number of element in this buffer.
     */
    private int count;

    /** Has a list been created from this buffer yet?
     */
    private boolean shared;

    /** Create a new initially empty list buffer.
     */
    public ListBuffer() {
        clear();
    }

    /** Append an element to buffer.
     */
    public ListBuffer<A> append(A x) {
        x.getClass(); // null check

        if (shared) copy();
        List<A> newLast = List.<A>of(x);
        if (last != null) {
            last.tail = newLast;
            last = newLast;
        } else {
            elems = last = newLast;
        }
        count++;
        return this;
    }
    ........
}


  ```  
#### 1.5 com.sun.tools.javac.util.Names介绍
```python
这个是为我们创建名称的一个工具类，无论是类、方法、参数的名称都需要通过此类来创建。它里面经常被使用到的一个方法就是 `fromString()` ，一般使用方法如下所示。 
  Names names  = new Names()
names. fromString("setName");
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
#### 1.6 实战演练
上面我们大概了解了如何操作抽象语法树，接下来我们就来写几个真实的案例加深理解。 
##### 变量相关
在类中我们经常操作的参数就是变量，那么如何使用抽象语法树的特性为我们操作变量呢？接下来我们就将一些对于变量的一些操作。 
###### 生成变量
例如生成 `private String age;` 这样一个变量，借用我们上面讲的 `VarDef` 方法 
  // 生成参数 例如：private String age;
treeMaker.VarDef(treeMaker.Modifiers(Flags.PRIVATE), names.fromString("age"), treeMaker.Ident(names.fromString("String")), null);


  ```  
###### 对变量赋值
```java
例如我们想生成 `private String name = "BuXueWuShu"` ，还是利用 `VarDef` 方法 
  // private String name = "BuXueWuShu"
treeMaker.VarDef(treeMaker.Modifiers(Flags.PRIVATE),names.fromString("name"),treeMaker.Ident(names.fromString("String")),treeMaker.Literal("BuXueWuShu"))
1
2
3
4
5
6
7
8
9
10
11
12
###### 两个字面量相加
例如我们生成 `String add = "a" + "b";` ，借用我们上面讲的 `Exec` 方法和 `Assign` 方法 
  // add = "a"+"b"
treeMaker.Exec(treeMaker.Assign(treeMaker.Ident(names.fromString("add")),treeMaker.Binary(JCTree.Tag.PLUS,treeMaker.Literal("a"),treeMaker.Literal("b"))))


  ```  
```python
###### +=语法
例如我们想生成 `add += "test"` ，则和上面字面量差不多。 
  // add+="test"
treeMaker.Exec(treeMaker.Assignop(JCTree.Tag.PLUS_ASG, treeMaker.Ident(names.fromString("add")), treeMaker.Literal("test")))
1
2
3
4
5
6
7
8
9
10
11
12
13
14
###### ++语法
例如想生成 `++i`
  treeMaker.Exec(treeMaker.Unary(JCTree.Tag.PREINC,treeMaker.Ident(names.fromString("i"))))


  ```  
##### 方法相关
我们对于变量进行了操作，那么基本上都是要生成方法的，那么如何对方法进行生成和操作呢？我们接下来演示一下关于方法相关的操作方法。 
###### 无参无返回值
我们可以利用上面讲到的 `MethodDef` 方法进行生成 
  /*
    无参无返回值的方法生成
```java
    public void test(){
}

*/

1
2
3
// 定义方法体
ListBuffer<JCTree.JCStatement> testStatement = new ListBuffer<>();
JCTree.JCBlock testBody = treeMaker.Block(0, testStatement.toList());
1
2
3
4
5
JCTree.JCMethodDecl test = treeMaker.MethodDef(
        treeMaker.Modifiers(Flags.PUBLIC), // 方法限定值
        names.fromString("test"), // 方法名
        treeMaker.Type(new Type.JCVoidType()), // 返回类型
        com.sun.tools.javac.util.List.nil(),
    testBody,	// 方法体
    null

);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
###### 有参无返回值
  /*
    public void test2(String name){
        name = "xxxx";
    }
 */
ListBuffer<JCTree.JCStatement> testStatement2 = new ListBuffer<>();
testStatement2.append(treeMaker.Exec(treeMaker.Assign(treeMaker.Ident(names.fromString("name")),treeMaker.Literal("xxxx"))));
JCTree.JCBlock testBody2 = treeMaker.Block(0, testStatement2.toList());

// 生成入参
JCTree.JCVariableDecl param = treeMaker.VarDef(treeMaker.Modifiers(Flags.PARAMETER), names.fromString("name"),treeMaker.Ident(names.fromString("String")), null);
com.sun.tools.javac.util.List<JCTree.JCVariableDecl> parameters = com.sun.tools.javac.util.List.of(param);

JCTree.JCMethodDecl test2 = treeMaker.MethodDef(
        names.fromString("test2"), // 方法名
        parameters, // 入参
        testBody2,
        null
);


  `###### 有参有返回值```java
   /*
    有参有返回值
    public String test3(String name){
       return name;
    }
 */

ListBuffer<JCTree.JCStatement> testStatement3 = new ListBuffer<>();
testStatement3.append(treeMaker.Return(treeMaker.Ident(names.fromString("name"))));
JCTree.JCBlock testBody3 = treeMaker.Block(0, testStatement3.toList());

JCTree.JCVariableDecl param3 = treeMaker.VarDef(treeMaker.Modifiers(Flags.PARAMETER), names.fromString("name"),treeMaker.Ident(names.fromString("String")), null);
com.sun.tools.javac.util.List<JCTree.JCVariableDecl> parameters3 = com.sun.tools.javac.util.List.of(param3);

JCTree.JCMethodDecl test3 = treeMaker.MethodDef(
        names.fromString("test4"), // 方法名
        treeMaker.Ident(names.fromString("String")), // 返回类型
        parameters3, // 入参
        testBody3,
        null
);


  ```  
##### 特殊的
我们学完了如何进行定义参数，如何进行定义方法，其实还有好多语句需要学习，例如如何生成new语句，如何生成方法调用的语句，如何生成if语句。j接下来我们就学习一些比较特殊的语法。 
###### new一个对象

// 创建一个new语句 CombatJCTreeMain combatJCTreeMain = new CombatJCTreeMain();
JCTree.JCNewClass combatJCTreeMain = treeMaker.NewClass(

1
2
3
        null,
```python
        treeMaker.Ident(names.fromString("CombatJCTreeMain")),
    null

);

1
2
3
JCTree.JCVariableDecl jcVariableDecl1 = treeMaker.VarDef(
        treeMaker.Modifiers(Flags.PARAMETER),
        names.fromString("combatJCTreeMain"),
    combatJCTreeMain

);

`###### 方法调用（无参）```java

1
2
3
4
5
JCTree.JCExpressionStatement exec = treeMaker.Exec(
      treeMaker.Apply(
              treeMaker.Select(
                      treeMaker.Ident(names.fromString("combatJCTreeMain")), // . 左边的内容
                      names.fromString("test") // . 右边的内容
            ),

1
com.sun.tools.javac.util.List.nil()
    )

);

`###### 方法调用（有参）```java

1
2
3
  // 创建一个方法调用 combatJCTreeMain.test2("hello world!");
JCTree.JCExpressionStatement exec2 = treeMaker.Exec(
                        names.fromString("test2") // . 右边的内容
            ),

1
com.sun.tools.javac.util.List.of(treeMaker.Literal("hello world!")) // 方法中的内容
    )

);

`###### if语句```json
/*
创建一个if语句

1
2
3
4
if("BuXueWuShu".equals(name)){
    add = "a" + "b";
}else{
    add += "test";
}

*/

1
2
3
4
// "BuXueWuShu".equals(name)
JCTree.JCMethodInvocation apply = treeMaker.Apply(
                treeMaker.Literal("BuXueWuShu"), // . 左边的内容
                names.fromString("equals") // . 右边的内容
    ),

1
com.sun.tools.javac.util.List.of(treeMaker.Ident(names.fromString("name")))

);

1
2
3
4
//  add = "a" + "b"
JCTree.JCExpressionStatement exec3 = treeMaker.Exec(treeMaker.Assign(treeMaker.Ident(names.fromString("add")), treeMaker.Binary(JCTree.Tag.PLUS, treeMaker.Literal("a"), treeMaker.Literal("b"))));
//  add += "test"
JCTree.JCExpressionStatement exec1 = treeMaker.Exec(treeMaker.Assignop(JCTree.Tag.PLUS_ASG, treeMaker.Ident(names.fromString("add")), treeMaker.Literal("test")));
1
JCTree.JCIf anIf = treeMaker.If(
    apply, // if语句里面的判断语句
    exec3, // 条件成立的语句
    exec1  // 条件不成立的语句

);

#### 1.7 源码地址
#### 1.8 总结
纸上得来终觉浅，绝知此事要躬行。希望大家看完此篇文章能够自己在本机上自己试验一下。自己设置几个参数，自己学的Lombok学着生成一下get、set方法，虽然本篇知识在日常开发中基本上不会用到，但是万一用到了这些知识那么别人不会而你会，差距其实就慢慢的给拉开了。本篇涉及到的所有代码都在github上面有，拉下来以后全局搜 `CombatJCTreeProcessor` 类就可以看到了。

本文标题： Java中的屠龙之术如

发布时间： 2021年02月16日 00:00

最后更新： 2025年12月30日 08:54

原始链接： https://haoxiang.eu.org/2dc1cb3a/

版权声明： 本文著作权归作者所有，均采用CC BY-NC-SA 4.0许可协议，转载请注明出处！

赏
× 喜欢就赞赏一下呗！
打赏二维码