通过JavaCompiler进行编译java文件（转载）

通过JavaCompiler进行编译都是在当前目录下生成.class文件，而使用编译选项可以改变这个默认目录。编译选项是一个元素为String类型的Iterable集合。如我们可以使用如下代码在D盘根目录下生成.class文件。

 Iterable options = Arrays.asList("-d", "d:\\");

JavaCompiler.CompilationTask task = compiler.getTask(null, fileManager,

diagnostics, options, null, compilationUnits);

 

 

06 年底，Sun 公司发布了 Java Standard Edition 6（Java SE 6）的最终正式版，代号 Mustang（野马）。跟 Tiger（Java SE 5）相比，Mustang 在性能方面有了不错的提升。与 Tiger 在 API 库方面的大幅度加强相比，虽然 Mustang 在 API 库方面的新特性显得不太多，但是也提供了许多实用和方便的功能：在脚本，WebService，XML，编译器 API，数据库，JMX，网络和 Instrumentation 方面都有不错的新特性和功能加强。 本系列 文章主要介绍 Java SE 6 在 API 库方面的部分新特性，通过一些例子和讲解，帮助开发者在编程实践当中更好的运用 Java SE 6，提高开发效率。

本文是其中的第四篇，介绍了 JDK 6 中为在运行时操纵编译器所增加的编译器 API（JSR 199）。您将了解到，利用此 API 开发人员可以在运行时调用 Java 编译器，还可以编译非文本形式的 Java 源代码，最后还能够采集编译器的诊断信息。本文将展开描述这些功能，并使用这些功能构造一个简单的应用 —— 在内存中，直接为一个类生成测试用例。

新 API 功能简介

JDK 6 提供了在运行时调用编译器的 API，后面我们将假设把此 API 应用在 JSP 技术中。在传统的 JSP 技术中，服务器处理 JSP 通常需要进行下面 6 个步骤：

分析 JSP 代码； 
生成 Java 代码； 
将 Java 代码写入存储器； 
启动另外一个进程并运行编译器编译 Java 代码； 
将类文件写入存储器； 
服务器读入类文件并运行； 
但如果采用运行时编译，可以同时简化步骤 4 和 5，节约新进程的开销和写入存储器的输出开销，提高系统效率。实际上，在 JDK 5 中，Sun 也提供了调用编译器的编程接口。然而不同的是，老版本的编程接口并不是标准 API 的一部分，而是作为 Sun 的专有实现提供的，而新版则带来了标准化的优点。

新 API 的第二个新特性是可以编译抽象文件，理论上是任何形式的对象 —— 只要该对象实现了特定的接口。有了这个特性，上述例子中的步骤 3 也可以省略。整个 JSP 的编译运行在一个进程中完成，同时消除额外的输入输出操作。

第三个新特性是可以收集编译时的诊断信息。作为对前两个新特性的补充，它可以使开发人员轻松的输出必要的编译错误或者是警告信息，从而省去了很多重定向的麻烦。

运行时编译 Java 文件

在 JDK 6 中，类库通过 javax.tools 包提供了程序运行时调用编译器的 API。从这个包的名字 tools 可以看出，这个开发包提供的功能并不仅仅限于编译器。工具还包括 javah、jar、pack200 等，它们都是 JDK 提供的命令行工具。这个开发包希望通过实现一个统一的接口，可以在运行时调用这些工具。在 JDK 6 中，编译器被给予了特别的重视。针对编译器，JDK 设计了两个接口，分别是 JavaCompiler和 JavaCompiler.CompilationTask。

下面给出一个例子，展示如何在运行时调用编译器。

指定编译文件名称（该文件必须在 CLASSPATH 中可以找到）：String fullQuanlifiedFileName = "compile" + java.io.File.separator +"Target.java"; 
获得编译器对象： JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); 
通过调用 ToolProvider 的 getSystemJavaCompiler 方法，JDK 提供了将当前平台的编译器映射到内存中的一个对象。这样使用者可以在运行时操纵编译器。JavaCompiler 是一个接口，它继承了javax.tools.Tool 接口。因此，第三方实现的编译器，只要符合规范就能通过统一的接口调用。同时，tools 开发包希望对所有的工具提供统一的运行时调用接口。相信将来，ToolProvider 类将会为更多地工具提供 getSystemXXXTool 方法。tools 开发包实际为多种不同工具、不同实现的共存提供了框架。

