SpringBoot Maven多模块项目配置文件加载

SpringBoot Maven多模块项目配置文件加载

对于Maven多模块项目，想把SpringBoot的配置文件按模块拆分，各模块负责自己的配置，避免一个配置文件包含所有模块的配置。

默认SpringBoot会加载classpath:application.yml、classpath:config/application.yml等路径下的配置文件，但是上述规则子模块之间会相互覆盖，最终只有一个application.yml配置文件生效。查阅SpringBoot文档后，发现其提供了自定义环境的能力，下面将使用这个能力来实现多模块配置文件加载。

使用的SpringBoot版本为2.7.6，文章编写时间2022-12-12，不同版本API可能有所变化。

官方文档

根据SpringBoot文档描述，可以实现EnvironmentPostProcessor接口来将环境配置在Spring启动前注入。

这里是文档中的示例代码

public class MyEnvironmentPostProcessor implements EnvironmentPostProcessor {

    private final YamlPropertySourceLoader loader = new YamlPropertySourceLoader();

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        Resource path = new ClassPathResource("com/example/myapp/config.yml");
        PropertySource<?> propertySource = loadYaml(path);
        environment.getPropertySources().addLast(propertySource);
    }

    private PropertySource<?> loadYaml(Resource path) {
        Assert.isTrue(path.exists(), () -> "Resource " + path + " does not exist");
        try {
            return this.loader.load("custom-resource", path).get(0);
        }
        catch (IOException ex) {
            throw new IllegalStateException("Failed to load yaml configuration from " + path, ex);
        }
    }
}

自定义子模块配置文件加载

根据文档和实例代码，实现自己的子模块配置文件载入。

规则约定

• 配置文件放置于resources/config目录下，文件格式为.yml，文件数量不限。
• 可以使用application-xxx.yml格式，这样IDEA可以对Spring相关配置项进行提示，其中xxx不要起可能出现在spring.profiles.active中的名字。

代码

public class CommonConfigEnvironmentPostProcessor implements EnvironmentPostProcessor {

    private static final Logger log = LoggerFactory.getLogger(CommonConfigEnvironmentPostProcessor.class);

    private final YamlPropertySourceLoader loader = new YamlPropertySourceLoader();

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {

        try {
            Resource[] resources = new PathMatchingResourcePatternResolver()
                    .getResources(ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX + "config/*.yml");
            for (Resource resource : resources) {
                List<PropertySource<?>> configs = loader.load(resource.getFilename(), resource);
                if (configs != null && !configs.isEmpty()) {
                    environment.getPropertySources().addLast(configs.get(0));
                }
            }
        } catch (IOException e) {
            log.error("Load module config fail", e);
            throw new RuntimeException(e);
        }
    }
}

上述代码按照classpath*:config/*.yml读取所有符合条件的资源文件，使用yaml loader将其解析为PropertySource，调用environment.getPropertySources().addLast()注入。

在resources/META-INF/spring.factories文件中，添加如下语句

org.springframework.boot.env.EnvironmentPostProcessor=\
    com.hbpm.common.config.CommonConfigEnvironmentPostProcessor

这样，引用了这个jar包的SpringBoot应用会自动按前面定义的规则加载配置文件。