Spring Boot多环境配置文件：解锁最佳实践，告别环境切换烦恼！

本文链接：https://blog.csdn.net/qq_36984455/article/details/149414602

引言

在软件开发的世界里，我们常常会面临多种不同的运行环境，比如开发环境、测试环境、生产环境等。每个环境都有着独特的配置需求，就像不同的舞台需要不同的布景一样。以数据库连接信息为例，开发环境可能使用本地的测试数据库，测试环境使用专门的测试服务器数据库，而生产环境则使用正式的线上数据库，它们的地址、用户名和密码等配置各不相同；日志级别在开发环境可能需要设置为 debug，以便详细查看调试信息，而在生产环境则通常设置为 warn 或 error，以减少日志量和提高性能。

Spring Boot 作为 Java 开发中广受欢迎的框架，为我们提供了强大的多环境配置功能，就像是给我们一把万能钥匙，可以轻松打开不同环境的配置之门，让我们能够在不同环境之间自由切换，极大地提高了开发和部署的效率。接下来，让我们深入探索 Spring Boot 多环境配置的最佳处理方式。

Spring Boot 多环境配置基础

（一）配置文件命名规则

在 Spring Boot 中，默认的配置文件是application.properties或application.yml ，它们就像是项目的基础蓝图，存放着通用的配置信息。而当我们需要针对不同环境进行特定配置时，就可以创建以application-{profile}.properties或application-{profile}.yml命名的文件。这里的{profile}代表着具体的环境名称，比如dev代表开发环境，test代表测试环境，prod代表生产环境。例如application-dev.properties就是开发环境的配置文件，application-prod.yml则是生产环境的配置文件。通过这种命名方式，Spring Boot 能够清晰地区分不同环境的配置，让项目在不同环境下都能有条不紊地运行。

（二）激活指定环境

在 Spring Boot 项目中，我们可以通过多种灵活的方式来激活指定的环境配置，以适应不同的开发、测试和生产场景。

通过配置文件激活：在默认的application.properties或application.yml文件中，添加spring.profiles.active属性来指定要激活的环境。例如，在application.properties中添加spring.profiles.active=dev，就表示激活开发环境配置；若使用application.yml ，则配置如下：

spring:

profiles:

active: dev

通过命令行参数激活：在启动 Spring Boot 应用时，可以在命令行中使用--spring.profiles.active参数来指定激活的环境。比如，我们要激活测试环境，在命令行中输入java -jar myapp.jar --spring.profiles.active=test ，这样应用在启动时就会加载application-test.properties或application-test.yml中的配置。

通过系统环境变量激活：通过设置系统环境变量SPRING_PROFILES_ACTIVE也能达到指定激活环境的目的。在 Linux 系统中，可以使用export SPRING_PROFILES_ACTIVE=prod命令来设置环境变量，将生产环境激活；在 Windows 系统中，可以在系统环境变量设置界面添加或修改SPRING_PROFILES_ACTIVE变量的值。设置完成后，启动 Spring Boot 应用，它就会根据该环境变量加载对应的环境配置文件。

多环境配置的最佳处理方式

（一）多个配置文件方式

在这种方式下，我们就像是为不同的环境量身定制服装一样，为每个环境创建专门的配置文件。以开发、测试、生产环境为例，我们可以在src/main/resources目录下分别创建application-dev.yml 、application-test.yml和application-prod.yml文件。

application-dev.yml主要存放开发环境的配置，比如连接本地开发数据库的信息：

server:

port: 8081

spring:

datasource:

driver-class-name: com.mysql.cj.jdbc.Driver

url: jdbc:mysql://localhost:3306/dev_db?characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false&allowPublicKeyRetrieval=true&useUnicode=true

username: dev_user

password: dev_password

application-test.yml则配置测试环境的相关信息，例如连接测试服务器数据库的配置：

server:

port: 8082

spring:

datasource:

driver-class-name: com.mysql.cj.jdbc.Driver

url: jdbc:mysql://test-server:3306/test_db?characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false&allowPublicKeyRetrieval=true&useUnicode=true

username: test_user

password: test_password

application-prod.yml包含生产环境的关键配置，像连接正式线上数据库的信息：

server:

port: 8080

spring:

datasource:

driver-class-name: com.mysql.cj.jdbc.Driver

url: jdbc:mysql://prod-server:3306/prod_db?characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false&allowPublicKeyRetrieval=true&useUnicode=true

username: prod_user

password: prod_password