编译文件：int result = compiler.run(null, null, null, fileToCompile); 
获得编译器对象之后，可以调用 Tool.run 方法对源文件进行编译。Run 方法的前三个参数，分别可以用来重定向标准输入、标准输出和标准错误输出，null 值表示使用默认值。清单 1 给出了一个完整的例子：

清单 1. 程序运行时编译文件
01 package compile;
02 import java.util.Date;
03 public class Target {
04   public void doSomething(){
05     Date date = new Date(10, 3, 3); 
         // 这个构造函数被标记为deprecated, 编译时会
         // 向错误输出输出信息。
06     System.out.println("Doing...");
07   }
08 }

 

 

 

09 package compile;
10 import javax.tools.*;
11 import java.io.FileOutputStream;
12 public class Compiler {
13   public static void main(String[] args) throws Exception{
14     String fullQuanlifiedFileName = "compile" + java.io.File.separator +
             "Target.java";     
15     JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();

16     FileOutputStream err = new FileOutputStream("err.txt");

17     int compilationResult = compiler.run(null, null, err, fullQuanlifiedFileName);

18     if(compilationResult == 0){
19       System.out.println("Done");
20     } else {
21       System.out.println("Fail");
22     }
23   }
24 }
   
首先运行 <JDK60_INSTALLATION_DIR>\bin\javac Compiler.java，然后运行 <JDK60_INSTALLATION_DIR>\jdk1.6.0\bin\java compile.Compiler。屏幕上将输出 Done ，并会在当前目录生成一个 err.txt 文件，文件内容如下：

Note: compile/Target.java uses or overrides a deprecated API.
Note: Recompile with -Xlint:deprecation for details.
 仔细观察 run 方法，可以发现最后一个参数是 String...arguments，是一个变长的字符串数组。它的实际作用是接受传递给 javac 的参数。假设要编译 Target.java 文件，并显示编译过程中的详细信息。命令行为：javac Target.java -verbose。相应的可以将 17 句改为：

int compilationResult = compiler.run(null, null, err, “-verbose”，fullQuanlifiedFileName);
编译非文本形式的文件

JDK 6 的编译器 API 的另外一个强大之处在于，它可以编译的源文件的形式并不局限于文本文件。JavaCompiler 类依靠文件管理服务可以编译多种形式的源文件。比如直接由内存中的字符串构造的文件，或者是从数据库中取出的文件。这种服务是由 JavaFileManager 类提供的。通常的编译过程分为以下几个步骤：

解析 javac 的参数； 
在 source path 和/或 CLASSPATH 中查找源文件或者 jar 包； 
处理输入，输出文件； 
在这个过程中，JavaFileManager 类可以起到创建输出文件，读入并缓存输出文件的作用。由于它可以读入并缓存输入文件，这就使得读入各种形式的输入文件成为可能。JDK 提供的命令行工具，处理机制也大致相似，在未来的版本中，其它的工具处理各种形式的源文件也成为可能。为此，新的 JDK 定义了 javax.tools.FileObject 和 javax.tools.JavaFileObject 接口。任何类，只要实现了这个接口，就可以被 JavaFileManager 识别。

如果要使用 JavaFileManager，就必须构造 CompilationTask。JDK 6 提供了 JavaCompiler.CompilationTask 类来封装一个编译操作。这个类可以通过：

JavaCompiler.getTask (
    Writer out, 
    JavaFileManager fileManager,
    DiagnosticListener<? super JavaFileObject> diagnosticListener,
    Iterable<String> options,
    Iterable<String> classes,
    Iterable<? extends JavaFileObject> compilationUnits
)
 方法得到。关于每个参数的含义，请参见 JDK 文档。传递不同的参数，会得到不同的 CompilationTask。通过构造这个类，一个编译过程可以被分成多步。进一步，CompilationTask 提供了setProcessors(Iterable<? extends Processor>processors) 方法，用户可以制定处理 annotation 的处理器。图 1 展示了通过 CompilationTask 进行编译的过程：

图 1. 使用 CompilationTask 进行编译
JDK 6 的编译器新特性，使得开发者可以更自如的控制编译的过程，这给了工具开发者更加灵活的自由度。通过 API 的调用完成编译操作的特性，使得开发者可以更方便、高效地将编译变为软件系统运行时的服务。而编译更广泛形式的源代码，则为整合更多的数据源及功能提供了强大的支持。相信随着 JDK 的不断完善，更多的工具将具有 API 支持，我们拭目以待。

评论

1 楼 di1984HIT 2014-10-30  

谢谢啊 ~~~