Spring Boot 项目:如何在 JAR 运行时读取外部配置文件

在 Spring Boot 项目中,我们常常需要在生产环境中灵活地配置应用,尤其是当我们将项目打包为 JAR 文件时,如何在运行时通过外部配置文件(如 application.ymlapplication.properties)替换 JAR 内部的配置就变得尤为重要。本文将详细介绍几种常见的方式,帮助你轻松地在 JAR 运行时加载外部配置。

一、为什么需要外部配置文件?

在一些场景中,特别是在生产环境中,我们希望能够在不修改 JAR 文件的情况下调整应用的配置。例如:

  • 配置数据库连接信息;

  • 配置外部 API 密钥;

  • 配置应用的不同环境(开发、测试、生产等)。

Spring Boot 提供了灵活的外部化配置机制,使得我们能够根据实际需要从外部加载配置文件,避免了每次修改配置后重新打包应用的问题。

二、Spring Boot 外部化配置方案

方案一:使用 --spring.config.location 参数

这是 Spring Boot 提供的最常见也是最灵活的方式,允许我们通过命令行指定配置文件的位置。

示例命令:
bash 复制代码
java -jar your-app.jar --spring.config.location=file:/path/to/your/application.yml
  • 你可以通过指定文件路径来加载单个配置文件:

    bash 复制代码
    --spring.config.location=file:/opt/config/application.yml
  • 也可以指定一个目录,Spring Boot 会自动加载该目录下的 application.ymlapplication.properties 文件:

    bash 复制代码
    --spring.config.location=file:/opt/config/
多个配置文件

如果你希望加载多个配置文件,可以通过逗号分隔不同的路径:

bash 复制代码
--spring.config.location=file:/opt/config/,classpath:/default/
注意事项:
  • 使用此参数后,Spring Boot 会优先加载指定路径的配置文件,覆盖 JAR 包内部的配置

  • 适用于在生产环境中灵活调整配置文件。

方案二:把配置文件放在 JAR 同级目录下的 config 目录

如果你希望将外部配置文件放在与 JAR 文件同级的 config 目录下,Spring Boot 会自动加载该目录中的配置文件。

目录结构示例:
bash 复制代码
/opt/myapp/
├── your-app.jar
└── config/
    ├── application.yml
    └── another-config.yml
启动命令:
bash 复制代码
java -jar /opt/myapp/your-app.jar

Spring Boot 会自动加载 config/application.ymlconfig/application.properties 文件,并覆盖 JAR 包内部的默认配置。

注意事项:
  • 这种方式非常简单,只要确保 config 目录与 JAR 文件位于同一级别即可

  • Spring Boot 会优先加载 config 目录下的配置文件;

  • 此方案不需要额外指定参数,运行 JAR 时会自动生效。

方案三:使用 JVM 参数

通过 JVM 参数来指定配置文件位置,也是一个常见的做法。这种方式与 --spring.config.location 参数类似,只是通过 JVM 参数传递:

bash 复制代码
java -Dspring.config.location=file:/path/to/application.yml -jar your-app.jar

方案四:使用环境变量来指定配置文件路径

你还可以通过设置环境变量来指定 Spring Boot 的配置文件路径。例如,在 Linux 中,你可以使用如下命令:

bash 复制代码
export SPRING_CONFIG_LOCATION=file:/path/to/application.yml
java -jar your-app.jar

三、配置文件优先级

Spring Boot 在加载配置文件时有一个明确的优先级顺序:

  1. 外部命令行参数 (例如 --spring.config.location);

  2. JVM 参数 (例如 -Dspring.config.location);

  3. JAR 同级目录下的 config/ 目录

  4. JAR 内部的 application.ymlapplication.properties 文件

  5. 默认值(如注解中指定的默认值)。

如果有多个配置文件,Spring Boot 会按照优先级顺序加载,后加载的配置会覆盖先加载的配置


四、总结

在 Spring Boot 项目中,我们可以通过多种方式在运行时灵活地加载外部配置文件,而无需每次修改配置后重新打包应用。常见的几种方式如下:

  1. 使用 --spring.config.location 参数:可以指定外部配置文件的路径。

  2. JAR 同级目录的 config 目录 :将配置文件放在与 JAR 同级的 config 目录下,Spring Boot 会自动加载。

  3. 使用 JVM 参数:通过传递 JVM 参数来指定配置文件路径。

  4. 使用环境变量:通过环境变量指定配置文件路径。

相关推荐
码事漫谈4 分钟前
C++ vector越界问题完全解决方案:从基础防护到现代C++新特性
后端
啾啾大学习1 小时前
让我们快速入门DDD
后端·领域驱动设计
老张聊数据集成1 小时前
数据分析师如何构建自己的底层逻辑?
后端·数据分析
咕噜分发企业签名APP加固彭于晏1 小时前
市面上有多少智能体平台
前端·后端
掘金一周2 小时前
我开源了一款 Canvas “瑞士军刀”,十几种“特效与工具”开箱即用 | 掘金一周 8.14
前端·人工智能·后端
村姑飞来了2 小时前
Spring 扩展:动态使某个 @Import 方式导入的 @Configuration 类失效
后端
开心就好20252 小时前
前端性能优化移动端网页滚动卡顿与掉帧问题实战
后端
语落心生2 小时前
如何利用Paimon做流量定时检查? --- 试试标签表
后端
paopaokaka_luck2 小时前
校园快递小程序(腾讯地图API、二维码识别、Echarts图形化分析)
vue.js·spring boot·后端·小程序·uni-app