Spring Boot分离配置文件的多种方式总结

目录开发者_Go学习

• 1. 配置文件位置
• 2. 额外位置
• 3. 位置通配符
• 4. 导入外部配置
• 总结

今天聊一个小伙伴在星球上的提问：

问题不难，解决方案也有很多，因此我决定撸一篇文章和大家仔细说说这个问题。

1. 配置文件位置

首先小伙伴们要明白，Spring Boot 默认加载的配置文件是 application.properties 或者 application.yaml，默认的加载位置一共有五个，五个位置可以分为两类：

从 classpath 下加载，这个又细分为两种：

• 直接读取 classpath 下的配置文件，对应到 Spring Boot 项目中，就是 resources 目录下的配置。
• 读取 classpath:/config/ 目录下的文件，对应到 Spring Boot 项目中就是 resources/config 目录下的配置。

这两种情况如下图：

从项目所在的当前目录下加载，这个又细分为三种情况：

• 从项目当前目录下加载配置文件。
• 从项目当前目录下的 config 文件夹中加载配置文件。
• 从项目当前目录下的 config 文件夹的子文件夹中加载（孙子文件夹不可以）。

这三种情况如下图：

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.jandroidar --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: 表示如果这个配置文件不存在，则按照默认的方式启动，而不会报错说找不到这个配置文件。如果不加这个前缀，那么当系统找不到指定的配置文件时，就会抛出 ConfigDataLocationNotFoundExceptihttp://www.devze.comon 异常，进而导致应用启动失败。

如果配置文件和 jar 包在相同的目录结构下，如下图：

那么启动脚本如下：

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/ --phpspring.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 的配置，我想将之放在两个不同的文件夹中以便于管理，像下面这样：

那么在项目启动时，可以通过通配符 * 批量扫描相应的文件夹：

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.propephprties

甚至，这个 spring.config.import 还可以导入无扩展名的配置文件，例如我有一个配置文件，是 properties 格式的，但是这个这个配置文件没有扩展名，现在我想将之作为 properties 格式的配置文件导入，方式如下：

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

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

总结

到此这篇关于Spring Boot分离配置文件的多种方式的文章就介绍到这了,更多相关SpringBoot分离配置文件内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！