Java模块化：Spring Boot自定义运行时教程

本文旨在指导读者如何为基于Java 19和Spring Boot 3.0的Maven项目创建最小化的自定义运行时镜像。我们将探讨使用`jdeps`分析依赖的局限性，并解决在使用`jlink`构建自定义运行时时常见的`NoClassDefFoundError`，特别是针对`java.beans.PropertyEditorSupport`的缺失问题，最终提供一个包含必要模块的正确`jlink`命令。

简介：Java模块化与自定义运行时

Java平台模块系统（JPMS），自Java 9引入，旨在提高应用的可靠性、安全性，并允许创建更小、更高效的运行时镜像。jlink工具是JPMS的核心组件之一，它能够根据应用程序实际所需的模块来构建一个定制的JRE，从而显著减小部署包的大小。这对于微服务、容器化部署以及资源受限的环境尤其有价值。

然而，对于非模块化或混合模块化（如Spring Boot应用，通常打包为包含所有依赖的“fat JAR”）的应用，确定其所需的完整JDK模块集可能具有挑战性。Spring Boot应用由于其广泛的依赖和内部机制，往往会隐式地依赖JDK中的多个模块。

Spring Boot 应用示例与初始问题

我们从一个使用start.spring.io创建的简单Spring Boot应用开始，配置如下：

• 构建工具: Maven
• Java版本: Java 19
• Spring Boot版本: 3.0
• 额外依赖: commons-lang3

pom.xml配置示例：

    4.0.0
    
        org.springframework.boot
        spring-boot-starter-parent
        3.0.0
        
    
    com.example
    demo
    0.0.1-SNAPSHOT
    demo
    Demo project for Spring Boot
    
        19
    
    
        
            org.springframework.boot
            spring-boot-starter
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
        
            org.apache.commons
            commons-lang3
        
    
    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
        
    

主应用类 DemoApplication.java 如下：

package com.example.demo;

import org.apache.commons.lang3.StringUtils;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        String mix = "MIX";
        if (StringUtils.isNoneBlank(mix)) {
            System.out.println(mix);
        }
        SpringApplication.run(DemoApplication.class, args);
    }
}

编译并打包后，可以通过 java -jar target/demo-0.0.1-SNAPSHOT.jar 成功运行。

使用 jdeps 分析依赖与遇到的挑战

为了创建自定义运行时，第一步通常是使用jdeps工具分析应用程序的模块依赖。对打包后的Spring Boot fat JAR执行jdeps命令：

jdeps target/demo-0.0.1-SNAPSHOT.jar

输出会显示许多内部依赖以及对java.base和java.logging的依赖，但也会有大量的not found或指向demo-0.0.1-SNAPSHOT.jar本身的条目。例如：

demo-0.0.1-SNAPSHOT.jar -> java.base
demo-0.0.1-SNAPSHOT.jar -> java.logging
demo-0.0.1-SNAPSHOT.jar -> not found
   com.example.demo                                   -> java.io                                            java.base
   com.example.demo                                   -> java.lang                                          java.base
   com.example.demo                                   -> org.apache.commons.lang3                           not found
   com.example.demo                                   -> org.springframework.boot                           not found
   # ... (大量输出)

这里的“not found”通常意味着jdeps无法在当前类路径或模块路径中找到对应的模块，这对于Spring Boot的fat JAR是常见的，因为其内部包含了所有依赖，而jdeps在分析时可能无法完全解析这些嵌套的依赖。因此，仅仅依赖jdeps对fat JAR的直接输出，可能无法准确识别所有必要的JDK模块。

初次尝试 jlink 及运行时错误

基于jdeps的部分输出，我们可能初步尝试使用java.base和java.logging模块来构建自定义运行时：

jlink --module-path $JAVA_HOME/jmods --add-modules java.base,java.logging --output mycustomrt

此命令会成功创建一个名为mycustomrt的自定义JRE。然而，当尝试使用这个自定义JRE运行Spring Boot应用时：

