Spring Boot 配置文件切换的全面指南

在 Spring Boot 应用开发中，我们常常需要在不同的环境（如开发环境、测试环境、生产环境）中使用不同的配置。Spring Boot 提供了强大且灵活的配置文件切换机制，使得我们能够轻松应对这种需求。本文将详细介绍 Spring Boot 配置文件切换的相关知识与实践。

一、Spring Boot 配置文件概述

Spring Boot 支持多种类型的配置文件，最常见的是application.properties和application.yml。这些配置文件用于存储应用的各种配置属性，例如数据库连接信息、服务器端口、日志级别等。

（一）properties 文件

在application.properties中，配置属性以键值对的形式呈现，例如：

ini 复制代码

server.port=8080
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=123456

（二）yml 文件

application.yml使用缩进和冒号来表示层级关系，具有更好的可读性。相同的配置在application.yml中可以这样写：

yaml 复制代码

server:
  port: 8080
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: 123456

二、多环境配置文件

为了实现不同环境的配置区分，Spring Boot 允许我们创建多个配置文件。通常的命名方式是application-{profile}.properties或application-{profile}.yml，其中{profile}代表不同的环境，比如dev（开发环境）、test（测试环境）、prod（生产环境）。

（一）创建多环境配置文件示例

假设我们有开发、测试和生产三种环境，对应的配置文件如下：

1. application-dev.yml

yaml 复制代码

server:
  port: 8081
spring:
  datasource:
    url: jdbc:mysql://dev-db:3306/mydb
    username: devuser
    password: devpass

2. application-test.yml

yaml 复制代码

server:
  port: 8082
spring:
  datasource:
    url: jdbc:mysql://test-db:3306/mydb
    username: testuser
    password: testpass

3. application-prod.yml

yaml 复制代码

server:
  port: 80
spring:
  datasource:
    url: jdbc:mysql://prod-db:3306/mydb
    username: produser
    password: prodpass

三、配置文件切换方式

（一）通过命令行参数

在启动 Spring Boot 应用时，可以通过--spring.profiles.active参数指定要激活的配置文件。例如，使用命令行启动应用并激活开发环境配置：

ini 复制代码

java -jar myapp.jar --spring.profiles.active=dev

（二）通过系统属性

在启动应用的脚本中设置spring.profiles.active系统属性。例如，在 Linux 环境下：

bash 复制代码

export JAVA_OPTS="-Dspring.profiles.active=dev"
java $JAVA_OPTS -jar myapp.jar

（三）在 application.properties 或 application.yml 中配置

也可以在主配置文件application.properties或application.yml中设置默认激活的配置文件。在application.properties中：

ini 复制代码

spring.profiles.active=dev

在application.yml中：

yaml 复制代码

spring:
  profiles:
    active: dev

四、配置文件优先级

当存在多个配置文件且都包含相同的属性时，Spring Boot 会按照一定的优先级来加载配置。优先级顺序如下：

命令行参数中的配置属性。

SPRING_APPLICATION_JSON中的属性（例如通过环境变量或系统属性设置的 JSON 格式的配置）。

ServletConfig初始化参数。

ServletContext初始化参数。

java:comp/env中的 JNDI 属性。

System.getProperties()返回的系统属性。

System.getenv()返回的环境变量。

通过RandomValuePropertySource生成的random.*属性。

应用的application-{profile}.properties或application.yml文件中的属性，其中{profile}为激活的配置文件。

application.properties或application.yml文件中的属性。

了解配置文件优先级有助于我们在实际开发中正确处理配置冲突问题。

五、动态切换配置文件

在某些场景下，我们可能希望在应用运行时动态切换配置文件。Spring Cloud Config 提供了这样的能力，它允许我们集中管理配置文件，并支持实时刷新配置。通过结合 Spring Cloud Bus，还可以实现配置的广播更新，使多个实例同时获取最新配置。

（一）引入依赖

在pom.xml中添加 Spring Cloud Config 和 Spring Cloud Bus 的依赖：

xml 复制代码

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-client</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>

（二）配置客户端

在bootstrap.properties或bootstrap.yml中配置 Config Server 的地址和要获取的配置文件：

yaml 复制代码

spring:
  application:
    name: myapp
  cloud:
    config:
      uri: http://config-server:8888
      fail-fast: true
      retry:
        max-attempts: 5
        initial-interval: 1000
        multiplier: 1.5

（三）启用配置刷新

在需要刷新配置的控制器或服务类上添加@RefreshScope注解，然后通过发送 POST 请求到/actuator/refresh端点来触发配置刷新。例如：

kotlin 复制代码

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RefreshScope
public class ConfigController {
    @Value("${myapp.config.property}")
    private String configProperty;
    @GetMapping("/config")
    public String getConfig() {
        return configProperty;
    }
}

六、总结

Spring Boot 的配置文件切换机制为我们在不同环境下管理应用配置提供了极大的便利。通过合理使用多环境配置文件、灵活选择切换方式以及了解配置优先级，我们能够高效地开发和部署稳定可靠的 Spring Boot 应用。同时，动态切换配置文件的能力进一步提升了应用的灵活性和可维护性。希望本文能够帮助你深入理解并熟练运用 Spring Boot 的配置文件切换功能。

你觉得这篇文章的内容涵盖是否全面，是否符合你在 Spring Boot 配置文件切换方面的知识分享需求？若你有特定的案例想加入，或者希望我进一步优化某些部分，都可以告诉我。