然后，在主配置文件application.yml中指定激活的环境配置，假如我们要激活开发环境，配置如下：

spring:

profiles:

active: dev

这样，Spring Boot 在启动时就会优先加载application-dev.yml中的配置，让项目在开发环境中按照我们设定的参数运行。

（二）YAML 多文档块方式

YAML 的多文档块语法就像是一个收纳盒，把不同环境的配置整齐地放在一起，使用---分隔符来定义不同的环境配置。---就像是一个分隔线，清晰地划分出不同环境配置的区域。

我们可以在application.yml文件中使用多文档块来配置多个环境，示例如下：

server:

port: 8080

spring:

profiles:

active: dev

---

spring:

profiles: dev

server:

port: 8081

spring:

datasource:

driver-class-name: com.mysql.cj.jdbc.Driver

url: jdbc:mysql://localhost:3306/dev_db?characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false&allowPublicKeyRetrieval=true&useUnicode=true

username: dev_user

password: dev_password

---

spring:

profiles: test

server:

port: 8082

spring:

datasource:

driver-class-name: com.mysql.cj.jdbc.Driver

url: jdbc:mysql://test-server:3306/test_db?characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false&allowPublicKeyRetrieval=true&useUnicode=true

username: test_user

password: test_password

---

spring:

profiles: prod

server:

port: 8080

spring:

datasource:

driver-class-name: com.mysql.cj.jdbc.Driver

url: jdbc:mysql://prod-server:3306/prod_db?characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false&allowPublicKeyRetrieval=true&useUnicode=true

username: prod_user

password: prod_password

在这个示例中，第一个部分是通用配置和默认激活的环境为dev 。接着，通过---分隔出不同环境的特定配置，每个环境配置块都通过spring.profiles指定了对应的环境名称。当spring.profiles.active被设置为dev时，就会加载spring.profiles: dev下面的配置；设置为test时，加载spring.profiles: test的配置，以此类推。

（三）结合 Maven Profile 方式

Maven Profile 就像是一个神奇的魔法师，在项目构建过程中，能够根据不同的环境需求，定制出不同的构建结果，实现环境定制的强大功能。

在pom.xml中配置 Maven Profile 及与 Spring Boot Profile 结合的步骤如下：

首先，在pom.xml中定义 Maven Profile 。比如定义开发、测试、生产三个 Profile：

<profiles>

<profile>

<id>dev</id>

<activation>

<activeByDefault>true</activeByDefault>

</activation>

<properties>

<environment>dev</environment>

</properties>

</profile>

<profile>

<id>test</id>

<properties>

<environment>test</environment>

</properties>

</profile>

<profile>

<id>prod</id>

<properties>

<environment>prod</environment>

</properties>

</profile>

</profiles>

这里的id就是 Profile 的唯一标识，activeByDefault设置为true表示开发环境的 Profile 默认激活。properties标签中定义的environment属性，会在后续与 Spring Boot Profile 结合时用到。

2. 然后，在application.yml中使用 Maven 属性来激活对应的 Spring Boot Profile 。配置如下：

spring:

profiles:

active: @environment@

这样，当我们执行mvn clean install -Pdev命令时，Maven 会激活dev这个 Profile ，此时@environment@会被替换为dev，从而激活 Spring Boot 的开发环境配置；执行mvn clean install -Ptest则激活测试环境配置，mvn clean install -Pprod激活生产环境配置。通过这种方式，我们可以在构建项目时灵活地选择不同的环境配置，实现项目在不同环境下的快速部署和测试。

（四）@Profile 注解方式

@Profile注解就像是一把精准的钥匙，能够根据不同的环境，打开特定的配置之门，实现根据环境加载不同的 Bean 。

我们可以通过这个注解来定义不同环境下的 Bean 。例如，定义一个数据源 Bean，在开发环境和生产环境可能有不同的实现。

首先，创建一个配置类，在其中使用@Profile注解：

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.context.annotation.Profile;

import javax.sql.DataSource;

import com.zaxxer.hikari.HikariConfig;

import com.zaxxer.hikari.HikariDataSource;

@Configuration

public class DataSourceConfig {

    // 开发环境数据源

    @Bean

    @Profile("dev")

    public DataSource devDataSource() {

        HikariConfig config = new HikariConfig();

        config.setJdbcUrl("jdbc:mysql://localhost:3306/dev_db?characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false&allowPublicKeyRetrieval=true&useUnicode=true");

        config.setUsername("dev_user");

        config.setPassword("dev_password");

        return new HikariDataSource(config);

    }

