自定义类加载器环境下Spring Boot无法读取application.properties

问题背景 #

在Spigot/Paper插件中通过自定义框架启动Spring Boot时，依赖注入功能正常，但Spring Boot始终无法读取application.properties配置文件，尽管已确认配置文件存在于类路径中且可被类加载器找到。

解决方案 #

1. 明确指定Spring配置文件路径

在SpringApplicationBuilder构建过程中，直接通过properties方法指定配置文件的类路径位置，强制Spring加载该文件：

context = builder.sources(sources)
        .initializers(applicationContext -> {
            applicationContext.setClassLoader(pluginClassLoader);
        })
        .resourceLoader(loader)
        .properties("plugin.name=" + pluginName)
        .properties("plugin.main=" + plugin.getName())
        // 添加以下两行指定配置文件
        .properties("spring.config.name=application")
        .properties("spring.config.location=classpath:/application.properties")
        .run();

此方法直接覆盖Spring的默认配置搜索逻辑，确保它定位到你放置的application.properties。

2. 自定义EnvironmentPostProcessor手动加载配置

通过实现EnvironmentPostProcessor，在Spring环境初始化阶段手动读取并注入配置文件内容：

public class PluginEnvironmentPostProcessor implements EnvironmentPostProcessor {
    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        ClassLoader classLoader = application.getClassLoader();
        ClassPathResource resource = new ClassPathResource("application.properties", classLoader);
        
        if (resource.exists()) {
            try {
                Properties properties = PropertiesLoaderUtils.loadProperties(resource);
                // 将加载的配置添加到Spring环境中
                environment.getPropertySources().addLast(
                    new PropertiesPropertySource("plugin-application-properties", properties)
                );
            } catch (IOException e) {
                throw new RuntimeException("Failed to load application.properties from classpath", e);
            }
        }
    }
}

然后在项目的META-INF/spring.factories文件中注册这个处理器：

org.springframework.boot.env.EnvironmentPostProcessor=com.your.plugin.package.PluginEnvironmentPostProcessor

这种方式绕过Spring的自动配置逻辑，直接将配置注入到环境中，适用于类加载器环境特殊的场景。

3. 检查Spring启动类注解配置

确保自动生成的PluginConfiguration类添加了正确的Spring Boot启动注解，避免因配置缺失导致自动配置失效：

@SpringBootApplication
public class PluginConfiguration {
    // 空类作为Spring Boot的启动入口
}

如果不需要Web环境，可在构建时指定web(WebApplicationType.NONE)减少不必要的自动配置干扰：

builder.sources(sources)
        .web(WebApplicationType.NONE) // 禁用Web环境
        // 其他配置...
        .run();

4. 验证配置加载

添加测试Bean验证配置是否成功读取：

@Component
public class ConfigTestBean {
    @Value("${your.test.property}")
    private String testProperty;

    @PostConstruct
    public void printConfig() {
        System.out.println("Loaded configuration property: " + testProperty);
    }
}

启动插件后，若控制台输出对应配置值，则说明加载成功。

关键原因分析 #

Spigot/Paper的插件类加载器与标准Java应用的类加载器存在差异，Spring Boot的默认配置搜索逻辑可能无法正确识别插件JAR中的资源文件。通过明确指定路径或手动注入配置，可规避类加载器环境带来的限制。

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