Spring Boot 项目：如何在 JAR 运行时读取外部配置文件
在 Spring Boot 项目中，我们常常需要在生产环境中灵活地配置应用，尤其是当我们将项目打包为 JAR 文件时，如何在运行时通过外部配置文件（如 application.yml 或 application.properties）替换 JAR 内部的配置就变得尤为重要。本文将详细介绍几种常见的方式，帮助你轻松地在 JAR 运行时加载外部配置。
一、为什么需要外部配置文件？
在一些场景中，特别是在生产环境中，我们希望能够在不修改 JAR 文件的情况下调整应用的配置。例如：
-
配置数据库连接信息；
-
配置外部 API 密钥；
-
配置应用的不同环境（开发、测试、生产等）。
Spring Boot 提供了灵活的外部化配置机制，使得我们能够根据实际需要从外部加载配置文件，避免了每次修改配置后重新打包应用的问题。
二、Spring Boot 外部化配置方案
方案一：使用 --spring.config.location 参数
这是 Spring Boot 提供的最常见也是最灵活的方式，允许我们通过命令行指定配置文件的位置。
示例命令：
java -jar your-app.jar --spring.config.location=file:/path/to/your/application.yml
-
你可以通过指定文件路径来加载单个配置文件：
--spring.config.location=file:/opt/config/application.yml -
也可以指定一个目录，Spring Boot 会自动加载该目录下的
application.yml或application.properties文件：--spring.config.location=file:/opt/config/
多个配置文件
如果你希望加载多个配置文件，可以通过逗号分隔不同的路径：
--spring.config.location=file:/opt/config/,classpath:/default/
注意事项：
-
使用此参数后，Spring Boot 会优先加载指定路径的配置文件，覆盖 JAR 包内部的配置；
-
适用于在生产环境中灵活调整配置文件。
方案二：把配置文件放在 JAR 同级目录下的 config 目录
如果你希望将外部配置文件放在与 JAR 文件同级的 config 目录下，Spring Boot 会自动加载该目录中的配置文件。
目录结构示例：
/opt/myapp/
├── your-app.jar
└── config/├── application.yml└── another-config.yml
启动命令：
java -jar /opt/myapp/your-app.jar
Spring Boot 会自动加载 config/application.yml 或 config/application.properties 文件，并覆盖 JAR 包内部的默认配置。
注意事项：
-
这种方式非常简单，只要确保
config目录与 JAR 文件位于同一级别即可； -
Spring Boot 会优先加载
config目录下的配置文件； -
此方案不需要额外指定参数，运行 JAR 时会自动生效。
方案三：使用 JVM 参数
通过 JVM 参数来指定配置文件位置，也是一个常见的做法。这种方式与 --spring.config.location 参数类似，只是通过 JVM 参数传递：
java -Dspring.config.location=file:/path/to/application.yml -jar your-app.jar
方案四：使用环境变量来指定配置文件路径
你还可以通过设置环境变量来指定 Spring Boot 的配置文件路径。例如，在 Linux 中，你可以使用如下命令：
export SPRING_CONFIG_LOCATION=file:/path/to/application.yml
java -jar your-app.jar
三、配置文件优先级
Spring Boot 在加载配置文件时有一个明确的优先级顺序：
-
外部命令行参数（例如
--spring.config.location）； -
JVM 参数（例如
-Dspring.config.location）； -
JAR 同级目录下的
config/目录； -
JAR 内部的
application.yml或application.properties文件； -
默认值（如注解中指定的默认值）。
如果有多个配置文件，Spring Boot 会按照优先级顺序加载，后加载的配置会覆盖先加载的配置。
四、总结
在 Spring Boot 项目中，我们可以通过多种方式在运行时灵活地加载外部配置文件，而无需每次修改配置后重新打包应用。常见的几种方式如下：
-
使用
--spring.config.location参数：可以指定外部配置文件的路径。 -
JAR 同级目录的
config目录：将配置文件放在与 JAR 同级的config目录下，Spring Boot 会自动加载。 -
使用 JVM 参数：通过传递 JVM 参数来指定配置文件路径。
-
使用环境变量：通过环境变量指定配置文件路径。