    // 生产环境数据源

    @Bean

    @Profile("prod")

    public DataSource prodDataSource() {

        HikariConfig config = new HikariConfig();

        config.setJdbcUrl("jdbc:mysql://prod-server:3306/prod_db?characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false&allowPublicKeyRetrieval=true&useUnicode=true");

        config.setUsername("prod_user");

        config.setPassword("prod_password");

        return new HikariDataSource(config);

    }

}

在这个例子中，@Profile("dev")注解表示devDataSource这个 Bean 只在开发环境（dev）下会被创建和使用；@Profile("prod")注解表明prodDataSource这个 Bean 仅在生产环境（prod）下生效。当 Spring Boot 启动时，会根据当前激活的环境来决定创建并使用哪个数据源 Bean 。如果激活的是开发环境，就会创建devDataSource；激活生产环境，则创建prodDataSource 。通过这种方式，我们可以非常灵活地管理不同环境下的 Bean 配置，提高代码的可维护性和可扩展性。

不同处理方式的对比与选择

在实际应用中，选择合适的多环境配置处理方式对于项目的顺利开发和高效部署至关重要，需要综合考虑配置复杂度、灵活性、维护性等多个关键因素。下面我们来详细对比这几种方式：

处理方式	配置复杂度	灵活性	维护性	适用场景
多个配置文件方式	较低，每个环境一个独立文件，结构清晰	较高，可以方便地为每个环境定制大量不同配置	较好，配置文件独立，修改一个环境的配置不会影响其他环境	项目环境配置差异较大，且配置项较多时，如不同环境的数据库连接、服务器端口等完全不同的情况
YAML 多文档块方式	适中，所有环境配置集中在一个文件，但需注意文档块的分隔和语法	高，通过文档块可以在一个文件内快速切换和管理不同环境配置	一般，由于配置集中在一个文件，如果文件较大，查找和修改特定环境配置可能稍显不便	项目配置相对不是特别复杂，且希望将所有环境配置集中管理，方便查看和整体把控时
结合 Maven Profile 方式	较高，涉及到 Maven 和 Spring Boot 配置的结合，需要理解 Maven Profile 和资源过滤机制	高，在项目构建阶段就可以根据不同环境进行定制，方便与 CI/CD 流程集成	一般，Maven 和 Spring Boot 配置相互关联，维护时需要同时关注两者的配置，如果有一方出现问题，排查相对复杂	适合有成熟的 CI/CD 流程，希望在构建项目时就根据不同环境生成不同配置的项目，例如大型企业级项目，在不同的构建阶段（开发、测试、生产）需要不同的配置
@Profile 注解方式	较高，需要在代码中使用注解定义不同环境的 Bean，增加了代码的复杂性	高，针对 Bean 级别的配置非常灵活，可以精确控制不同环境下的 Bean 创建和使用	一般，注解分散在代码中，如果 Bean 较多，管理和维护这些注解及对应的配置可能会变得繁琐	适用于对 Bean 的环境定制要求较高，需要在代码层面精确控制不同环境下的 Bean 创建和使用逻辑的场景，例如某些特殊的业务逻辑 Bean 在不同环境下有不同的实现

通过以上对比，我们可以根据项目的具体特点和需求来选择最合适的多环境配置处理方式。如果项目配置简单且对灵活性要求不高，多个配置文件方式或 YAML 多文档块方式可能就足够；而对于大型复杂项目，结合 Maven Profile 方式或 @Profile 注解方式可能更能满足环境定制和代码管理的需求。

配置文件优先级与注意事项

（一）优先级顺序

在 Spring Boot 中，配置文件的加载有着明确的优先级顺序，就像一个等级分明的 “权力架构”，高优先级的配置会覆盖低优先级的配置，确保项目按照我们期望的方式运行。具体的优先级顺序如下：

命令行参数：在启动 Spring Boot 应用时，通过命令行传递的参数具有最高优先级。例如，使用java -jar myapp.jar --server.port=8081命令启动应用，--server.port=8081这个参数会覆盖其他配置文件中关于server.port的设置。

来自SPRING_APPLICATION_JSON的属性：这是一种特殊的 JSON 格式配置，通常用于在命令行或环境变量中以 JSON 格式传递配置属性，其优先级仅次于命令行参数。

Java 系统属性（System.getProperties()）：通过System.getProperties()获取的系统属性，例如java.version等，也会参与配置加载，优先级相对较高。

