在JDK中,自带了一套相关的编译API,可以在Java中发起编译流程,解析Java源文件然后获取其语法树,在JDK的tools.jar
(OSX下可以在/Library/Java/JavaVirtualMachines/jdk_version/Contents/Home/lib中找到)中包含着这整套API,但是这却不是Oracle和OpenJDK发布中的公开API,因此对于这套API,并没有官方的正式文档来进行说明。但是,也有不少项目利用了这套API来做了不少事情,例如大名鼎鼎的lombok使用了这套API在Annotation Processing阶段修改了源代码中的语法树,最终结果相当于直接在源文件中插入了新的代码!
由于这套API目前缺少相关文档,使用起来比较困难,例如,解析源代码中的所有变量,并打印出来:
[代码]java代码:
01 02 03 04 05 06 07 08 09 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 |
|
其中 User.java
的代码如下:
[代码]java代码:
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 |
|
执行上面的JavaParser
结果如下:
[代码]java代码:
1 2 3 |
|
这里我们是首先通过JavaCompiler.CompilationTask
解析了源文件之后,再使用自定义的SourceVisitor
(继承自TreeScanner
)来对源代码的结构进行访问,在SourceVisitor
类中,通过重载visitVariable
来对一个编译单元(单个源代码文件)进行解析,访问其中的所有的变量,这里可以看出,我们没有办法拿到这个变量类型的全限定名(包含包名),只能拿到的对应的简单名字,因此,类型的确定需要外部实现自行确定,例如可以通过记录类所在的包名,递归的搜索整个源代码目录来跟踪所有类的全限定名,查找import中是否包含对应的类型等。
TreeScanner
中除了visitVariable
方法外,还包含了大量其他的visitXYZ
方法,例如,可以遍历所有的import,方法定义,Annotation等,更具体可以查看OpenJDK中关于这个的源代码
这里再来看下另外一个例子,重载visitClass
方法,访问所有的内部类以及类本身:
[代码]java代码:
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 |
|
这里简单的打印了类名以及变量的名称,类型,annotation类型,执行上面的代码,结果如下:
[代码]java代码:
1 2 3 4 5 |
|
可以看出我们把类名以及类中的变量都打印了出来。而在visitClass
方法中,我们可以通过getMembers
方法拿到类中所有的成员,包括变量,方法,annotation等,分别对应着不同的类型,例如变量就对应着VariableTree
类型,方法就对应的MethodTree
类型。
总得来说,虽然实际上使用并不算特别复杂,但是由于缺少文档,对使用造成了很大的障碍,而且目前所介绍的只是这套API的一少部分,后续我将会继续研究这套API的相关函数。
共同学习,写下你的评论
评论加载中...
作者其他优质文章