spring boot项目布署到线上的时候实现动态读取配置文件

原创于 2024-12-31 14:57:49 发布 · 970 阅读

CC 4.0 BY-SA版权

文章标签：

在Spring Boot项目中，通常配置文件（如application.properties 或 application.yml）会在项目打包成jar文件时被静态嵌入。然而，在实际生产环境中，你可能需要根据不同的部署环境来动态读取配置文件，而不是将所有配置写死在jar包中。

以下是几种常见的方式，来实现Spring Boot应用在生产环境中动态读取配置文件：

1. 通过外部配置文件（相对路径）

你可以将配置文件（application.properties 或 application.yml）放在与 jar 文件同一目录下，或者放在其他路径，然后通过命令行参数来指定配置文件的位置。

步骤：

在项目的外部创建配置文件 application.properties 或 application.yml。
在启动 Spring Boot 应用时，通过 --spring.config.location 参数来指定外部配置文件路径。

示例：

假设你把配置文件放在 /opt/config/application.properties。

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

这样，Spring Boot 在启动时会加载 /opt/config/application.properties 文件中的配置，而不是嵌入在 jar 文件中的配置。

注意：

如果配置文件路径是相对路径，可以使用 file:./ 来指定相对于 jar 文件的路径。
你也可以通过 --spring.config.name 来指定不同的配置文件名，默认的配置文件名是 application.properties 或 application.yml。

2. 通过环境变量动态配置

在 Spring Boot 中，可以使用环境变量来动态配置属性。通过将配置项的值设置为环境变量，Spring Boot 会自动读取这些环境变量并替代配置文件中的值。

步骤：

在操作系统环境中定义环境变量（例如，Linux 系统中可以通过 .bashrc 或直接在终端中定义环境变量）。
在 application.properties 或 application.yml 文件中，使用占位符 ${} 来引用环境变量。

示例：

假设你定义了一个环境变量 DB_HOST 来配置数据库连接地址。

export DB_HOST=192.168.1.100

然后在 application.properties 中使用：

spring.datasource.url=jdbc:mysql://${DB_HOST}:3306/mydb

Spring Boot 会在启动时自动从环境变量中读取 DB_HOST 的值，并用它替代配置文件中的 ${DB_HOST} 占位符。

另一种方法：

在启动 Spring Boot 应用时，也可以通过命令行参数传递环境变量：

java -jar your-application.jar --DB_HOST=192.168.1.100

3. 通过 `application-{profile}.properties` 或 `application-{profile}.yml`

Spring Boot 支持配置 profiles，允许你根据不同的环境使用不同的配置文件。例如，在开发环境使用 application-dev.properties，在生产环境使用 application-prod.properties。

步骤：

创建多个配置文件，每个文件对应不同的环境：
- application-dev.properties 或 application-dev.yml
- application-prod.properties 或 application-prod.yml
在启动时指定使用的配置文件，通过 --spring.profiles.active 参数来选择环境。

示例：

java -jar your-application.jar --spring.profiles.active=prod

Spring Boot 会根据 --spring.profiles.active 的值来选择加载 application-prod.properties 或 application-prod.yml 配置文件中的内容。

4. 通过配置服务器（如 Spring Cloud Config）

在分布式系统或微服务架构中，配置管理变得更加复杂，通常使用外部配置服务来集中管理所有服务的配置。Spring Cloud 提供了一个 Config Server，允许所有服务通过 REST API 获取配置文件。

步骤：

启动一个 Config Server，它可以从 Git、SVN、文件系统等地方读取配置文件。
在每个服务中配置 spring.cloud.config.uri 指向 Config Server。

示例：

application.properties 中配置：

spring.cloud.config.uri=http://config-server-url:8888

Config Server 会提供集中式的配置，服务在启动时会从该服务器动态加载配置文件。

5. 通过 Jar 外部挂载文件系统（Docker/Kubernetes 部署）

如果你的应用部署在 Docker 或 Kubernetes 环境中，可以利用挂载卷来将配置文件挂载到容器中，并在容器启动时动态加载配置文件。

Docker 示例：

在宿主机上创建配置文件：
- /opt/config/application.properties
使用 docker run 时挂载配置文件：

docker run -v /opt/config/application.properties:/app/config/application.properties your-application

这样，容器内的应用会使用 /app/config/application.properties 作为配置文件。

Kubernetes 示例：

在 Kubernetes 中，你可以通过 ConfigMap 或 Secret 来动态注入配置文件。

apiVersion: v1 kind: ConfigMap metadata: name: application-config data: application.properties: | spring.datasource.url=jdbc:mysql://db-server:3306/mydb

然后将 ConfigMap 挂载到 Pod 中，应用会自动读取配置。