mycustomrt/bin/java -jar target/demo-0.0.1-SNAPSHOT.jar

应用程序会抛出java.lang.NoClassDefFoundError: java/beans/PropertyEditorSupport错误，并导致应用启动失败。

java.lang.NoClassDefFoundError: java/beans/PropertyEditorSupport
        at java.base/java.lang.ClassLoader.defineClass1(Native Method)
        # ... (堆栈信息)
Caused by: java.lang.ClassNotFoundException: java.beans.PropertyEditorSupport
        # ... (堆栈信息)

这个错误表明，尽管我们添加了java.base和java.logging，但Spring Boot应用程序（或其某个依赖）还需要其他JDK模块，其中包含java.beans.PropertyEditorSupport类。

识别并添加缺失的模块

java.beans.PropertyEditorSupport类位于java.desktop模块中。虽然我们的Spring Boot应用可能没有直接使用图形界面（GUI），但java.beans包中的类，如PropertyEditorSupport，经常被框架用于属性绑定、配置处理和内省机制，即使在无头（headless）服务器环境中也是如此。

此外，Spring Boot应用及其依赖可能还会用到其他一些JDK模块，即使它们在jdeps的初始分析中不明显：

• java.xml: 用于XML处理，许多配置或数据格式化可能需要。
• java.sql: 用于JDBC和数据库连接，即使没有直接配置数据库，一些数据抽象层也可能依赖它。
• java.prefs: 用于用户或系统偏好设置，某些库可能使用它进行配置存储。

综合考虑这些潜在的依赖，我们需要将这些模块也添加到jlink命令中。

解决方案：构建包含完整模块的自定义运行时

正确的jlink命令应包含java.base、java.logging以及我们通过错误信息和经验判断出的java.xml、java.sql、java.prefs和java.desktop模块。

执行以下命令创建自定义运行时：

jlink --module-path $JAVA_HOME/jmods \
      --add-modules java.base,java.logging,java.xml,java.sql,java.prefs,java.desktop \
      --output mycustomrt

命令解释:

• --module-path $JAVA_HOME/jmods: 指定JDK模块的查找路径。
• --add-modules ...: 明确指定需要包含在自定义运行时中的模块。
• --output mycustomrt: 指定生成的自定义运行时镜像的输出目录名称。

创建成功后，再次尝试使用这个新的自定义运行时来运行Spring Boot应用程序：

./mycustomrt/bin/java -jar target/demo-0.0.1-SNAPSHOT.jar

此时，应用程序应该能够正常启动并运行，不再出现NoClassDefFoundError。

总结与注意事项

为Spring Boot应用创建自定义运行时是一个优化部署的重要手段，但需要注意以下几点：

1. jdeps的局限性: 对于Spring Boot的fat JAR，jdeps可能无法完全揭示所有必要的JDK模块依赖。这通常需要结合运行时错误信息和经验来补充。
2. 迭代过程: 寻找最小化模块集可能是一个迭代的过程。从java.base开始，根据运行时错误逐步添加缺失的模块。
3. 常见模块: 对于大多数Spring Boot应用，除了java.base和java.logging，java.desktop（用于java.beans）、java.xml、java.sql、java.naming等模块也常常是必需的。
4. 模块化插件: 对于复杂的项目，可以考虑使用Maven或Gradle的模块化插件（如maven-jlink-plugin）来自动化模块依赖分析和运行时构建过程。
5. 压缩选项: jlink还提供了--compress选项来进一步减小运行时镜像的大小，例如--compress=2可以进行中等程度的压缩。
6. 彻底测试: 构建自定义运行时后，务必对应用程序进行彻底的功能测试，以确保所有必要的组件都已包含在内。

通过上述步骤，您可以为您的Spring Boot应用程序成功构建一个轻量级、定制化的Java运行时，从而实现更高效的部署和资源利用。