Spring Boot Jar运行时java.nio.file.spi.FileTypeDetector未加载问题

问题描述 #

• 自定义多个java.nio.file.spi.FileTypeDetector类用于识别自定义文件格式
• IDE中运行正常，但Spring Boot打包成Jar后无法加载这些类
• 已在resources/META-INF/services目录下放置java.nio.file.spi.FileTypeDetector文件，文件内包含自定义实现类的全限定名
• 尝试修改Gradle构建文件，出现与BOOT-INF目录及Spring Boot构建方式相关的错误
• 尝试在启动命令中添加-cp 'BOOT-INF/lib/*:BOOT-INF/classes:.'，问题仍未解决
• 测试文件位于项目根目录的TestFiles文件夹中，需修改控制器类中的路径以使用这些文件，启动后访问http://localhost:8111/status即可测试

根本原因 #

Spring Boot可执行Jar采用嵌套Jar结构（BOOT-INF目录下存放classes和lib），而JDK的SPI机制默认仅扫描系统类路径和应用类路径根目录下的META-INF/services文件，无法识别BOOT-INF内部的SPI配置文件。

解决方案 #

方案1：修改Gradle配置，将SPI配置移至Jar根目录 #

在Spring Boot的Gradle构建脚本中添加如下配置，将resources/META-INF/services下的文件复制到最终Jar的根目录（而非BOOT-INF/classes下）：

bootJar {
    from(sourceSets.main.resources) {
        include 'META-INF/services/**'
        into '/'
    }
}

构建后，META-INF/services会直接位于Jar根目录，JDK的SPI机制可正常扫描到配置。

方案2：手动注册FileTypeDetector #

若不想修改构建配置，可在Spring Boot启动时手动注册自定义实现，绕过SPI自动扫描：

import java.nio.file.spi.FileTypeDetector;
import java.util.ServiceLoader;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;

@Component
public class FileTypeDetectorRegistrar implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        // 加载自定义FileTypeDetector实现类
        ServiceLoader<FileTypeDetector> loader = ServiceLoader.load(YourCustomFileTypeDetector.class);
        for (FileTypeDetector detector : loader) {
            // 反射调用JDK内部方法注册检测器（注意：依赖JDK内部API，需确保版本兼容性）
            Class<?> detectorClass = Class.forName("sun.nio.fs.FileTypeDetector");
            java.lang.reflect.Method registerMethod = detectorClass.getDeclaredMethod("register", FileTypeDetector.class);
            registerMethod.setAccessible(true);
            registerMethod.invoke(null, detector);
        }
    }
}

提示：该方案依赖JDK内部API，不同版本可能存在兼容性问题，优先推荐方案1。

方案3：指定ServiceLoader使用上下文类加载器 #

修改启动命令，添加JVM参数让ServiceLoader使用Spring Boot的类加载器：

java -jar your-spring-boot-app.jar -Djava.util.ServiceLoader.useSystemClassLoader=false

此参数会让ServiceLoader使用当前线程的上下文类加载器（即Spring Boot的LaunchedURLClassLoader），从而扫描到BOOT-INF/classes下的SPI配置。

验证步骤 #

1. 按选定方案修改后重新构建Jar包
2. 运行Jar包，访问http://localhost:8111/status测试自定义文件格式识别功能
3. 查看应用日志，确认自定义FileTypeDetector已成功加载并生效

内容的提问来源于stack exchange，提问作者user618105