今天聊一个小伙伴在星球上的发问:

Spring Boot 分离配置文件的 N 种方式

问题不难,解决方案也有许多,因此我决定撸一篇文章和咱们仔细说说这个问题。

1. 装备文件方位

首要小伙伴们要明白,Spring Boot 默许加载的装备文件是 application.properties 或许 application.yaml,默许的加载方位一共有五个,五个方位能够分为两类:

从 classpath 下加载,这个又细分为两种:

  1. 直接读取 classpath 下的装备文件,对应到 Spring Boot 项目中,便是 resources 目录下的装备。
  2. 读取 classpath:/config/ 目录下的文件,对应到 Spring Boot 项目中便是 resources/config 目录下的装备。

这两种情况如下图:

Spring Boot 分离配置文件的 N 种方式

从项目所在的当时目录下加载,这个又细分为三种情况:

  1. 从项目当时目录下加载装备文件。
  2. 从项目当时目录下的 config 文件夹中加载装备文件。
  3. 从项目当时目录下的 config 文件夹的子文件夹中加载(孙子文件夹不能够)。

这三种情况如下图:

Spring Boot 分离配置文件的 N 种方式

config 目录下的装备文件能够被加载,config/a 目录下的装备文件也能够被加载,可是 config/a/b 目录下的装备文件不会被加载,由于不是直接子文件夹。

装备文件能够放在这么多不同的方位,假如同一个特点在多个装备文件中都写了,那么后面加载的装备会覆盖掉前面的。例如在 classpath:application.yaml 中设置项目端口号是 8080,在 项目当时目录/config/a/application.yaml 中设置项目端口是 8081,那么最终的项目端口号便是 8081。

这是默许的文件方位。

假如你不想让自己的装备文件叫 application.properties 或许 application.yaml,那么也能够自定义装备文件称号,只需求在项目发动的时分指定装备文件名即可,例如我想设置我的装备文件名为 app.yaml,那么咱们能够在发动 jar 包的时分依照如下方法装备,此时系统会主动去上面提到的五个方位查找对应的装备文件:

java -jar boot_config_file-0.0.1-SNAPSHOT.jar --spring.config.name=app

假如项目已经打成 jar 包发动了,那么前面所说的目录中,后三个中的项目当时目录便是指 jar 包所在的目录。

假如你不想去这五个方位查找,那么也能够在发动 jar 包的时分清晰指定装备文件的方位和称号,如下:

java -jar boot_config_file-0.0.1-SNAPSHOT.jar --spring.config.location=optional:classpath:/app.yaml

注意,我在 classpath 前面加上了 optional: 表明假如这个装备文件不存在,则依照默许的方法发动,而不会报错说找不到这个装备文件。假如不加这个前缀,那么当系统找不到指定的装备文件时,就会抛出 ConfigDataLocationNotFoundException 反常,从而导致使用发动失败。

假如装备文件和 jar 包在相同的目录结构下,如下图:

Spring Boot 分离配置文件的 N 种方式

那么发动脚本如下:

java -jar boot_config_file-0.0.1-SNAPSHOT.jar --spring.config.location=optional:javaboy/app.yaml

假如 spring.config.location 的装备,只是指定了目录,那么必须以 / 结尾,例如上面这个发动脚本,也能够依照如下方法发动:

java -jar boot_config_file-0.0.1-SNAPSHOT.jar --spring.config.location=optional:javaboy/ --spring.config.name=app

经过 spring.config.location 特点确定装备文件的方位,经过 spring.config.name 特点确定装备文件的文件名。

2. 额定方位

前面咱们关于装备文件方位的设置,都是覆盖掉已有的装备,假如不想覆盖掉 Spring Boot 默许的装备文件查找战略,又想加入自己的,那么能够依照如下方法指定装备文件方位:

java -jar boot_config_file-0.0.1-SNAPSHOT.jar --spring.config.additional-location=optional:javaboy/app.yaml

假如这个额定指定的装备文件和已有的装备文件有抵触,那么还是以后来者为准。

3. 方位通配符

有一种情况,假设我有 redis 和 mysql 的装备,我想将之放在两个不同的文件夹中以便于管理,像下面这样:

Spring Boot 分离配置文件的 N 种方式

那么在项目发动时,能够经过通配符 * 批量扫描相应的文件夹:

java -jar boot_config_file-0.0.1-SNAPSHOT.jar --spring.config.location=optional:config/*/

使用通配符批量扫描 mysql 和 redis 目录时,默许的加载次序是依照文件夹的字母排序,即先加载 mysql 目录后加载 redis 目录。

需求注意的是,通配符只能用在外部目录中,不能够用在 classpath 中的目录上。另外,包含了通配符的目录,只能有一个通配符 *,不能够有多个,而且还必须是以 */ 结尾,即一个目录的最终部分能够不确定。

4. 导入外部装备

从 Spring Boot2.4 开端,咱们也能够使用 spring.config.import 方法来导入装备文件,比较于 additional-location 装备,这个 import 导入愈加灵活,能够导入恣意称号的装备文件。

spring.config.import=optional:file:./dev.properties

甚至,这个 spring.config.import 还能够导入无扩展名的装备文件,例如我有一个装备文件,是 properties 格局的,可是这个这个装备文件没有扩展名,现在我想将之作为 properties 格局的装备文件导入,方法如下:

spring.config.import=optional:file:/Users/sang/dev[.properties]

好啦,看完上面的内容,文章一开端的问题答案就不用我多说了吧~