需求
有的时候,可能我们需要在程序运行期间,动态创建字节码并运行。最常见的使用场景就是Spring框架中的动态代理AOP,其本质是Spring框架在运行期间动态创建了一个被代理对象的子类,通过继承来实现代理机制(正因为是通过继承实现的代理,因此Spring aop不能代理终态类,不能代理类中的终态方法[终态类/方法不能继承/覆盖])。在Spring中,使用了一个第三方的字节码生成项目。实际项目中,如果我们有类似需求,当然也可以用这种方法,但是姑且不说这样做的繁琐程度,光是查看这些项目的API文档就足以头疼一阵了,对于某些项目中只有一个很小点需要类似功能来说,这样做的成本略微有点高。(类似这样现成的项目有javassist、cglib)
另一种方法是自己从零开始,直接创建字节码,参考Oracle的文档,自己做一个实现。不过这在理论上可行,实际上比第一种方法难度更高。
最后一种方法,就是本文要介绍的方法,即程序动态的生成Java源文件,由JDK进行编译,最后动态加载到JVM并运行。
变通
由于Java源文件相对较容易生成,是纯文本文件。而Java的编译器是自举的,也就是说Java编译器就是用Java本身编写的,因此从JDK 1.6开始,编译器相关API就一直在SDK中,所以,我们也不需要通过调用命令行的方式来控制javac来编译我们动态生成的Java源文件。
实例
比如存在一个/home/test/src.java
的文件需要被编译成.class
文件:
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
int compilationResult = compiler.run(null, null, null, "/home/test/src.java");
这样就会把/home/test/src.java
编译成src.class
,但是这样操作要求源文件在磁盘上,而且编译后的字节码也会被写到磁盘上。有的时候,我们的Java源文件可能是在内存中动态生成,亦或者是从网络上获取的,只是为了一次执行,不希望写入磁盘。
出于这样的目的,在查阅相关类的API文档后,发现是可以实现这样目的的。只要继承ForwardingJavaFileManager
类就可以实现从内存中直接加载Java源文件,继承并重写URLClassLoader.findClass()
就可以实现将编译结果直接以byte[]形式返回,而不再写入到磁盘文件。(完整代码在文末)
public static Map<String, byte[]> compile(String javaName, String javaSrc) {
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
StandardJavaFileManager stdManager = compiler.getStandardFileManager(null, null, null);
try (MemoryJavaFileManager manager = new MemoryJavaFileManager(stdManager)) {
JavaFileObject javaFileObject = manager.makeStringSource(javaName, javaSrc);
JavaCompiler.CompilationTask task = compiler.getTask(null, manager, null, null, null, Arrays.asList(javaFileObject));
if (task.call())
return manager.getClassBytes();
} catch (IOException e) {
e.printStackTrace();
}
return null;
}
完整代码段
上述的代码逻辑,我进行了部分封装,封装后的代码可以在这里看到,封装后的类使用方法可以参考测试用例。
这里就几个有关的参数说明一下:(具体可以参照封装类的代码)
-
MemoryJavaFileManager.getClassBytes()
的返回类型为Map<String, byte[]>
,其中Key为类名,Value为对应的字节码。一般来说一个.java
文件只对应一个类,但是可能会存在内部类的情况(例如我这个封装的文件),因此一个java源文件是可以生成出多个class文件的。 -
MemoryJavaFileManager.makeStringSource(String, String)
方法- 第一个参数是Java源文件的文件名,因为实际上并不存在磁盘文件,因此这个参数应该是源文件中唯一的那个public修饰符修饰的类名,例如源文件中存在
public class ABC{}
,那么这个参数就应该是ABC.java
,否则编译器会报错,拒绝编译。 - 第二个参数是源文件内容的字符串
- 第一个参数是Java源文件的文件名,因为实际上并不存在磁盘文件,因此这个参数应该是源文件中唯一的那个public修饰符修饰的类名,例如源文件中存在
- 该封装类,在Oracle JDK 1.8/OpenJDK 1.7版本下测试通过,其他版本OracleJDK以及OpenJDK未测试。JRE不支持该代码,因为JRE中不存在Java编译器(运行该代码会抛出空指针异常[有网络资料介绍,把JDK中的tools.jar加入到classpath中可以解决空指针,该方法未测试])。如果需要在JRE环境下动态创建并加载类,唯一可行的办法使用开源的字节码操作库(文章开头有介绍两个)
- 测试用例中的
testCompile()
方法可能在不同版本的JDK下编译出来的字节码大小有所不同,造成JUnit断言失败,代码本身经测试就没有问题的。 - 动态创建的类加载到JVM后,与原生的类没有任何区别,因此创建的时候留意包名类名是否存在冲突,动态加载的类,调用只能使用反射机制。具体方法参考测试用例中的
testInvoke()
方法。
总结
本文总的来说没有什么技术含量,主要就是使用了一组编译器相关的API而已,如果这组API在使用过程中有什么疑问,请参照官方文档。
其他,有什么问题,欢迎与我进行交流。