玩转 Java 动态编译，太秀了～！

蔚落 2022-10-11 03:41 180阅读 0赞

**点击关注公众号，Java干货****及时送达**![5e59c1b2e2d27754ac18a9d3678cfcd1.png][]

*来源：https://zhenbianshu.github.io*

## 问题 ##

之前的文章从[Spring 的环境到 Spring Cloud 的配置][Spring _ Spring Cloud]中提到过，我们在使用 Spring Cloud 进行动态化配置，它的实现步骤是先将动态配置通过 `@Value` 注入到一个动态配置 Bean，并将这个 Bean 用注解标记为 `@RefreshScope`，在配置变更后，这些动态配置 Bean 会被统一销毁。

之后 Spring Cloud 的 `ContextRefresher` 会将变更后的配置作为一个新的 Spring Environment 加载进 ApplicationContext，由于 Scoped Bean 都是 Lazy Init 的，它们会在下一次使用时被使用新的 Environment 重新创建。

这套动态配置加载流程在使我们服务更加灵活的同时，也带来了很大的风险。首先从业务上，修改配置不像上线这么”重量级”，不必要找 QA 进行回归测试，这就有可能引发一系列奇怪的 Bug，而且长时间发现不了，另外，Spring Cloud 本身没有 “fallback” 机制，一旦配置的数据类型出了问题，就会导致服务不可用。

为此，我给 Spring Cloud 提了个 issue，但作者认为变动太大，不好改也不必改。

其实我也明白这个问题的困境，每个人都得为自己要修改的配置负责，即使框架支持了 fallback，但将错误吞掉，配置修改后不生效也没什么变化可能也并不符合用户的期望。所以，尽量让用户要修改的配置正确成为了新的目标。

基于这种需求，我添加了一个动态配置的校验器，但实现里一部分代码来自 github，所以本文在总结思路的同时，也帮助我理解所有代码。

#### 整体思路 ####

由于框架层没法做太多事情，所以我的计划是将这些配置取出来，构造出一个独立的 Java 类，并在服务外新建一个 ApplicationContext 试图通过构造出来的 Java 类初始化一个 Spring Bean，如果这个 Spring Bean 初始化过程中报错了，说明配置是有问题的。

## 动态编译 ##

#### 通过配置构造 Java 类 ####

首先要通过 `.properties` 文件构造出一个 Java 类，但问题是在配置里我们是不知道这些配置将要被怎么使用的，不知道它要被 Spring EL 如何处理，又将被转成什么类型。

这里我采用的策略是给配置添加注释，注释里使用一定的格式声明 EL 表达式和要生成的字段类型，当然这种实现有点 low，有人提议把这些信息放到配置项的 key 里，之后会再进行优化。

把各个字段解析完成后放到准备到的类模板中，就生成了一个 `Config.java` 类字符串，之后就要将这个字符串编译成字节码并由 Spring 加载成 Bean。另外，Spring 系列面试题和答案全部整理好了，微信搜索Java技术栈，在后台发送：面试，可以在线阅读。

#### JavaCompiler ####

由于 Config.java 是在运行时生成的，所以编译也只能在运行时了，万幸 Java 有提供 `javax.util.JavaCompiler` 类进行 Java 类的动态编译，省去了”写入文件 —— 命令行编译 —— 类加载 —— 清理文件” 的复杂流程。

Java 核心技术教程和示例源码可以看这里：https://github.com/javastacks/javastack

[JavaCompiler 的典型应用示例如下：][JavaCompiler]

JavaCompiler javaCompiler = ToolProvider.getSystemJavaCompiler();
    JavaFileManager fileManager = javaCompiler.getStandardFileManager(null, null, null);
    CompilationTask task = javaCompiler.getTask(out, fileManager, diagnosticListener, options, classes, compilationUnits);
    task.call();
    FileObject outputFile = fileManager.getFileForOutput(null, null, null, null);
    outputFile.getCharContent(true);

