JavaCompiler --JDK6 API的简介.docx

JavaCompiler -JDK6 API的简介在非常多Java应用中需要在程式中调用Java编译器来编译和运行。但在早期的版本中(Java SE5及以前版本)中只能通过tools.jar中的com.sun.tools.javac包来调用Java编译器，但由于tools.jar不是标准的Java库，在使用时必须要设置这个jar的路径。而在Java SE6中为我们提供了标准的包来操作Java编译器，这就是javax.tools包。使用这个包，我们能不用将jar文件路径添加到classpath中了。 一、使用JavaCompiler接口来编译Java源程式使用Java API来编译Java源程式有非常多方法，目前让我们来看一种最简单的方法，通过JavaCompiler进行编译。我们能通过ToolProvider类的静态方法getSystemJavaCompiler来得到一个JavaCompiler接口的实例。JavaCompilercompiler=ToolProvider.getSystemJavaCompiler();JavaCompiler中最核心的方法是run。通过这个方法能编译java源程式。这个方法有3个固定参数和1个可变参数(可变参数是从Jave SE5开始提供的一个新的参数类型，用type argu表示)。前3个参数分别用来为java编译器提供参数、得到Java编译器的输出信息及接收编译器的错误信息，后面的可变参数能传入一个或多个Java源程式文件。如果run编译成功，返回0。intrun(InputStreamin,OutputStreamout,OutputStreamerr,String.arguments)如果前3个参数传入的是null，那么run方法将以标准的输入、输出代替，即System.in、System.out和System.err。如果我们要编译一个test.java文件，并将使用标准输入输出，run的使用方法如下：intresults=tool.run(null,null,null,test.java);下面是使用JavaCompiler的完整代码：import java.io.*;import javax.tools.*;public class test_compilerapipublic static void main(String args) throws IOExceptionJavaCompiler compiler = ToolProvider.getSystemJavaCompiler();int results = compiler.run(null, null, null, test.java);System.out.println(results = 0)?编译成功:编译失败);/ 在程式中运行testRuntime run = Runtime.getRuntime();Process p = run.exec(java test);BufferedInputStream in = new BufferedInputStream(p.getInputStream();BufferedReader br = new BufferedReader(new InputStreamReader(in);String s;while (s = br.readLine() != null)System.out.println(s); public class testpublic static void main(String args) throws Exception编译成功的输出结果： 编译成功 JavaCompiler测试成功编译失败的输出结果：test.java:9: 未找到符号符号： 方法 printlnln(java.lang.String)位置： 类 java.io.PrintStreamSystem.out.printlnln(JavaCompiler测试成功！);1 错误编译失败二、使用StandardJavaFileManager编译Java源程式在第一部分我们讨论调用java编译器的最容易的方法。这种方法能非常好地工作，但他确不能更有效地得到我们所需要的信息，如标准的输入、输出信息。而在Java SE6中最佳的方法是使用StandardJavaFileManager类。这个类能非常好地控制输入、输出，并且能通过DiagnosticListener得到诊断信息，而DiagnosticCollector类就是listener的实现。使用StandardJavaFileManager需要两步。首先建立一个DiagnosticCollector实例及通过JavaCompiler的getStandardFileManager()方法得到一个StandardFileManager对象。最后通过CompilationTask中的call方法编译源程式。在使用这种方法调用Java编译时最复杂的方法就是getTask，下面让我们讨论一下getTask方法。这个方法有如下所示的6个参数。getTask(Writer out,JavaFileManager fileManager,DiagnosticListener diagnosticListener,Iterable options,Iterable classes,Iterable compilationUnits)这些参数大多数都可为null。他们的含义所下。o ?out:：用于输出错误的流，默认是System.err。 o ?fileManager:：标准的文件管理。 o ?diagnosticListener: 编译器的默认行为。 o ?options: 编译器的选项 o ?classes：参和编译的class。最后一个参数compilationUnits不能为null，因为这个对象保存了你想编译的Java文件。在使用完getTask后，需要通过StandardJavaFileManager的getJavaFileObjectsFromFiles或getJavaFileObjectsFromStrings方法得到compilationUnits对象。调用这两个方法的方式如下：.Iterable getJavaFileObjectsFromFiles(Iterable files)Iterable getJavaFileObjectsFromStrings(Iterable names)String filenames = ;Iterable compilationUnits =fileManager.getJavaFileObjectsFromFiles(Arrays.asList(filenames);JavaCompiler.CompilationTask task = compiler.getTask(null, fileManager,diagnostics, options, null, compilationUnits);最后需要关闭fileManager.close();下面是个完整的演示程式。import java.io.*;import java.util.*;import javax.tools.*;public class test_compilerapiprivate static void compilejava() throws ExceptionJavaCompiler compiler = ToolProvider.getSystemJavaCompiler();/ 建立DiagnosticCollector对象 DiagnosticCollector diagnostics = new DiagnosticCollector(); StandardJavaFileManager fileManager = compiler.getStandardFileManager(diagnostics, null, null);/ 建立用于保存被编译文件名的对象/ 每个文件被保存在一个从JavaFileObject继承的类中 Iterable compilationUnits = fileManager.getJavaFileObjectsFromStrings(Arrays asList(test3.java);JavaCompiler.CompilationTask task = compiler.getTask(null, fileManager,diagnostics, null, null, compilationUnits);/ 编译源程式boolean success = task.call();fileManager.close();System.out.println(success)?编译成功:编译失败);public static void main(String args) throws Exception如果想得到具体的编译错误，能对Diagnostics进行扫描，代码如下： for (Diagnostic diagnostic : diagnostics.getDiagnostics()System.out.printf(Code: %s%n +Kind: %s%n +Position: %s%n +Start Position: %s%n +End Position: %s%n +Source: %s%n +Message: %s%n,diagnostic.getCode(), diagnostic.getKind(),diagnostic.getPosition(), diagnostic.getStartPosition(),diagnostic.getEndPosition(), diagnostic.getSource(),diagnostic.getMessage(null);被编译的test.java代码如下：public class testpublic static void main(String args) throws Exceptionaa; /错误语句System.out.println(JavaCompiler测试成功！);在这段代码中多写了个aa，得到的编译错误为：Code: compiler.err.not.stmtKind: ERRORPosition: 89Start Position: 89End Position: 89Source: test.javaMessage: test.java:5: 不是语句Success: false通过JavaCompiler进行编译都是在当前目录下生成.class文件，而使用编译选项能改动这个默认目录。编译选项是个元素为String类型的Iterable集合。如我们能使用如下代码在D盘根目录下生成.class文件。Iterable options = Arrays.asList(-d, d:);JavaCompiler.CompilationTask task = compiler.getTask(null, fileManager,diagnostics, options, null, compilationUnits); 在上面的例子中options处的参数为null，而要传递编译器的参数，就需要将options传入。有时我们编译一个Java源程式文件，而这个源程式文件需要另几个Java文件，而这些Java文件又在另外一个目录，那么这就需要为编译器指定这些文件所在的目录。Iterable options = Arrays.asList(-sourcepath, d:src);上面的代码指定的被编译Java文件所依赖的源文件所在的目录。三、从内存中编译JavaCompiler不仅能编译硬盘上的Java文件，而且还能编译内存中的Java代码，然后使用reflection来运行他们。我们能编写一个JavaSourceFromString类，通过这个类能输入Java原始码。一但建立这个对象，你能向其中输入任意的Java代码，然后编译和运行，而且无需向硬盘上写.class文件。import java.lang.reflect.*;import java.io.*;import javax.tools.*;import javax.tools.JavaCompiler.CompilationTask;import java.util.*;import .*;public class test_compilerapiprivate static void compilerJava() throws ExceptionJavaCompiler compiler = ToolProvider.getSystemJavaCompiler();DiagnosticCollector diagnostics = new DiagnosticCollector();/ 定义一个StringWriter类，用于写Java程式StringWriter writer = new StringWriter();PrintWriter out = new PrintWriter(writer);/ 开始写Java程式out.println(public class HelloWorld );out.println( public static void main(String args) );out.println( System.out.println(Hello, World););out.println( );out.println();out.close();/为这段代码取个名子：HelloWorld，以便以后使用reflection调用JavaFileObject file = new JavaSourceFromString(HelloWorld, writer.toString();Iterable compilationUnits = Arrays.asList(file);JavaCompiler.CompilationTask task = compiler.getTask(null, null,diagnostics, null, null, compilationUnits);boolean success = task.call();System.out.println(Success: + success);/ 如果成功，通过reflection执行这段Java程式if (success)System.out.println(-输出-);Class.forName(HelloWorld).getDeclaredMethod(main, new Class String.class ).invoke(null, new Object null );System.out.println(-输出 -); public static void main(String args) throws Exception/ 用于传递源程式的JavaSourceFromString类class JavaSourceFromString extends SimpleJavaFileObjectfinal String code;JavaSourceFromString(String name, String code)super(URI.create(string:/ + name.replace(., /)+ Kind.SOURCE.extension), Kind.SOURCE);this.code = code;Overridepublic CharSequence getCharContent(boolean ignoreEncodingErrors)return code;public interface JavaCompilerextends Tool, OptionChecker从程序中调用 Java 编程语言编译器的接口。编译过程中，编译器可能生成诊断信息（例如，错误消息）。如果提供了诊断侦听器，那么诊断信息将被提供给该侦听器。如果没有提供侦听器，那么除非另行指定，否则诊断信息将被格式化为未指定的格式，并被写入到默认输出 System.err。即使提供了诊断侦听器，某些诊断信息也可能不适合 Diagnostic，并将被写入到默认输出。编译器工具具有关联的标准文件管理器，此文件管理器是工具本地的（或内置的）。可以通过调用 getStandardFileManager 获取该标准文件管理器。只要满足下面方法详细描述中的任意附加需求，编译器工具就必须与文件管理器一起运行。如果没有提供文件管理器，则编译器工具将使用标准文件管理器，比如 getStandardFileManager 返回的标准文件管理器。实现此接口的实例必须符合 Java Language Specification 并遵照 Java Virtual Machine 规范生成类文件。Tool 接口中定义了这些规范的版本。 此外，支持 SourceVersion.RELEASE_6 或更高版本的此接口的实例还必须支持注释处理。编译器依赖于两种服务：诊断侦听器和文件管理器。虽然此包中的大多数类和接口都定义了编译器（和一般工具）的 API，但最好不要在应用程序中使用接口 DiagnosticListener、JavaFileManager、FileObject 和 JavaFileObject。应该实现这些接口，用于为编译器提供自定义服务，从而定义编译器的 SPI。此包中有很多类和接口，它们被设计用于简化 SPI 的实现，以自定义编译器行为：StandardJavaFileManager 实现此接口的每个编译器都提供一个标准的文件管理器，以便在常规文件上进行操作。StandardJavaFileManager 接口定义了从常规文件创建文件对象的其他方法。 标准文件管理器有两个用途： * 自定义编译器如何读写文件的基本构建块 * 在多个编译任务之间共享 重新使用文件管理器可能会减少扫描文件系统和读取 jar 文件的开销。标准文件管理器必须与多个顺序编译共同工作，尽管这样做并不能减少开销，下例是建议的编码模式：Java代码 1. Filesfiles1=.;/inputforfirstcompilationtask 2. Filesfiles2=.;/inputforsecondcompilationtask 3. 4. JavaCompilercompiler=ToolProvider.getSystemJavaCompiler(); 5. StandardJavaFileManagerfileManager=compiler.getStandardFileManager(null,null,null); 6. 7. IterablecompilationUnits1= 8. fileManager.getJavaFileObjectsFromFiles(Arrays.asList(files1); 9. compiler.getTask(null,fileManager,null,null,null,compilationUnits1).call(); 10. 11. IterablecompilationUnits2= 12. fileManager.getJavaFileObjects(files2);/usealternativemethod 13. /reusethesamefilemanagertoallowcachingofjarfiles 14. compiler.getTask(null,fileManager,null,null,null,compilationUnits2).call(); 15. 16. fileManager.close(); Files files1 = .; / input for first compilation task Files files2 = .; / input for second compilation task JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); StandardJavaFileManager fileManager = compiler.getStandardFileManager(null, null, null); Iterable compilationUnits1 = fileManager.getJavaFileObjectsFromFiles(Arrays.asList(files1); compiler.getTask(null, fileManager, null, null, null, compilationUnits1).call(); Iterable compilationUnits2 = fileManager.getJavaFileObjects(files2); / use alternative method / reuse the same file manager to allow caching of jar files compiler.getTask(null, fileManager, null, null, null, compilationUnits2).call(); fileManager.close(); DiagnosticCollector 用于将诊断信息收集在一个列表中，例如：Java代码 1. IterablecompilationUnits=.; 2. JavaCompilercompiler=ToolProvider.getSystemJavaCompiler(); 3. DiagnosticCollectordiagnostics=newDiagnosticCollector(); 4. StandardJavaFileManagerfileManager=compiler.getStandardFileManager(diagnostics,null,null); 5. compiler.getTask(null,fileManager,diagnostics,null,null,compilationUnits).call(); 6. 7. for(Diagnosticdiagnostic:diagnostics.getDiagnostics() 8. System.out.format(Erroronline%din%d%n, 9. diagnostic.getLineNumber() 10. diagnostic.getSource().toUri(); 11. 12. fileManager.close();Iterable compilationUnits = .; JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); DiagnosticCollector diagnostics = new DiagnosticCollector(); StandardJavaFileManager fileManager = compiler.getStandardFileManager(diagnostics, null, null); compiler.getTask(null, fileManager, diagnostics, null, null, compilationUnits).call(); for (Diagnostic diagnostic :diagnostics.getDiagnostics() System.out.format(Error on line %d in %d%n, diagnostic.getLineNumber() diagnostic.getSource().toUri(); fileManager.close(); ForwardingJavaFileManager、ForwardingFileObject 和 ForwardingJavaFileObject 子类化不可用于重写标准文件管理器的行为，因为标准文件管理器是通过调用编译器上的方法创建的，而不是通过调用构造方法创建的。应该使用转发（或委托）。允许自定义行为时，这些类使得将多个调用转发到给定文件管理器或文件对象变得容易。例如，考虑如何将所有的调用记录到 JavaFileManager.flush()：Java代码 1. finalLoggerlogger=.; 2. IterablecompilationUnits=.; 3. JavaCompilercompiler=ToolProvider.getSystemJavaCompiler(); 4. StandardJavaFileManagerstdFileManager=compiler.getStandardFileManager(null,null,null); 5. JavaFileManagerfileManager=newForwardingJavaFileManager(stdFileManager) 6. publicvoidflush() 7. logger.entering(StandardJavaFileManager.class.getName(),flush); 8. super.flush(); 9. logger.exiting(StandardJavaFileManager.class.getName(),flush); 10. 11. ; 12. compiler.getTask(null,fileManager,null,null,null,compilationUnits).call();final Logger logger = .; Iterable compilationUnits = .; JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); StandardJavaFileManager stdFileManager = compiler.getStandardFileManager(null, null, null); JavaFileManager fileManager = new ForwardingJavaFileManager(stdFileManager) public void flush() logger.entering(StandardJavaFileManager.class.getName(), flush); super.flush(); logger.exiting(StandardJavaFileManager.class.getName(), flush); ; compiler.getTask(null, fileManager, null, null, null, compilationUnits).call(); SimpleJavaFileObject 此类提供基本文件对象实现，该实现可用作创建文件对象的构建块。例如，下例显示了如何定义表示存储在字符串中的源代码的文件对象：Java代码 1. /* 2. *Afileobjectusedtorepresentsourcecomingfromastring. 3. */4. publicclassJavaSourceFromStringextendsSimpleJavaFileObject 5. /* 6. *Thesourcecodeofthisfile. 7. */8. finalStringcode; 9. 10. /* 11. *ConstructsanewJavaSourceFromString. 12. *paramnamethenameofthecompilationunitrepresentedbythisfileobject 13. *paramcodethesourcecodeforthecompilationunitrepresentedbythisfileobject 14. */15. JavaSourceFromString(Stringname,Stringcode) 16