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 = 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: 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", 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: user
variable: foo, annotaion: nullable
variable: a
class name: foo
variable: foostring

可以看出我们把类名以及类中的变量都打印了出来。而在visitclass方法中，我们可以通过getmembers方法拿到类中所有的成员，包括变量，方法，annotation等，分别对应着不同的类型，例如变量就对应着variabletree类型，方法就对应的methodtree类型。

总得来说，虽然实际上使用并不算特别复杂，但是由于缺少文档，对使用造成了很大的障碍，而且目前所介绍的只是这套api的一少部分，后续我将会继续研究这套api的相关函数。

以上就是对jdk的parser来解析java源代码 的资料整理，后续继续补充相关资料，谢谢大家对本站的支持！