[流程如下图：][JavaCompiler]JavaCompiler 通过 JavaFileManager 管理输入和输出文件，使用时通过 `getTask()` 方法提交一个异步 CompilationTask 进行代码编译，代码编译时，JavaCompiler 通过 `getCharContent()` 从传入的 compilationUnits 获取到 .java 文件内容，把编译后的结果调用 CompiledByteCode 的 `openOutputStream()` 方法写到 CompiledByteCode 对象里。

![0dce7449fd018f4312db9b1b2f3ac000.png][]

#### 委托模式 ####

由于 JavaCompiler 的默认实现都是通过文件进行的，这不符合我的期望，我需要的是输入和输出都在内存进行，所以需要修改 JavaCompiler 的实现，JavaCompiler、JavaFileManager、JavaFileObject(Input/Output) 分别使用委托模式实现。其中 JavaFileManager 已经有 `ForwardingJavaFileManager` 的实现，JavaFileObject 也有 `SimpleJavaFileObject` 的实现，我们继承其实现后重写部分方法即可。

![0b7f301a1d2059dfdd2f913512fcc295.png][]

我参考的源码：https://github.com/trung/InMemoryJavaCompiler

## Spring Bean 实例化 ##

要将 Config 类实例化成 Bean，我们可以在 xml 里预定义它，在编译结束后创建一个简易的 `FileSystemXmlApplicationContext` 实例化这个 xml 内的 Bean。

#### 类加载器 ####

首先要让 Spring 能够加载到这些编译好的字节码，这就需要 ClassLoader 的配合。[*46 张 PPT 弄懂 JVM 调优！*][46 _ PPT _ JVM]这个分享给你。

类加载器的默认实现不可能知道去加载我们内存里编译好的字节码，只好新加一个 ClassLoader，实现也很简单，继承 `ClassLoader` 抽象类，并实现 `findClass` [方法即可。][Link 1]

class MemoryClassLoader extends ClassLoader {
     @Override
     protected Class<?> findClass(String name) throws ClassNotFoundException {
         // 在 CompiledByteCode 类里将编译后的字节码放到 classLoader 的 classBytes 字段内。
      byte[] buf = classBytes.get(name);
      if (buf == null) {
       return super.findClass(name);
      }
      return defineClass(name, buf, 0, buf.length);
     }
    }

#### [配置和实现][Link 1] ####

由于 Config Bean 的初始化依赖动态配置，我们还要把这些配置也添加到 Spring 环境内，我们知道 Spring 环境配置是由多个 `PropertySource` 构成的，向里面添加一个实现即可。然后就可以调用 application 的 `refresh()` 方法初始化上下文了，另外 Config Bean 被设置为懒加载了，不要忘记 get 一下使其被创建。

最终的代码如下：

FileSystemXmlApplicationContext applicationContext = new FileSystemXmlApplicationContext();
    applicationContext.setClassLoader(memoryClassLoader);
    applicationContext.setConfigLocation("classpath*:/test.xml");
    Map<String, Object> propertyMap = buildDynamicPropertyMap();
    MapPropertySource mapPropertySource = new MapPropertySource("validate_source", propertyMap);
    applicationContext.getEnvironment().getPropertySources().addFirst(mapPropertySource);
    applicationContext.refresh();
    applicationContext.getBean("config");

## 小结 ##

小项目完成的过程中，复习了很多知识，也尝试了业务代码中几乎不会用到的设计模式，充满了挑战性。

当然它现在还有配置不够方便、错误提示不够明确、没解决配置 namespace 等问题，留到后面慢慢优化吧~另外，关注公众号Java技术栈，在后台回复：面试，可以获取我整理的 Java 系列面试题和答案，非常齐全。

![f48234239d88acde827e237632d4af9e.gif][]

![f9f2b2fd0e9713449e85f583b739dc0a.png][]

[![dfdc5d1685a9d4f6b46943e5c14d9d13.png][]][dfdc5d1685a9d4f6b46943e5c14d9d13.png 1]

[![6cbb1cea5712aaa8db0344ac941c91a1.png][]][6cbb1cea5712aaa8db0344ac941c91a1.png 1]

[![4a865c4dbbbc13c66293582cc8c0994e.png][]][4a865c4dbbbc13c66293582cc8c0994e.png 1]

