java parser .java_JDK的Parser来解析Java源代码详解
在JDK中,自帶了一套相關(guān)的編譯API,可以在Java中發(fā)起編譯流程,解析Java源文件然后獲取其語(yǔ)法樹(shù),在JDK的tools.jar(OSX下可以在/Library/Java/JavaVirtualMachines/jdk_version/Contents/Home/lib中找到)中包含著這整套API,但是這卻不是Oracle和OpenJDK發(fā)布中的公開(kāi)API,因此對(duì)于這套API,并沒(méi)有官方的正式文檔來(lái)進(jìn)行說(shuō)明。但是,也有不少項(xiàng)目利用了這套API來(lái)做了不少事情,例如大名鼎鼎的lombok使用了這套API在Annotation Processing階段修改了源代碼中的語(yǔ)法樹(shù),最終結(jié)果相當(dāng)于直接在源文件中插入了新的代碼!
由于這套API目前缺少相關(guān)文檔,使用起來(lái)比較困難,例如,解析源代碼中的所有變量,并打印出來(lái):
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 files = fileManager.getJavaFileObjects(path);
JavaCompiler.CompilationTask compilationTask = javacTool.getTask(null, fileManager, null, null, null, files);
JavacTask javacTask = (JavacTask) compilationTask;
try {
Iterable result = javacTask.parse();
for (CompilationUnitTree tree : result) {
tree.accept(new SourceVisitor(), null);
}
} catch (IOException e) {
e.printStackTrace();
}
}
static class SourceVisitor extends TreeScanner {
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",
node.getName(), node.getType(), node.getKind(), currentPackageName);
return null;
}
}
public static void formatPtrln(String format, Object... args) {
System.out.println(String.format(format, args));
}
public static void main(String[] args) {
new JavaParser().parseJavaFiles();
}
}
其中 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() {}
}
}
執(zhí)行上面的JavaParser結(jié)果如下:
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
這里我們是首先通過(guò)JavaCompiler.CompilationTask解析了源文件之后,再使用自定義的SourceVisitor(繼承自TreeScanner)來(lái)對(duì)源代碼的結(jié)構(gòu)進(jìn)行訪問(wèn),在SourceVisitor類中,通過(guò)重載visitVariable來(lái)對(duì)一個(gè)編譯單元(單個(gè)源代碼文件)進(jìn)行解析,訪問(wèn)其中的所有的變量,這里可以看出,我們沒(méi)有辦法拿到這個(gè)變量類型的全限定名(包含包名),只能拿到的對(duì)應(yīng)的簡(jiǎn)單名字,因此,類型的確定需要外部實(shí)現(xiàn)自行確定,例如可以通過(guò)記錄類所在的包名,遞歸的搜索整個(gè)源代碼目錄來(lái)跟蹤所有類的全限定名,查找import中是否包含對(duì)應(yīng)的類型等。
TreeScanner中除了visitVariable方法外,還包含了大量其他的visitXYZ方法,例如,可以遍歷所有的import,方法定義,Annotation等,更具體可以查看OpenJDK中關(guān)于這個(gè)的源代碼
這里再來(lái)看下另外一個(gè)例子,重載visitClass方法,訪問(wèn)所有的內(nèi)部類以及類本身:
@Override
public Void visitClass(ClassTree node, Void aVoid) {
formatPtrln("class name: %s", node.getSimpleName());
for (Tree member : node.getMembers()) {
if (member instanceof VariableTree) {
VariableTree variable = (VariableTree) member;
List annotations = variable.getModifiers().getAnnotations();
if (annotations.size() > 0) {
formatPtrln("variable: %s, annotaion: %s", variable.getName(), annotations.get(0).getAnnotationType());
} else {
formatPtrln("variable: %s", variable.getName());
}
}
}
return super.visitClass(node, aVoid);
}
這里簡(jiǎn)單的打印了類名以及變量的名稱,類型,annotation類型,執(zhí)行上面的代碼,結(jié)果如下:
class name: User
variable: foo, annotaion: Nullable
variable: a
class name: Foo
variable: fooString
可以看出我們把類名以及類中的變量都打印了出來(lái)。而在visitClass方法中,我們可以通過(guò)getMembers方法拿到類中所有的成員,包括變量,方法,annotation等,分別對(duì)應(yīng)著不同的類型,例如變量就對(duì)應(yīng)著VariableTree類型,方法就對(duì)應(yīng)的MethodTree類型。
總得來(lái)說(shuō),雖然實(shí)際上使用并不算特別復(fù)雜,但是由于缺少文檔,對(duì)使用造成了很大的障礙,而且目前所介紹的只是這套API的一少部分,后續(xù)我將會(huì)繼續(xù)研究這套API的相關(guān)函數(shù)。
以上就是對(duì)JDK的Parser來(lái)解析Java源代碼 的資料整理,后續(xù)繼續(xù)補(bǔ)充相關(guān)資料,謝謝大家對(duì)本站的支持!
總結(jié)
以上是生活随笔為你收集整理的java parser .java_JDK的Parser来解析Java源代码详解的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: 蓝桥杯官网 试题 PREV-274 历届
- 下一篇: java美元兑换,(Java实现) 美元