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

前言 当指执行插入排序.希尔排序.归并排序等算法时,比较两个对象"大小"的比较操作.我们很容易理解整型的 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

Java虚拟机详解----JVM常见问题总结

[正文] 声明:本文只是做一个总结,有关jvm的详细知识可以参考本人之前的系列文章,尤其是那篇:Java虚拟机详解04----GC算法和种类.那篇文章和本文是面试时的重点. 面试必问关键词:JVM垃圾回收.类加载机制.   先把本文的目录画一个思维导图:(图的源文件在本文末尾)   一.Java引用的四种状态: 强引用: 用的最广.我们平时写代码时,new一个Object存放在堆内存,然后用一个引用指向它,这就是强引用. 如果一个对象具有强引用,那垃圾回收器绝不会回收它.当内存空间不足,Java

java关键字(详解)

基本类型 1 boolean 布尔型 2 byte 字节型 3 char 字符型 4 double 双精度 5 float 浮点 6 int 整型 7 long 长整型 8 short 短整型 9 null 空 10 true 真 11 false 假 程序控制语句 1 break 跳出中断 2 continue 继续 3 return 返回 4 do 运行 5 while 循环 6 if 如果 7 else 否则 8 for 循环 9 instanceof 实例 10 switch 观察 11

HBase Java API详解

[本文转自HBase Java API详解] HBase是Hadoop的数据库,能够对大数据提供随机.实时读写访问.他是开源的,分布式的,多版本的,面向列的,存储模型. 在讲解的时候我首先给大家讲解一下HBase的整体结构,如下图: HBase Master是服务器负责管理所有的HRegion服务器,HBase Master并不存储HBase服务器的任何数据,HBase逻辑上的表可能会划分为多个HRegion,然后存储在HRegion Server群中,HBase Master Server中存

Java设计模式详解之门面模式(外观模式)_java

门面模式(Facade Pattern)也叫外观模式,它隐藏系统的复杂性,并向客户端提供一个可以访问系统的接口.这种类型的设计模式属于结构型模式,它向现有的系统添加一个接口,来隐藏系统的复杂性,为子系统中的一组接口提供了一个统一的高层访问接口,这个接口使得子系统更容易被访问或使用.这种模式涉及到一个单一的类,该类提供了客户端请求的简化方法和对现有系统类方法的委托调用. 简而言之,就是把一堆复杂的流程封装成一个接口供给用户更简单的使用,这个设计模式里有三个角色: 1)门面角色( facade ):

Java NIO 详解(一)

NIO即新的输入输出,这个库是在JDK1.4中才引入的.它在标准java代码中提供了高速的面向块的IO操作. 一.基本概念描述 1.1 I/O简介 I/O即输入输出,是计算机与外界世界的一个借口.IO操作的实际主题是操作系统.在java编程中,一般使用流的方式来处理IO,所有的IO都被视作是单个字节的移动,通过stream对象一次移动一个字节.流IO负责把对象转换为字节,然后再转换为对象. 关于Java IO相关知识请参考我的另一篇文章:Java IO 详解 1.2 什么是NIO NIO即New