探索 Eclipse 的 ASTParser
如何使用这种解析器生成代码
简介: 如果曾经编写过处理代码的应用程序,就会知道事情可能变得非常复杂,尤其在使用像 Java™ 这样复杂的语言时。不过对于那些使用 Eclipse 的人来说,有一个好消息:可以利用 Java Development Tooling (JDT) 和 ASTParser。本文就说明如何做。
Eclipse JDT 提供了操纵 Java 源代码、检测错误、执行编译和启动程序的的 API。本文将说明如何使用 ASTParser 从头创建一个 Java 类,同时介绍如何使用 JDT 服务编译生成的代码。
Eclipse JDT 有自己的文档对象模型(DOM),其思想和众所周知的 XML DOM 是一致的:抽象的语法树(AST)。
Eclipse V3.0.2 支持 Java Language Specification, Second Edition (JLS2),能够正确解析用各种 Java 语言版本(最高到 J2SE 1.4)编写的程序。对 JLS3 的支持正在进行之中,在下一个重要的 Eclipse 版本中,就能够解析用新的 J2SE 1.5 结构编写的程序。
本文提供了两个示例应用程序,这两个示例都包含在一个称为 ASTExplorer 的 Eclipse 项目中:
- ASTMain
- ASTExplorer
ASTMain 生成一个 Java 类,然后编译这个类并运行其 main()
方法。该方法将使用按钮创建一个 SWT Shell 物件。
ASTExplorer 解析给定的 Java 类,显示其 AST 层次结构。它有三个面板:一个包含 AST Tree 视图显示 AST 层次结构,一个显示源代码,还有一个显示解析器错误。
图 1 显示了执行中的 ASTExplorer 界面。注意,如果选择一个节点,源代码中对应的位置将使用蓝色突出显示。解析错误用红色突出显示。
图 1. 运行中的 ASTExplorer
这些例子是在 Eclipse V3.0.1 及 V3.0.2、Windows® XP Professional SP2、Sun J2SDK 1.4.2.05 环境中经过测试的。文中的项目类路径是用于 Eclipse V3.0.2 的。如果需要在 Eclipse V3.0.1 下运行,只需要修改类路径指向正确的插件即可。
建议在阅读后面的内容之前先下载示例应用程序。这里的关键词是探索,阅读本文的同时运行给出的例子有助于提高学习的效率。
AST 层次结构的最上层是 ASTNode。每个 Java 结构都用它来表示。多数节点的名称意义都很明确,如 Comment、CastExpression 等。可以使用 AST 类的方法(比如 newBlock()
、newBreakStatement()
等)来创建节点。Java 类用 Compilation Unit(编译单元)节点表示。清单 1 展示了如何创建编译单元。
清单 1. 创建编译单元
ASTParser parser = ASTParser.newParser(AST.JLS2); parser.setSource("".toCharArray()); CompilationUnit unit = (CompilationUnit) parser.createAST(null); unit.recordModifications(); AST ast = unit.getAST(); |
要注意 ASTParser 对 JLS2 的配置,然后使用空数组初始化解析器。如果不这样做,就会在访问编译单元时遇到异常。
解析已有代码也需要同样的步骤。该例中要解析的是 org.eclipse.core.runtime 的一个实例。createAST()
方法的 IProgressMonitor 可以在长时间的解析中提供反馈信息,后面将示范它的用法。
调用 recordModifications()
将启动对节点修改的监控。调用这个方法很重要,因为这样可以在以后通过检索节点的修改来访问源代码。
最后,从编译单元中访问 AST 的所有者,并在后续的节点创建中使用它。AST 树中的所有节点都属于同一个所有者。任何不是该所有者创建的节点都要先通过导入才能加入到树中。现在就可以开始创建 Java 类了,清单 2 展示了如何创建一个包。
清单 2. 创建 Package
PackageDeclaration packageDeclaration = ast.newPackageDeclaration(); unit.setPackage(packageDeclaration); packageDeclaration.setName(ast.newSimpleName("astexplorer")); |
有几个节点方法要使用 Name 节点。Name 节点可以是 SimpleName 或者 QualifiedName,后者是一组 SimpleNames。QualifiedName 的外部表示是(比方说)org.eclipse.swt.widgets。因此,实质上只要您使用点(dot),您就是在使用 QualifiedName。ast.newName() 方法接收一个字符串数组来创建 Name 节点。在代码示例中,我提供了一各方便的方法来解析带点(dot)的字符串,并创建字符串数组。
有 6 种主要的节点组:BodyDeclaration、Comment、Expression、Statement、Type 和 VariableDeclaration。BodyDeclarations 可以是类中的任何声明。比如,声明 private Point minimumSize;
的创建代码如下所示:
清单 3. 创建 VariableDeclaration
Va |