编译,一般来说就是将源代码转换成机器码的过程,比如在C语言中中,将C语言源代码编译成a.out,但是在Java中的理解可能有点不同,编译指的是将java 源代码转换成class字节码的过程,而不是真正的机器码,这是因为中间隔着一个JVM。虽然对于编译的理解不同,但是编译的过程基本上都是相同的。但是我们熟悉的编译大都是点击一下Eclipse或者Intellij Idea的Run或者Build按钮,但是在点击后究竟发生什么?其实我没仔细了解过,只是知道这个程序运行起来了,但是如果你使用过javac命令去编译代码时,可能了解的就更深一些,据说印度的Java程序员最开始编程的时候使用的都是文本编辑器而不是IDE,这样更能接触底层的过程。
除了使用javac命令编译Java程序,从Java 1.6开始,我们也可以在程序运行时根据程序实际运行来构建一些类并进行编译,这需要JDK提供给我们一些可供调用的接口来完成编译工作。
一、编译源码需要啥?
那么问题来了,如果要了解运行时编译的过程和对应的接口,首先要明白的就是编译这个过程都会涉及哪些工具和要解决的问题?从我们熟悉的构建过程开始:
编译工具(编译器):显然没有这个东西我们啥也干不了;
要编译的源代码文件:没有这个东西,到底编啥呢?
源代码、字节码文件的管理:其实这里靠的是文件系统的支持,包括文件的创建和管理;
编译过程中的选项:要编译的代码版本、目标,源代码位置,classpath和编码等等,见相关文章;
编译中编译器输出的诊断信息:告诉你编译成功还是失败,会有什么隐患提出警告信息;
按照这些信息,JDK也提供了可编程的接口对象上述信息,这些API全部放在javax.tools包下,对应上面的信息如下:
编译器:涉及到的接口和类如下:
JavaCompiler
JavaCompiler.CompilationTask
ToolProvider
在上面的接口和类中,ToolProvider类似是一个工具箱,它可以提供JavaCompiler类的实例并返回,然后该实例可以获取JavaCompiler.CompilationTask实例,然后由JavaCompiler.CompilationTask实例来执行对应的编译任务,其实这个执行过程是一个并发的过程。
源代码文件:涉及到接口和类如下:
FileObject
ForwardingFileObject
JavaFileObject
JavaFileObject.Kind
ForwardingJavaFileObject
SimpleJavaFileObject
上述后面的4个接口和类都是FileObject子接口或者实现类,FIleObject接口代表了对文件的一种抽象,可以包括普通的文件,也可以包括数据库中的数据库等,其中规定了一些操作,包括读写操作,读取信息,删除文件等操作。我们要用的其实是JavaFileObject接口,其中还增加了一些操作Java源文件和字节码文件特有的API,而SimpleJavaFileObject是JavaFileObject接口的实现类,但是其中你可以发现很多的接口其实就是直接返回一个值,或者抛出一个异常,并且该类的构造器由protected修饰的,所以要实现复杂的功能,需要我们必须扩展这个类。ForwardingFileObject、ForwardingJavaFileObject类似,其中都是包含了对应的FileObject和JavaFileObject,并将方法的执行委托给这些对象,它的目的其实就是为了提高扩展性。
文件的创建和管理:涉及接口和类如下:
JavaFileManager
JavaFileManager.Location
StandardJavaFileManager
ForwardingJavaFileManager
StandardLocation
JavaFileManager用来创建JavaFileObject,包括从特定位置输出和输入一个JavaFileObject,ForwardingJavaFileManager也是出于委托的目的。而StandardJavaFileManager是JavaFileManager直接实现类,JavaFileManager.Location和StandardLocation描述的是JavaFileObject对象的位置,由JavaFileManager使用来决定在哪创建或者搜索文件。由于在javax.tools包下没有JavaFileManager对象的实现类,如果我们想要使用,可以自己实现该接口,也可以通过JavaCompiler类中的getStandardFileManager完成,如下:
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
DiagnosticCollector
// 该JavaFileManager实例是com.sun.tools.javac.file.JavacFileManager
JavaFileManager manager= compiler.getStandardFileManager(collector, null, null);
编译选项的管理:
OptionChecker
这个接口基本上没有用过。
诊断信息的收集:涉及接口和类如下:
Diagnostic
DiagnosticListener
Diagnostic.Kind
DiagnosticCollector
Diagnostic会输出编译过程中产生的问题,包括问题的信息和出现问题的定位信息,问题的类别则在Diagnostic.Kind中定义。DiagnosticListener则是从编译器中获取诊断信息,当出现诊断信息时则会调用其中的report方法,DiagnosticCollector则是进一步实现了DiagnosticListener,并将诊断信息收集到一个list中以便处理。
在Java源码运行时编译的时候还会遇到一个与普通编译不同的问题,就是类加载器的问题,由于这个问题过大,而且比较核心,将会专门写一篇文章介绍。
二、如何在运行时编译源代码?
好了说了这么多了,其实都是为了下面的实例作为铺垫,我们还是从上述的几个组件来说明。
1、准备编译器对象
这里只有一种方法,如下:
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
// ......
// 在其他实例都已经准备完毕后, 构建编译任务, 其他实例的构建见如下
Boolean result = compiler.getTask(null, manager, collector, options,null,Arrays.asList(javaFileObject));
2、诊断信息的收集
// 初始化诊断收集器
DiagnosticCollector
// ......
// 编译完成之后,获取编译过程中的诊断信息
collector.getDiagnostics().forEach(item -> System.out.println(item.toString()))
在这个过程中可以通过Diagnostic实例获取编译过程中出错的行号、位置以及错误原因等信息。
3、源代码文件对象的构建
由于JDK提供的FileObject、ForwardingFileObject、JavaFileObject、ForwardingJavaFileObject、SimpleJavaFileObject都无法直接使用,所以我们需要根据需求自定义,此时我们要明白SimpleJavaFileObject类中的哪些方法是必须要覆盖的,可以看如下过程:
这里写图片描述
下面是调用compiler中的getTask方法时的调用栈,可以看出从main()方法中开始调用getTask方法开始,直到编译工作开始进行,首先读取源代码,调用com.sun.tools.javac.main包中的readSource()方法,源代码如下:
public CharSequence readSource(JavaFileObject filename) {
try {
inputFiles.add(filename);
return filename.getCharContent(false);
} catch (IOException e) {
log.error("error.reading.file", filename, JavacFileManager.getMessage(e));
return null;
}
}