[Java知识库]java 抽象语法树（AST）之概述

一、AST

AST? abstract syntax tree （抽象语法结构树），是对java语言的一种抽象，每个节点都能对应到一种java语法，最终一个java文件就是由棵节点树构成

二、Tree

Tree是一个接口，是AST节点的抽象，内部有一个最重要的枚举Kind，定义了java中的每条语句的格式，也是对应着AST的一个节点

以下均为子接口，每个结构都定义了语法节点类型

Tree

• WildcardTree
• TypeParameterType
• StatementTree? ? ? (一个完整的语句，比如简单的"int a = 1;"，注意最后的“;”)
  • ThrowTree
  • ReturnTree
  • TryTree
  • ContinueTree
  • BreakTree
  • BlockTree
  • DoWhileLoopTree
  • ClassTree
  • VariableTree
  • WhileLoopTree
  • ForLoopTree
  • SwitchTree
  • SynchronizedTree
  • EnhancedForLoopTree
  • LabeedStatementTree
  • AssertTree
  • EmptyStatementTree
  • IfTree
  • ExpressionStatementTree
• CatchTree
• MethodTree
• ArrayTypeTree
• UnionTypeTree
• ModifiersTree
• ParameterizedTypeTree
• CaseTree
• ExpressionTree? ? ? ?(一个非完整的语句，比如简单的"a = 1"，注意最后没有“;”)
  • MemberReferenceTree
  • LambdaExpressionTree
  • UnaryTree
  • MethodInvocationTree
  • AnnotatedTypeTree
  • CompoundAssignmentTree
  • BinaryTree
  • ErroneousTree
  • MemberSelectTree
  • ArrayAccessTree
  • TypeCastTree
  • NewClassTree
  • ConditionalExpressionTree
  • ParenthesizedTree
  • AnnotationTree
  • NewArrayType
  • InstanceOfTree
  • IdentifierTree
  • AssignmentTree
  • LiteralTree
• CompilationUnitTree
• IntersectionTypeTree
• PrimitiveTypeTree
• Import

三、Kind

AST 节点类型，对应着java的语法

?四、JCTree

com.sun.tools.javac.tree.JCTree 是Tree的一个抽象实现类，有各种实现类，代表着一个个的AST节点

五、JC类的Factory

细心阅读会发现，各种JC类的构造函数都是protected，也就是说，并不能直接进行初始化，所以现在要使用Factory，Factory是各种JC类的工厂定义

六、TreeMaker

TreeMaker实现了Factory接口，所以我们它会是我们经常使用的一个类

还需要关注的一个Names，这个基本是创建一个节点的开始

Names: 用来存储和表示解析后的词法，每个字符集合都会是一个Name对象，所有的对象都存储在Name.Table内部类中。

在学习以下内容时，一定要熟练掌握JCIdent和Names。

Javac编译原理 - wade&luffy - 博客园


?

javac源码笔记与简单的编译原理 | Ren's Time Overflow Skyline ^_^

深入分析 Javac 编译原理 - 知乎

6.1、添加 import

// import com.leisure.lombok.thrift.AstTreeClass
// 获取标识符
JCTree.JCIdent jcIdent = treeMaker.Ident(names.fromString("com.leisure.lombok.thrift"));
// 获取标识符
Name className = names.fromString("AstTreeClass");
// 定义访问
JCTree.JCFieldAccess jcFieldAccess = treeMaker.Select(jcIdent, className);
// 添加import节点
JCTree.JCImport anImport = treeMaker.Import(jcFieldAccess, false);
// 加入AST树种
jcCompilationUnit.defs = jcCompilationUnit.defs.append(anImport);

6.2、定义属性

默认构造函数

//private AstTreeClass variable = new AstTreeClass()
        // new AstTreeClass()
        JCTree.JCNewClass newClass = treeMaker.NewClass(null, null, treeMaker.Ident(names.fromString("AstTreeClass")), List.nil(), null);

        // private AstTreeClass variable = ...
        JCTree.JCVariableDecl variableDecl = treeMaker.VarDef(treeMaker.Modifiers(Modifier.PRIVATE.ordinal()),
                names.fromString("variable"), treeMaker.Ident(names.fromString("AstTreeClass")), newClass);

带参数的构造函数

使用这个我们就可以实现@Slf4j了（当然了，还需要有插件，才能真正像@Slf4j一样使用）

//public static final AstTreeClass staticVariable = new AstTreeClass(1)
        JCTree.JCLiteral constantOne = treeMaker.Literal(1);
        JCTree.JCNewClass newClass1 = treeMaker.NewClass(null, null, treeMaker.Ident(names.fromString("AstTreeClass")), List.of(constantOne), null);

        JCTree.JCVariableDecl staticVariableDecl = treeMaker.VarDef(
                treeMaker.Modifiers(Flags.PUBLIC + Flags.STATIC + Flags.FINAL),
                names.fromString("staticVariable"),
                treeMaker.Ident(names.fromString("AstTreeClass")),
                newClass1
        );

6.4、添加方法

            String name = variableDecl.name.toString();
            JCTree.JCExpression varType = variableDecl.vartype;
            // getter，假设name长度大于1
            String getterMethodName = "get" + name.substring(0, 1).toUpperCase() + name.substring(1);
            // this.name
            JCTree.JCExpression thisName = treeMaker.Select(treeMaker.This(classDecl.sym.type), names.fromString(name));
            JCTree.JCReturn jcReturn = treeMaker.Return(thisName);
            // public type getName() {return this.name;}
            JCTree.JCMethodDecl getter = treeMaker.MethodDef(
                    treeMaker.Modifiers(Flags.PUBLIC), // 访问标识
                    names.fromString(getterMethodName), // 方法名字
                    varType,                            // 返回类型
                    List.nil(),                          // 泛型形参列表
                    List.nil(),                        // 参数列表
                    List.nil(),                        // 异常列表
                    treeMaker.Block(0, List.of(jcReturn)), // block
                    null                   // 默认方法
            );

            // setter
            // public void setName(nameType name) {this.name = name;}
            String setterMethodName = "set" + name.substring(0, 1).toUpperCase() + name.substring(1);
            // 这里只是生成了this.name = name表达式
            JCTree.JCAssign assign = treeMaker.Assign(thisName, treeMaker.Ident(names.fromString(name)));
            // 生成一条语句 this.name = name;
            JCTree.JCExpressionStatement assignStat = treeMaker.Exec(assign);
            JCTree.JCMethodDecl setterMethodDecl = treeMaker.MethodDef(
                    treeMaker.Modifiers(Flags.PUBLIC),     // 访问标识
                    names.fromString(setterMethodName),    // 方法名
                    treeMaker.TypeIdent(TypeTag.VOID),                     // 返回类型
                    List.nil(),                    // 泛型形参列表
                    List.of(treeMaker.VarDef(
                            treeMaker.Modifiers(Flags.PARAMETER),   // 普通参数
                            variableDecl.name,
                            varType,
                            null   // 初始化为空，方法入参时为空即可
                            )
                    ), // 参数列表
                    List.nil(), // 异常列表
                    treeMaker.Block(0, List.of(assignStat)), // 方法体
                    null //默认方法
            );

解决TreeMaker AssertionError: Value of x -1_你倒是跑啊的博客-CSDN博客

TreeMaker? -> JCTree -> Tree?,接下来的一系列就是应用了

阅读世界，共赴山海

423全民读书节，邀你共读