SpringBoot配置文件生效优先级

SpringBoot 可以通过 spring.profiles.active 属性指定生效不同配置文件来满足多环境要求,多环境更为复杂的场景,就需要理解配置文件生效优先级,考虑直接引入外部配置项和配置文件

多环境方案

SpringBoot 中可以通过 spring.profiles.active 属性来指定引入特定的配置文件。

用于满足不同场景不同环境中生效不同的配置,如下图所示:

其中 spring.profiles.active 配置为 dev 时,工程启动会加载 application-dev.yml 配置文件中的配置项。

这种加载模式可以说非常赞,让我会想起以前打包发布用 shell 脚本替换配置文件值的痛苦日子了。

虽然通过修改 spring.profiles.active 的方式可以实现不同配置文件的生效,依旧不够。

比如: test 测试环境有很多,且不同环境配置值不相同,这里 spring.profiles.active 配置为 test 依旧无法满足要求。

于是,理解 SpringBoot 配置文件生效优先级就很有必要。

配置文件生效优先级

我们一般都会将配置文件放置在类路径 src/main/resources 目录下,但实际上这个路径的配置文件优先级最低。

SpringBoot 读取配置时,高优先级覆盖低优先级的同名参数,不同名参数则互补取并集。

实际配置文件优先级顺序如下:

  1. 项目根目录 /config/ 如果 jar 包发布,则是 jar 包所在路径 + config/
  2. 项目根目录 / 如果 jar 包发布,则是 jar 包所在路径
  3. 类路径 src/main/resources/config/
  4. 类路径 src/main/resources/

依照这个优先级顺序,我们可以在实际应用中实现高度自定的配置效果。

比如在部署 jar 包的时候,将同名配置文件直接放在 jar 包所在路径下,各个环境中仅维护自己特有的配置项。

引入外部配置项或文件

配置生效优先级除了常规的文件路径之外,命令参数则是最高优先级。

通过命令参数修改配置项的值,可以实现同包启动不同配置。

比如:代码库中 spring.profiles.active = dev 不想每次打包改来改去,希望通过自动化脚本实现配置生效。

# 直接在执行命令后面增加配置项并指定值(不同环境的启动参数不同即可)
# 可以配置多个配置项,空格分隔即可
java -jar meals.jar --spring.profiles.active=test
​

如果环境上的配置文件放在特定的位置,也可以直接指定配置文件进行生效。

这种情况多见于流水线批量生产环境。

java -jar meals.jar --spring.config.location=/comm/config/application.yml
​

更多推荐

章节目录