【Docker系列】SpringBoot 项目如何动态指定配置文件

博客目录

• • 1. SpringBoot 配置文件基础
  • 2. 使用 spring.config.location 动态指定配置文件
  • 3. 配置文件的搜索位置
  • 4. 配置文件的激活
  • 5. 外部配置文件的使用
  • 6. 配置文件的动态刷新
  • 7. 总结

SpringBoot 作为 Java 开发中一个非常流行的框架，以其简化配置和快速启动应用而闻名。在开发过程中，我们经常需要根据不同的环境（如开发环境、测试环境、生产环境）来加载不同的配置文件。SpringBoot 提供了灵活的配置文件管理机制，使得我们可以轻松地实现这一需求。

--spring.config.location=/csdn-automatic-triplet/csdn/

Dockerfile

CMD mkdir -p ./logs/gc && java $JAVA_OPTS -jar ./app.jar --spring.config.location=/csdn-automatic-triplet/csdn/  --spring.profiles.active=$PROFILE $PARAMS

挂载目录

volumes:
  - /data/kwan/volumes/csdn/:/csdn-automatic-triplet/csdn/

1. SpringBoot 配置文件基础

在 SpringBoot 中，默认的配置文件是application.properties或application.yml，它们位于项目的src/main/resources目录下。这些文件包含了应用的配置信息，如数据库连接、服务端口等。

2. 使用 spring.config.location 动态指定配置文件

SpringBoot 允许我们通过spring.config.location属性来指定配置文件的位置。这个属性可以在多种方式中设置，包括命令行参数、环境变量、系统属性等。

2.1 命令行参数

在启动 SpringBoot 应用时，可以通过命令行参数来指定配置文件的位置。例如：

java -jar yourapp.jar --spring.config.location=classpath:/another-location/

这里的classpath:表示配置文件位于类路径下，/another-location/是相对于类路径的目录。

2.2 环境变量

我们也可以将配置文件的位置设置为环境变量，然后在启动应用时读取这个环境变量：

export SPRING_CONFIG_LOCATION=classpath:/another-location/
java -jar yourapp.jar

2.3 系统属性

除了环境变量，我们还可以通过系统属性来设置spring.config.location：

java -Dspring.config.location=classpath:/another-location/ -jar yourapp.jar

3. 配置文件的搜索位置

SpringBoot 在寻找配置文件时，会按照一定的顺序搜索多个位置。默认情况下，它会在以下位置搜索配置文件：

1. 当前目录下的/config-包装器子目录
2. classpath 下的/config-包装器包
3. 当前目录
4. classpath 根目录

通过设置spring.config.location，我们可以改变这一搜索顺序，指定 SpringBoot 首先在哪个位置查找配置文件。

4. 配置文件的激活

除了指定配置文件的位置，我们还可以激活特定的配置文件。SpringBoot 允许我们通过spring.profiles.active属性来激活一个或多个配置文件。

例如，如果我们有application-dev.properties和application-prod.properties两个配置文件，我们可以在启动时指定激活哪个配置文件：

java -jar yourapp.jar --spring.profiles.active=prod

5. 外部配置文件的使用

在微服务架构中，我们可能会将配置文件存储在外部系统，如配置中心或分布式配置服务中。SpringBoot 支持与这些外部系统集成，以动态获取配置信息。

5.1 Spring Cloud Config

Spring Cloud Config 是一个为分布式系统的配置管理提供的解决方案。它允许我们将配置信息存储在远程服务器上，并动态地刷新配置。

5.2 使用 Config Server

通过 Spring Cloud Config Server，我们可以创建一个配置服务器，该服务器提供配置信息的 HTTP 接口。SpringBoot 应用可以通过这个接口动态获取配置信息。

6. 配置文件的动态刷新

SpringBoot 支持配置文件的动态刷新，这意味着在不重启应用的情况下，我们可以更改配置文件并立即生效。

6.1 使用@RefreshScope

我们可以在 Spring 组件上使用@RefreshScope注解，这样当配置文件发生变化时，Spring 会重新加载这些组件的配置。

6.2 手动刷新配置

除了自动刷新，我们还可以通过发送 HTTP 请求到特定的端点来手动刷新配置：

curl -X POST http://localhost:8080/actuator/refresh

7. 总结

动态指定配置文件是 SpringBoot 应用管理中的一个重要特性，它使得我们可以根据不同的环境和需求灵活地管理配置信息。通过spring.config.location属性，我们可以轻松地指定配置文件的位置，结合 Spring Cloud Config 等工具，我们可以进一步实现配置的集中管理和动态刷新。

通过上述方法，我们可以确保 SpringBoot 应用在不同环境下都能正确地加载和使用配置信息，从而提高应用的灵活性和可维护性。