JDK的Parser来解析Java源代码详解
在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⽬前缺少相关⽂档，使⽤起来⽐较困难，例如，解析源代码中的所有变量，并打印出来：
public class JavaParser {
private static final String path = "User.java";
private JavacFileManager fileManager;
private JavacTool javacTool;
public JavaParser() {
Context context = new Context();
fileManager = new JavacFileManager(context, true, Charset.defaultCharset());
javacTool = new JavacTool();
}
public void parseJavaFiles() {
Iterable<!--? extends JavaFileObject--> files = JavaFileObjects(path);
JavaCompiler.CompilationTask compilationTask = Task(null, fileManager, null, null, null, files);
JavacTask javacTask = (JavacTask) compilationTask;
try {
Iterable<!--? extends CompilationUnitTree--> result = javacTask.parse();
for (CompilationUnitTree tree : result) {
tree.accept(new SourceVisitor(), null);
}
} catch (IOException e) {
e.printStackTrace();
}
}
static class SourceVisitor extends TreeScanner<void, void=""> {
private String currentPackageName = null;
@Override
public Void visitCompilationUnit(CompilationUnitTree node, Void aVoid) {
return super.visitCompilationUnit(node, aVoid);
}
@Override
public Void visitVariable(VariableTree node, Void aVoid) {
formatPtrln("variable name: %s, type: %s, kind: %s, package: %s",
return null;
}
}
public static void formatPtrln(String format, args) {
System.out.println(String.format(format, args));
}
public static void main(String[] args) {
new JavaParser().parseJavaFiles();
}
}</void,>
其中 User.java的代码如下：
package com.ragnarok.javaparser;
import com.sun.istack.internal.Nullable;
import java.lang.Override;
public class User {
@Nullable
private String foo = "123123";
private Foo a;
public void UserMethod() {}
static class Foo {
private String fooString = "123123";
public void FooMethod() {}
}
}
执⾏上⾯的JavaParser结果如下：
variable: foo, annotaion: Nullable
variable name: foo, type: String, kind: VARIABLE, package: com.ragnarok.javaparser
variable name: a, type: Foo, kind: VARIABLE, package: com.ragnarok.javaparser
这⾥我们是⾸先通过JavaCompiler.CompilationTask解析了源⽂件之后，再使⽤⾃定义的SourceVisitor（继承⾃TreeScanner）来对源代码的结构进⾏访问，在SourceVisitor类中，通过重载visitVariable来对⼀个编译单元（单个源代码⽂件）进⾏解析，访问其中的所有的变量，这⾥可以看出，我们没有办法拿到这个变量类型的全限定名（包含包名），只能拿到的对应的简单名字，因此，类型的确定需要外部实现⾃⾏确定，例如可以通过记录类所在的包名，递归的搜索整个源代码⽬录来跟踪所有类的全限定名，查import中是否包含对应的类型等。
TreeScanner中除了visitVariable⽅法外，还包含了⼤量其他的visitXYZ⽅法，例如，可以遍历所有的import，⽅法定
义，Annotation等，更具体可以查看OpenJDK中关于这个的源代码
这⾥再来看下另外⼀个例⼦，重载visitClass⽅法，访问所有的内部类以及类本⾝：
@Override
public Void visitClass(ClassTree node, Void aVoid) {
formatPtrln("class name: %s", SimpleName());
for (Tree member : Members()) {
if (member instanceof VariableTree) {
VariableTree variable = (VariableTree) member;
List<!--? extends AnnotationTree--> annotations = Modifiers().getAnnotations();
if (annotations.size() > 0) {
formatPtrln("variable: %s, annotaion: %s", Name(), (0).getAnnotationType());
} else {
formatPtrln("variable: %s", Name());
}
}
}
return super.visitClass(node, aVoid);
}
这⾥简单的打印了类名以及变量的名称，类型，annotation类型，执⾏上⾯的代码，结果如下：
class name: User
variable: foo, annotaion: Nullable
variable: a
class name: Foo
variable: fooString
可以看出我们把类名以及类中的变量都打印了出来。⽽在visitClass⽅法中，我们可以通过getMembers⽅法拿到类中所有的成员，包括变量，⽅法，annotation等，分别对应着不同的类型，例如变量就对应着VariableTree类型，⽅法就对应的MethodTree类型。
总得来说，虽然实际上使⽤并不算特别复杂，但是由于缺少⽂档，对使⽤造成了很⼤的障碍，⽽且⽬前所介绍的只是这套API 的⼀少部分，后续我将会继续研究这套API的相关函数。
javaparser野外
以上就是对JDK的Parser来解析Java源代码的资料整理，后续继续补充相关资料，谢谢⼤家对本站的⽀持！

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。