在Lombok经常用,但是你知道它的原理是什么吗?,和Lombok经常用,但是你知道它的原理是什么吗?(二)两篇文章中介绍了关于Lombok的底层原理,其实总结为一句话来说就是在编译期通过改变抽象语法树而实现的。上面两篇文章已经讲了抽象语法树的相关知识点,如果有不清楚的可以看一下。
在网上关于如何修改Java的抽象语法树的相关API文档并不多,于是本篇记录一下相关的知识点,以便随后查阅。
JCTree的介绍
JCTree是语法树元素的基类,包含一个重要的字段pos,该字段用于指明当前语法树节点(JCTree)在语法树中的位置,因此我们不能直接用new关键字来创建语法树节点,即使创建了也没有意义。此外,结合访问者模式,将数据结构与数据的处理进行解耦,部分源码如下:
1 | 复制代码 1public abstract class JCTree implements Tree, Cloneable, DiagnosticPosition { |
我们可以看到JCTree是一个抽象类,这里重点介绍几个JCTree的子类
- JCStatement:声明语法树节点,常见的子类如下
- JCBlock:语句块语法树节点
- JCReturn:return语句语法树节点
- JCClassDecl:类定义语法树节点
- JCVariableDecl:字段/变量定义语法树节点
- JCMethodDecl:方法定义语法树节点
- JCModifiers:访问标志语法树节点
- JCExpression:表达式语法树节点,常见的子类如下
- JCAssign:赋值语句语法树节点
- JCIdent:标识符语法树节点,可以是变量,类型,关键字等等
TreeMaker介绍
TreeMaker用于创建一系列的语法树节点,我们上面说了创建JCTree不能直接使用new关键字来创建,所以Java为我们提供了一个工具,就是TreeMaker,它会在创建时为我们创建的JCTree对象设置pos字段,所以必须使用上下文相关的TreeMaker对象来创建语法树节点。
具体的API介绍可以参照,TreeMakerAPI,接下来着重介绍一下常用的几个方法。
TreeMaker.Modifiers
TreeMaker.Modifiers
方法用于创建访问标志语法树节点(JCModifiers),源码如下
1 | 复制代码 1public JCModifiers Modifiers(long flags) { |
- flags:访问标志
- annotations:注解列表
其中flags可以使用枚举类com.sun.tools.javac.code.Flags
来表示,例如我们可以这样用,就生成了下面的访问标志了。
1 | 复制代码1treeMaker.Modifiers(Flags.PUBLIC + Flags.STATIC + Flags.FINAL); |
TreeMaker.ClassDef
TreeMaker.ClassDef用于创建类定义语法树节点(JCClassDecl),源码如下:
1 | 复制代码 1public JCClassDecl ClassDef(JCModifiers mods, |
- mods:访问标志,可以通过
TreeMaker.Modifiers
来创建 - name:类名
- typarams:泛型参数列表
- extending:父类
- implementing:实现的接口
- defs:类定义的详细语句,包括字段、方法的定义等等
TreeMaker.MethodDef
TreeMaker.MethodDef用于创建方法定义语法树节点(JCMethodDecl),源码如下
1 | 复制代码 1public JCMethodDecl MethodDef(JCModifiers mods, |
- mods:访问标志
- name:方法名
- restype:返回类型
- typarams:泛型参数列表
- params:参数列表
- thrown:异常声明列表
- body:方法体
- defaultValue:默认方法(可能是interface中的哪个default)
- m:方法符号
- mtype:方法类型。包含多种类型,泛型参数类型、方法参数类型、异常参数类型、返回参数类型。
返回类型restype填写null或者
treeMaker.TypeIdent(TypeTag.VOID)
都代表返回void类型
TreeMaker.VarDef
TreeMaker.VarDef用于创建字段/变量定义语法树节点(JCVariableDecl),源码如下
1 | 复制代码 1public JCVariableDecl VarDef(JCModifiers mods, |
- mods:访问标志
- name:参数名称
- vartype:类型
- init:初始化语句
- v:变量符号
TreeMaker.Ident
TreeMaker.Ident用于创建标识符语法树节点(JCIdent),源码如下
1 | 复制代码 1public JCIdent Ident(Name name) { |
TreeMaker.Return
TreeMaker.Return用于创建return语句(JCReturn),源码如下
1 | 复制代码1public JCReturn Return(JCExpression expr) { |
TreeMaker.Select
TreeMaker.Select用于创建域访问/方法访问(这里的方法访问只是取到名字,方法的调用需要用TreeMaker.Apply)语法树节点(JCFieldAccess),源码如下
1 | 复制代码 1public JCFieldAccess Select(JCExpression selected, |
- selected:
.
运算符左边的表达式 - selector:
.
运算符右边的表达式
下面给出一个例子,一语句生成的Java语句就是二语句
1 | 复制代码1一. TreeMaker.Select(treeMaker.Ident(names.fromString("this")), names.fromString("name")); |
TreeMaker.NewClass
TreeMaker.NewClass用于创建new语句语法树节点(JCNewClass),源码如下:
1 | 复制代码1public JCNewClass NewClass(JCExpression encl, |
- encl:不太明白此参数的含义,我看很多例子中此参数都设置为null
- typeargs:参数类型列表
- clazz:待创建对象的类型
- args:参数列表
- def:类定义
TreeMaker.Apply
TreeMaker.Apply用于创建方法调用语法树节点(JCMethodInvocation),源码如下:
1 | 复制代码1public JCMethodInvocation Apply(List<JCExpression> typeargs, |
- typeargs:参数类型列表
- fn:调用语句
- args:参数列表
TreeMaker.Assign
TreeMaker.Assign用户创建赋值语句语法树节点(JCAssign),源码如下:
1 | 复制代码1ublic JCAssign Assign(JCExpression lhs, |
- lhs:赋值语句左边表达式
- rhs:赋值语句右边表达式
TreeMaker.Exec
TreeMaker.Exec用于创建可执行语句语法树节点(JCExpressionStatement),源码如下:
1 | 复制代码1public JCExpressionStatement Exec(JCExpression expr) { |
TreeMaker.Apply以及TreeMaker.Assign就需要外面包一层TreeMaker.Exec来获得一个JCExpressionStatement
TreeMaker.Block
TreeMaker.Block用于创建组合语句的语法树节点(JCBlock),源码如下:
1 | 复制代码1public JCBlock Block(long flags, |
- flags:访问标志
- stats:语句列表
com.sun.tools.javac.util.List介绍
在我们操作抽象语法树的时候,有时会涉及到关于List的操作,但是这个List不是我们经常使用的java.util.List
而是com.sun.tools.javac.util.List
,这个List比较奇怪,是一个链式的结构,有头结点和尾节点,但是只有尾节点是一个List,这里作为了解就行了。
1 | 复制代码 1public class List<A> extends AbstractCollection<A> implements java.util.List<A> { |
com.sun.tools.javac.util.ListBuffer
由于com.sun.tools.javac.util.List
使用起来不方便,所以又在其上面封装了一层,这个封装类是ListBuffer
,此类的操作和我们平时经常使用的java.util.List
用法非常类似。
1 | 复制代码 1public class ListBuffer<A> extends AbstractQueue<A> { |
com.sun.tools.javac.util.Names介绍
这个是为我们创建名称的一个工具类,无论是类、方法、参数的名称都需要通过此类来创建。它里面经常被使用到的一个方法就是fromString()
,一般使用方法如下所示。
1 | 复制代码1Names names = new Names() |
实战演练
上面我们大概了解了如何操作抽象语法树,接下来我们就来写几个真实的案例加深理解。
变量相关
在类中我们经常操作的参数就是变量,那么如何使用抽象语法树的特性为我们操作变量呢?接下来我们就将一些对于变量的一些操作。
生成变量
例如生成private String age;
这样一个变量,借用我们上面讲的VarDef
方法
1 | 复制代码1// 生成参数 例如:private String age; |
对变量赋值
例如我们想生成private String name = "BuXueWuShu"
,还是利用VarDef
方法
1 | 复制代码1// private String name = "BuXueWuShu" |
两个字面量相加
例如我们生成String add = "a" + "b";
,借用我们上面讲的Exec
方法和Assign
方法
1 | 复制代码1// add = "a"+"b" |
+=语法
例如我们想生成add += "test"
,则和上面字面量差不多。
1 | 复制代码1// add+="test" |
++语法
例如想生成++i
1 | 复制代码1treeMaker.Exec(treeMaker.Unary(JCTree.Tag.PREINC,treeMaker.Ident(names.fromString("i")))) |
方法相关
我们对于变量进行了操作,那么基本上都是要生成方法的,那么如何对方法进行生成和操作呢?我们接下来演示一下关于方法相关的操作方法。
无参无返回值
我们可以利用上面讲到的MethodDef
方法进行生成
1 | 复制代码 1/* |
有参无返回值
我们可以利用上面讲到的MethodDef
方法进行生成
1 | 复制代码 1/* |
有参有返回值
1 | 复制代码 1 /* |
特殊的
我们学完了如何进行定义参数,如何进行定义方法,其实还有好多语句需要学习,例如如何生成new语句,如何生成方法调用的语句,如何生成if语句。j接下来我们就学习一些比较特殊的语法。
new一个对象
1 | 复制代码 1// 创建一个new语句 CombatJCTreeMain combatJCTreeMain = new CombatJCTreeMain(); |
方法调用(无参)
1 | 复制代码 1JCTree.JCExpressionStatement exec = treeMaker.Exec( |
方法调用(有参)
1 | 复制代码 1// 创建一个方法调用 combatJCTreeMain.test2("hello world!"); |
if语句
1 | 复制代码 1/* |
源码地址
总结
纸上得来终觉浅,绝知此事要躬行。希望大家看完此篇文章能够自己在本机上自己试验一下。自己设置几个参数,自己学的Lombok学着生成一下get、set方法,虽然本篇知识在日常开发中基本上不会用到,但是万一用到了这些知识那么别人不会而你会,差距其实就慢慢的给拉开了。本篇涉及到的所有代码都在github上面有,拉下来以后全局搜CombatJCTreeProcessor
类就可以看到了。
有感兴趣的可以关注一下我新建的公众号,搜索[程序猿的百宝袋]。或者直接扫下面的码也行。
本文转载自: 掘金