Spring Boot项目中使用外部application.yml配置文件启动JAR包

Spring Boot项目中使用外部application.yml配置文件启动JAR包

一、基本原理

Spring Boot默认会加载项目内部的application.yml或application.properties文件。但如果我们希望使用外部配置文件，可以通过设置spring.config.location属性来指定外部配置文件的路径。这种方式允许配置文件独立于JAR包存在，便于修改和部署。

二、具体操作步骤

1. 准备外部配置文件

将application.yml文件放置在项目外部，例如放在以下路径：

• /opt/config/application.yml
• D:\config\application.yml
  确保该文件包含你需要的配置内容，例如：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test_db
    username: root
    password: secret
server:
  port: 8080

2. 打包项目为JAR文件

在项目根目录下，使用Maven或Gradle打包项目，确保JAR包内不包含application.yml文件。例如，使用Maven：

mvn clean package -DskipTests

3. 启动JAR包并指定外部配置文件

使用以下命令启动JAR包，并指定外部配置文件的路径：

java -jar your-app.jar --spring.config.location=file:/opt/config/application.yml

或者，如果配置文件位于Windows系统的某个路径：

java -jar your-app.jar --spring.config.location=file:D:\config\application.yml

4. 验证配置是否生效

启动后，可以通过日志或应用程序中的配置项检查外部配置文件是否被正确加载。例如，检查数据库连接是否使用了外部配置文件中的URL和用户名。

三、注意事项

1. 优先级问题：
   • 使用--spring.config.location指定外部配置文件后，Spring Boot将不再加载JAR包内部的默认配置文件。
   • 如果需要同时加载JAR包内部的默认配置文件和外部配置文件，可以使用--spring.config.additional-location参数：

     java -jar your-app.jar --spring.config.additional-location=file:/opt/config/application.yml
     

2. 路径格式：
   • 确保路径格式正确，例如在Linux系统下使用正斜杠（/），在Windows系统下使用反斜杠（\）或正斜杠（/）。
   • 如果路径中包含空格，需要用引号包裹：

     java -jar your-app.jar --spring.config.location="file:/opt/my config/application.yml"
     

3. 权限问题：
   • 确保启动JAR包的用户对配置文件路径有读取权限，否则可能导致配置文件无法加载。
4. 配置冲突：
   • 如果外部配置文件和JAR包内部的配置文件存在相同的配置项，外部配置文件的配置会覆盖内部的配置。
5. 测试配置：
   • 建议在正式使用前，先手动测试启动命令，确保配置文件被正确加载且应用程序按预期运行。

四、示例

假设你有一个Spring Boot项目，打包后生成的JAR文件名为myapp.jar，并希望使用外部配置文件/opt/config/application.yml启动。启动命令如下：

java -jar myapp.jar --spring.config.location=file:/opt/config/application.yml

如果外部配置文件位于Windows系统的D:\config\application.yml，则命令为：

java -jar myapp.jar --spring.config.location=file:D:\config\application.yml