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: 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源代码 的资料整理,后续继续补充相关资料,谢谢大家对本站的支持!

以上是小编为您精心准备的的内容,在的博客、问答、公众号、人物、课程等栏目也有的相关内容,欢迎继续使用右上角搜索按钮进行搜索jdk
mp4parser 详解、sgmlparser详解、mp4parser 裁剪 详解、robotparser详解、xmlpullparser解析xml,以便于您获取更多的相关知识。

时间: 2016-09-20
Tags: jdk

JDK的Parser来解析Java源代码详解_java的相关文章

Java泛型详解_java

1. Why --引入泛型机制的原因     假如我们想要实现一个String数组,并且要求它可以动态改变大小,这时我们都会想到用ArrayList来聚合String对象.然而,过了一阵,我们想要实现一个大小可以改变的Date对象数组,这时我们当然希望能够重用之前写过的那个针对String对象的ArrayList实现.     在Java 5之前,ArrayList的实现大致如下: public class ArrayList { public Object get(int i) { ... }

java NIO 详解_java

Java NIO提供了与标准IO不同的IO工作方式: Channels and Buffers(通道和缓冲区):标准的IO基于字节流和字符流进行操作的,而NIO是基于通道(Channel)和缓冲区(Buffer)进行操作,数据总是从通道读取到缓冲区中,或者从缓冲区写入到通道中. Asynchronous IO(异步IO):Java NIO可以让你异步的使用IO,例如:当线程从通道读取数据到缓冲区时,线程还是可以进行其他事情.当数据被写入到缓冲区时,线程可以继续处理它.从缓冲区写入通道也类似. S

Java中关于Null的9个解释(Java Null详解)_java

对于Java程序员来说,null是令人头痛的东西.时常会受到空指针异常(NPE)的骚扰.连Java的发明者都承认这是他的一项巨大失误.Java为什么要保留null呢?null出现有一段时间了,并且我认为Java发明者知道null与它解决的问题相比带来了更多的麻烦,但是null仍然陪伴着Java. 我越发感到惊奇,因为java的设计原理是为了简化事情,那就是为什么没有浪费时间在指针.操作符重载.多继承实现的原因,null却与此正好相反.好吧,我真的不知道这个问题的答案,我知道的是不管null被Ja

Java解析XML格式数据的方法详解_java

最初,XML 语言仅仅是意图用来作为 HTML 语言的替代品而出现的,但是随着该语言的不断发展和完善,人们越来越发现它所具有的优点:例如标记语言可扩展,严格的语法规定,可使用有意义的标记,内容存储和表现分离等等优势注定了该语言从诞生之日起就会走向辉煌. XML 语言在成为 W3C 标准之后进入到了一个快速发展的时期,当然它本身所具有的一系列优点和优势也注定了各大技术厂商对它的偏爱,Java 作为软件行业的一种开发技术也迅速作出了反应,出现了多种对 XML 支持的工具,本文将会从这个角度对 Jav

HttpClient 在Java项目中的使用详解_java

Http协议的重要性相信不用我多说了,HttpClient相比传统JDK自带的URLConnection,增加了易用性和灵活性(具体区别,日后我们再讨论),它不仅是客户端发送Http请求变得容易,而且也方便了开发人员测试接口(基于Http协议的),即提高了开发的效率,也方便提高代码的健壮性.因此熟练掌握HttpClient是很重要的必修内容,掌握HttpClient后,相信对于Http协议的了解会更加深入. 一.简介 HttpClient是Apache Jakarta Common下的子项目,用

Java中自然排序和比较器排序详解_java

前言 当指执行插入排序.希尔排序.归并排序等算法时,比较两个对象"大小"的比较操作.我们很容易理解整型的 i>j 这样的比较方式,但当我们对多个对象进行排序时,如何比较两个对象的"大小"呢?这样的比较 stu1 > stu2 显然是不可能通过编译的.为了解决如何比较两个对象大小的问题,JDK提供了两个接口 java.lang.Comparable 和 java.util.Comparator . 一.自然排序:java.lang.Comparable C

JAVA获取CLASSPATH路径的方法详解_java

ClassLoader 提供了两个方法用于从装载的类路径中取得资源: public URL getResource (String name); public InputStream getResourceAsStream (String name);        这里name是资源的类路径,它是相对与"/"根路径下的位置.getResource得到的是一个URL对象来定位资源,而getResourceAsStream取得该资源输入流的引用保证程序可以从正确的位置抽取数据.     

Java 23种设计模型详解_java

设计模式(Design Patterns)                                   --可复用面向对象软件的基础 设计模式(Design pattern)是一套被反复使用.多数人知晓的.经过分类编目的.代码设计经验的总结.使用设计模式是为了可重用代码.让代码更容易被他人理解.保证代码可靠性. 毫无疑问,设计模式于己于他人于系统都是多赢的,设计模式使代码编制真正工程化,设计模式是软件工程的基石,如同大厦的一块块砖石一样.项目中合理的运用设计模式可以完美的解决很多问题,每

Java 高并发十: JDK8对并发的新支持详解_java

1. LongAdder 和AtomicLong类似的使用方式,但是性能比AtomicLong更好. LongAdder与AtomicLong都是使用了原子操作来提高性能.但是LongAdder在AtomicLong的基础上进行了热点分离,热点分离类似于有锁操作中的减小锁粒度,将一个锁分离成若干个锁来提高性能.在无锁中,也可以用类似的方式来增加CAS的成功率,从而提高性能. LongAdder原理图: AtomicLong的实现方式是内部有个value 变量,当多线程并发自增,自减时,均通过CA