操作系统环境变量：操作系统层面设置的环境变量，Spring Boot 也会读取并应用到配置中，优先级排在 Java 系统属性之后。比如在 Linux 系统中设置的JAVA_HOME环境变量，Spring Boot 在启动时可以识别并使用。

RandomValuePropertySource 生成的random.*属性：Spring Boot 会生成一些随机属性，如random.int 、random.long 、random.uuid等，这些属性用于在配置中生成随机值，优先级处于中间位置。例如在配置文件中可以使用${random.int}来获取一个随机整数。

应用程序外部的application-{profile}.properties或application.yml（带spring.profile）配置文件：位于应用程序外部（例如与 jar 包同级目录）的带有环境配置的文件，优先级较高。如果在application-dev.properties和application.yml中都配置了相同的属性，且当前激活的是开发环境，那么application-dev.properties中的配置会生效。

应用程序内部的application-{profile}.properties或application.yml（带spring.profile）配置文件：位于src/main/resources目录下的带有环境配置的文件，优先级稍低。例如src/main/resources/application-test.yml中的配置，当外部没有相同环境的配置文件时，才会生效。

应用程序外部的application.properties或application.yml（不带spring.profile）配置文件：同样位于应用程序外部的通用配置文件，优先级低于带环境配置的外部文件。

应用程序内部的application.properties或application.yml（不带spring.profile）配置文件：src/main/resources目录下的通用配置文件，优先级是所有配置文件中最低的。

在@Configuration类上的@PropertySource注解定义的属性：通过@PropertySource注解加载的属性文件，优先级较低，通常用于加载一些特定的配置文件。例如@PropertySource("classpath:custom.properties")，会加载src/main/resources目录下的custom.properties文件。

默认属性（使用SpringApplication.setDefaultProperties指定）：在代码中通过SpringApplication.setDefaultProperties方法设置的默认属性，优先级最低。例如SpringApplication app = new SpringApplication(MyApp.class); app.setDefaultProperties(Collections.singletonMap("server.port", "8080"));，这里设置的server.port属性，只有在其他配置都没有指定server.port时才会生效。

（二）注意事项

在使用 Spring Boot 多环境配置时，有一些关键的注意事项需要牢记，以确保项目的稳定性、安全性和可维护性。

敏感信息处理：配置文件中常常包含如数据库密码、API 密钥等敏感信息，这些信息一旦泄露，可能会给项目带来严重的安全风险。为了保护敏感信息，我们可以采用多种方法。例如，使用环境变量来存储敏感数据，在应用启动时从环境变量中读取这些值并注入到配置中。在 Linux 系统中，可以通过export DB_PASSWORD=your_password命令设置数据库密码环境变量，然后在 Spring Boot 的配置文件中使用${DB_PASSWORD}来引用这个环境变量；也可以使用加密工具，如 Jasypt，对配置文件中的敏感信息进行加密。首先添加 Jasypt 依赖，然后通过其提供的工具对密码等敏感信息进行加密，将加密后的密文存储在配置文件中，在应用启动时再使用密钥进行解密。

配置文件加载顺序：了解配置文件的加载顺序至关重要，因为高优先级的配置会覆盖低优先级的配置。如果在不同优先级的配置文件中对同一个属性进行了多次设置，最终生效的是高优先级配置文件中的值。在开发过程中，我们需要根据实际需求，将通用的配置放在低优先级的文件中，而将特定环境的配置放在高优先级的文件中。如果希望某个特定环境的数据库连接配置优先生效，就应该将其放在外部的application-{profile}.properties文件中。

避免配置冲突：在多个配置文件或配置方式并存的情况下，要特别注意避免配置冲突。例如，在使用@Profile注解定义 Bean 时，不同环境的 Bean 定义要确保不会产生冲突。如果在开发环境和生产环境都定义了名为dataSource的 Bean，且没有正确使用@Profile注解区分，可能会导致启动错误或运行时异常。在编写配置文件时，要仔细检查每个配置项，确保不同环境的配置相互独立且不冲突。

配置文件管理：随着项目的不断发展，配置文件可能会越来越多，管理起来也会变得复杂。为了提高配置文件的可维护性，建议采用合理的目录结构和命名规范。将所有的配置文件放在一个专门的config目录下，并按照环境和功能进行分类命名。可以将开发环境的配置文件放在config/dev目录下，测试环境的放在config/test目录下，每个目录下的配置文件再根据功能进一步细分，如数据库配置文件命名为database.properties，服务器配置文件命名为server.properties等。