JDK的Parser來解析Java原始碼詳解_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 = fileManager.getJavaFileObjects(path);  JavaCompiler.CompilationTask compilationTask = javacTool.getTask(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",      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(); }}</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: Nullablevariable name: foo, type: String, kind: VARIABLE, package: com.ragnarok.javaparservariable name: a, type: Foo, kind: VARIABLE, package: com.ragnarok.javaparser

這裡我們是首先通過JavaCompiler.CompilationTask解析了源檔案之後，再使用自訂的SourceVisitor（繼承自TreeScanner）來對原始碼的結構進行訪問，在SourceVisitor類中，通過重載visitVariable來對一個編譯單元（單個原始碼檔案）進行解析，訪問其中的所有的變數，這裡可以看出，我們沒有辦法拿到這個變數類型的全限定名（包含包名），只能拿到的對應的簡單名字，因此，類型的確定需要外部實現自行確定，例如可以通過記錄類所在的包名，遞迴的搜尋整個原始碼目錄來跟蹤所有類的全限定名，尋找import中是否包含對應的類型等。

TreeScanner中除了visitVariable方法外，還包含了大量其他的visitXYZ方法，例如，可以遍曆所有的import，方法定義，Annotation等，更具體可以查看OpenJDK中關於這個的原始碼

這裡再來看下另外一個例子，重載visitClass方法，訪問所有的內部類以及類本身：

@Overridepublic 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<!--? extends AnnotationTree--> 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); }

這裡簡單的列印了類名以及變數的名稱，類型，annotation類型，執行上面的代碼，結果如下：

class name: Uservariable: foo, annotaion: Nullablevariable: aclass name: Foovariable: fooString

可以看出我們把類名以及類中的變數都列印了出來。而在visitClass方法中，我們可以通過getMembers方法拿到類中所有的成員，包括變數，方法，annotation等，分別對應著不同的類型，例如變數就對應著VariableTree類型，方法就對應的MethodTree類型。

總得來說，雖然實際上使用並不算特別複雜，但是由於缺少文檔，對使用造成了很大的障礙，而且目前所介紹的只是這套API的一少部分，後續我將會繼續研究這套API的相關函數。

以上就是對JDK的Parser來解析Java原始碼 的資料整理，後續繼續補充相關資料，謝謝大家對本站的支援！