[![120c209005829f668fd61fcb69d93848.png][]][120c209005829f668fd61fcb69d93848.png 1]

[![1d26308d1c83b13cfb1b8d0dfc389f64.png][]][1d26308d1c83b13cfb1b8d0dfc389f64.png 1]

**关注Java技术栈看更多干货**

![6f5a13a49c766e2fa0456474cdf2c24a.png][]

![da2d3ee342d6f849b19f4dc46c0b4126.gif][]

获取 Spring Boot 实战笔记！

[5e59c1b2e2d27754ac18a9d3678cfcd1.png]: /images/20221005/03195fa9909d4914911f232db22aa640.png
[Spring _ Spring Cloud]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=3&mid=2247529853&scene=21&sn=68d5e3cab64748cb58a17c31762d0b60#wechat_redirect
[JavaCompiler]: http://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&chksm=eb50e470dc276d6676c923b597cbd28cf29e7a31393f1f03afedaf22f6aaf9e0e5517b9bdb32&idx=3&mid=2247524678&scene=21&sn=a153fd4fae16c357d55414e067d7bf25#wechat_redirect
[0dce7449fd018f4312db9b1b2f3ac000.png]: /images/20221005/afb6e5fc6abb42e293a12709d5462847.png
[0b7f301a1d2059dfdd2f913512fcc295.png]: /images/20221005/e48d4796236347fba7b41d51d7bce4c1.png
[46 _ PPT _ JVM]: http://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&chksm=eb539202dc241b14010f70edf89dc37c7629b5e2b7add50fd3f58070ecf2c14260196bf147d8&idx=2&mid=2247489332&scene=21&sn=65de5886e13b98116c8432d7d10ae4bc#wechat_redirect
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&chksm=eb50f82edc2771386229a5bb81d865eee375f8ecbec665494417beb8c933260114d67b34c3a0&idx=2&mid=2247531800&scene=21&sn=fbf496a2626d9d550c4ae95bb4f60c11#wechat_redirect
[f48234239d88acde827e237632d4af9e.gif]: /images/20221005/5fcb9a897b844833a76b40d93acb1ff6.png
[f9f2b2fd0e9713449e85f583b739dc0a.png]: /images/20221005/421248b8defb4610bb7cf7d056bcef68.png
[dfdc5d1685a9d4f6b46943e5c14d9d13.png]: /images/20221005/1ac0de90c02b456dab4a0cb184427e78.png
[dfdc5d1685a9d4f6b46943e5c14d9d13.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247535009&scene=21&sn=5a0ac485739f9ee7be02bbe938ff0eb3#wechat_redirect
[6cbb1cea5712aaa8db0344ac941c91a1.png]: /images/20221005/19eac5144856454f9947b8dd0a291517.png
[6cbb1cea5712aaa8db0344ac941c91a1.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247534855&scene=21&sn=fdaf7ea70fca4597d3cc4e18f5ada334#wechat_redirect
[4a865c4dbbbc13c66293582cc8c0994e.png]: /images/20221005/caacb7696a934598b521e0338c9b4f1a.png
[4a865c4dbbbc13c66293582cc8c0994e.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247530418&scene=21&sn=e6a0138c7c2f9a9ff6a8b4c878386211#wechat_redirect
[120c209005829f668fd61fcb69d93848.png]: /images/20221005/a17b15e6d7b74f33809d16bbcc05eea5.png
[120c209005829f668fd61fcb69d93848.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247535062&scene=21&sn=c34b69e41525dbcb3c473c6986daa801#wechat_redirect
[1d26308d1c83b13cfb1b8d0dfc389f64.png]: /images/20221005/253510ea73144726a17757983ff9af94.png
[1d26308d1c83b13cfb1b8d0dfc389f64.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247535563&scene=21&sn=b2a1de775b95890690e3295aa7e6b253#wechat_redirect
[6f5a13a49c766e2fa0456474cdf2c24a.png]: /images/20221005/0f1b2af8d9054455a467a0cc1ac516a7.png
[da2d3ee342d6f849b19f4dc46c0b4126.gif]: /images/20221005/aac2ab7e3792426084cc09c8fa2496a4.png