SpringBoot多环境配置数据读取方式

本文主要是介绍SpringBoot多环境配置数据读取方式，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

《SpringBoot多环境配置数据读取方式》SpringBoot通过环境隔离机制,支持properties/yaml/yml多格式配置,结合@Value、Environment和@Configura...

一个SpringBoot项目在实际开发中通常需要在开发环境、测试环境和生产环境中切换运行，而不同环境的配置（如数据库连接、端口号、日志级别）往往不同，手动修改配置不仅繁琐，还容易出错，而SpringBoot提供了灵活的多环境配置机制。

一、多环境配置的核心思路

多环境配置的核心是“环境隔离”：将不同环境的配置分离到独立文件中，通过指定“环境标识”自动加载对应配置。

核心优势：

避免手动修改配置，减少人为错误；
配置与环境强关联，清晰易维护；
支持灵活切换环境，适应不同阶段需求。

二、3种配置文件格式详解

SpringBoot支持properties、yaml和yml三种配置文件格式，其中yaml/yml以简洁的缩进语法更受欢迎。

2.1 properties格式（传统格式）

properties文件采用key=value格式，多环境配置通过“文件名+环境标识”区分。

1. 基础配置文件（application.properties）

存放公共配置（所有环境共享的配置）：

# 公共配置（所有环境共享）
server.port=8080 # 默认端口（可被环境配置覆盖）
spring.application.name=multi-env-demo

2. 环境专属配置文件

开发环境：application-dev.properties

# 开发环境配置
server.port=8081
spring.datasource.url=jdbc:mysql://localhost:3306/dev_db
spring.datasource.username=dev_user
spring.datasource.password=dev_pwd

测试环境：application-test.properties

# 测试环境配置
server.port=8082
spring.datasource.url=jdbc:mysql://test-server:3306/test_db
spring.datasource.username=test_user
spring.datasource.password=test_pwd

生产环境：application-prod.properties

# 生产环境配置
server.port=80
spring.datasource.url=jdbc:mysql://prod-server:3306/prod_db
spring.datasource.username=prod_user
spring.datasource.password=prod_pwd

2.2 yaml/yml格式（推荐）

yaml和yml是同一种格式（后缀不同），采用缩进+键值对语法，结构清晰，支持列表和嵌套。

1. 单文件多环境配置（推荐）

yaml支持在一个文件中通过spring.profiles区分环境，无需创建多个文件：

# application.yml
# 公共配置
spring:
  application:
    name: multi-env-demo
  profiles:
    active: dev # 默认激活开发环境
# 开发环境（通过---分隔）
---
spring:
  profiles: dev
server:
  port: 8081
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/dev_db
    username: dev_user
    password: dev_pwd
# 测试环境
---
spring:
  profiles: test
server:
  port: 8082
spring:
  datasource:
    url: jdbc:mysql://test-server:3306/test_db
    username: test_user
    password: test_pwd
# 生产环境
---
spring:
  profiles: prod
server:
  port: 80
spring:
  datasource:
    url: jdbc:mysql://prod-server:3306/prod_db
    username: prod_user
    password: prod_pwd

语法说明：

用---分隔不同环境的配置块；
spring.profiles: dev指定环境标识（与properties的-dev对应）；
spring.profiles.active: dev指定默认激活的环境。

2. 多文件yaml配置（类似properties）

也可将不同环境配置拆分到独立文件：

公共配置：application.yml
开发环境：application-dev.yml
测试环境：application-test.yml
生产环境：application-prod.yml

2.3 三种格式的对比与选择

格式	语法特点	优势	劣势	适用场景
properties	`key=value`，无缩进	兼容性好，适合简单配置	冗余代码多，不支持嵌套	传统项目、简单配置
yaml/yml	缩进语法，支持嵌套	简洁直观，支持复杂结构	对缩进敏感（空格错误易出错）	推荐使用，尤其是复杂配置

建议：优先使用单文件yaml配置，减少文件数量，提高维护效率。

三、多环境配置的数据读取方式

SpringBoot提供了多种方式读取配置文件中的数据，满足不同场景需求。

3.1 @Value注解（简单值读取）

@Value("${key}")用于读取简单类型的配置（字符串、数字等），直接注入到变量中。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class EnvController {
    // 读取端口号
    @Value("${server.port}")
    private int port;
    // 读取数据库URL（支持默认值：${key:默认值}）
    @Value("${spring.datasource.url:jdbc:mysql://localhost:3306/default_db}")
    private String dbUrl;
    @GetMapping("/env")
    public String getEnvInfo() {
        return "当前端口：" + port + "，数据库地址：" + dbUrl;
    }
}

特点：

适用于读取零散的简单配置；
支持默认值（${key:默认值}），当配置不存在时使用默认值；
不适合读取复杂对象（如嵌套结构）。

3.2 Environment对象（灵活读取）

Environment是Spring的核心接口，可通过getProperty("key")方法动态读取配置，支持默认值和类型转换。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class EnvController {
    @Autowired
    private Environment env;
    @GetMapping("/env2")
    public String getEnvInfo2() {
        // 读取字符串
        String username = env.getProperty("spring.datasource.username");
        // 读取整数（指定类型）
        Integer port = env.getProperty("server.port", Integer.class);
        // 读取并指定默认值
        String driver = env.getProperty("spring.datasource.driver-class-name", 
                                       "com.mysql.cj.jdbc.Driver");
        return "用户名：" + username + "，端口：" + port + "，驱动：" + driver;
    }
}

特点：

适合动态读取配置（如根据条件读取不同key）；
支持类型转换（无需手动强转）；
需注入Environment对象，稍显繁琐。

3.3 @ConfigurationProperties（对象封装，推荐）

@ConfigurationProperties用于将配置文件中的一组相关配置封装为Java对象，适合读取复杂配置（如数据库连接信息、自定义配置）。

步骤1：定义配置类并绑定配置

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.spphpringframework.stereotype.Component;
// 绑定前缀为"spring.datasource"的配置
@ConfigurationProperties(prefix = "spring.datasource")
@Component // 注册为Spring组件
public class DataSourceProperties {
    private String url;
    private String username;
    private String password;
    private String driverClassName;
    // 必须提供getter和setter（Spring通过setter注入）
    public String getUrl() { return url; }
    public void setUrl(String url) { this.url = url; }
    public String getUsername() { return username; }
    public void setUsername(String username) { this.username = username; }
    public String getPassword() { return password; }
    public void setPassword(String password) { this.password = password; }
    public String getDriverClassName() { return driverClassName; }
    public void setDriverClassName(String driverClassName) { this.driverClassName = driverClassName; }
}

步骤2：在配置文件中添加对应配置

# application.yml（开发环境）
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/dev_db
    username: dev_user
    password: dev_pwd
    driver-class-name: com.mysql.cj.jdbc.Driver

步骤3：使用配置对象

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class EnvController {
    @Autowired
    private DataSourceProperties dataSourceProps;
    @GetMapping("/db")
    public String getDbInfo() {
        return "数据库配置：" + 
               "URL=" + dataSourceProps.getUrl() + 
               "，用户名=" + dataSourceProps.getUsername();
    }
}

特点：

适合读取一组相关配置（如数据库、缓存、第三编程方API等）；
支持嵌套结构（如spring.Redis.host、spring.redis.port可封装为RedisProperties）；
配合@Validated可实现配置校验（如非空检查、格式校验）。

四、自定义对象封装（复杂配置示例）

对于自定义的复杂配置（如支付接口参数、缓存策略），@ConfigurationProperties同样适用。

示例：封装支付接口配置

1. 配置文件（application.yml）

# 自定义支付配置
pay:
  api:
    url: https://pay-dev-api.com
    timeout: 3000 # 超时时间（毫秒）
  merchant:
    id: dev_merchant_123
    key: dev_pay_key
  supported-types: # 支持的支付方式（列表）
    - WECHAT
    - ALIPAY

2. 定义配置类

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.List;
@ConfigurationProperties(prefix = "pay")
@Component
public class PayProperties {
    private Api api;
    private Merchant merchant;
    private List<String> supportedTypes;
    // 内部类：API配置
    public static class Api {
        private String url;
        private int timeout;
        // getter和setter
    }
    // 内部类：商户配置
    public static class Merchant {
        private String id;
        private String key;
        // getter和setter
    }
    // 外部类的getter和setter
    public Api getApi() { return api; }
    public void setApi(Api api) { this.api = api; }
    public Merchant getMerchant() { return merchant; }
    public void setMerchant(Merchant merchant) { this.merchant = merchant; }
    public List<String> getSupportedTypes() { return supportedTypes; }
    public void setSupportedTypes(List<String> supportedTypes) { this.supportedTypes = supportedTypes; }
}

3. 使用自定义配置

@Autowired
private PayProperties payProps;
@GetMapping("/pay")
public String getPayInfo() {
    return "支付API：" + payProps.getApi().getUrl() + 
           "，支持方式：" + payProps.getSupportedTypes();
}

五、多环境启动方式

SpringBoot提供了多种方式指定激活的环境，灵活满足不同场景（开发、测试、部署）。

5.1 配置文件中指定（默认方式）

在application.yml或application.properties中通过spring.profiles.active指定：

# application.yml
spring:
  profiles:
    active: test # 默认激活测试环境

# application.properties
spring.profiles.active=prod # 默认激活生产环境

5.2 命令行参数指定（优先级最高）

启动jar包时通过--spring.profiles.active参数指定环境，优先级高于配置文件：

# 启动开发环境
java -jar multi-env-demo.jar --spring.profiles.active=dev
# 启动生产环境（指定端口）
java -jar multi-env-demo.jar --spring.profiles.active=prod --server.port=8080

优势：部署时无需修改配置文件，直接通过命令切换环境。

5.3 IDE中指定（开发调试）

在IDEA/Eclipse中配置启动参数，方便开发调试：

IDEA配置步骤：

打开Run/Debug Configurations；
在Program arguments中添加：--spring.profiles.active=dev；
启动项目，自动加载开发环境配置。

5.4 环境变量指定（服务器部署）

在服务器中通过环境变量SPRING_PROFILES_ACTIVE指定，适合容器化部署（如docker、K8s）：

# linux环境设置环境变量
export SPRING_PROFILES_ACTIVE=prod
# 启动项目（自动读取环境变量）
java -jar multi-env-demo.jar

Docker示例：

FROM openjdk:8-jdk-slim
ENV SPRING_PROFILES_ACTIVE=prod # 设置环境变量China编程
COPY target/multi-env-demo.jar app.jar
ENTRYPOINT ["java", "-jar", "/app.jar"]

六、Maven多环境控制（兼容联动）

通过Maven的profiles配置，可在打包时自动指定SpringBoot的激活环境，实现“一次打包，多环境部署”。

6.1 配置pom.xml

在pom.xml中定义Maven环境，并通过resource filtering替换配置文件中的占位符：

<project>
    <!-- ... 其他配置 ... -->
    <profiles>
        <!-- 开发环境 -->
        <profile>
            <id>dev</id>
            <activation>
                <activeByDefault>true</activeByDefault> <!-- 默认激活开发环境 -->
            </activation>
            <properties>
                <spring.profile.active>dev</spring.profile.active> <!-- 对应Spring环境标识 -->
            </properties>
        </profile>
        <!-- 测试环境 -->
        <profile>
            <id>test</id>
            <properties>
                <spring.profile.active>test</spring.profile.active>
            </properties>
        </profile>
        <!-- 生产环境 -->
        <profile>
            <id>prod</id>
            <properties>
                <spring.profile.active>prod</spring.profile.active>
            </properties>
        </profile>
    </profiles>
    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <!-- 开启资源过滤：替换配置文件中的${变量} -->
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>
</project>

6.2 修改配置文件（使用Maven变量）

在application.yml中android用@spring.profile.active@引用Maven变量：

# application.yml
spring:
  profiles:
    active: @spring.profile.active@ # 由Maven打包时替换

6.3 打包与启动

通过Maven命令指定环境打包，生成的jar包会自动激活对应环境：

# 打包开发环境（默认）
mvn clean package
# 打包测试环境
mvn clean package -P test
# 打包生产环境
mvn clean package -P prod

启动jar包时无需再指定环境（已由Maven固化到配置中）：

java -jar target/multi-env-demo.jar # 自动使用打包时指定的环境

优势：

打包时绑定环境，避免部署时误操作；
适合CI/CD流程（如Jenkins根据分支自动选择环境打包）。

七、常见问题与避坑指南

7.1 配置文件优先级问题

SpringBoot配置文件的加载顺序（优先级从高到低）：

命令行参数（--spring.profiles.active=dev）；
环境变量（SPRING_PROFILES_ACTIVE=dev）；
系统属性（如-Dspring.profiles.active=dev）；
application-{profile}.yml（环境专属文件）；
application.yml（公共配置文件）；
类路径下的config目录（src/main/resources/config/）中的配置文件；
类路径根目录（src/main/resources/）中的配置文件。

避坑点：若同一配置在多个地方定义，高优先级配置会覆盖低优先级配置。例如，命令行指定的server.port=8888会覆盖配置文件中的server.port=8080。

建议：开发环境用配置文件默认值，测试/生产环境通过命令行或环境变量指定，避免配置文件冲突。

7.2 配置冲突与覆盖规则

当公共配置与环境专属配置存在相同key时，环境专属配置会覆盖公共配置。

示例：

# 公共配置（application.yml）
server:
  port: 8080
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
# 开发环境配置（application-dev.yml）
server:
  port: 8081 # 覆盖公共配置的8080
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/dev_db # 新增配置

结果：开发环境最终端口为8081，数据库驱动沿用公共配置的com.mysql.cj.jdbc.Driver。

注意：若同一环境配置在多个文件中定义（如application-dev.yml和application-dev.properties），properties文件优先级高于yaml文件（因文件格式优先级）。

7.3 敏感信息泄露问题

配置文件中的数据库密码、API密钥等敏感信息直接明文存储，存在安全风险。

解决方案：

Spring Cloud Config/Spring Cloud Vault：集中管理配置，加密存储敏感信息（适合微服务架构）；
Jasypt加密：通过jasypt对敏感信息加密，项目启动时解密。

Jasypt使用示例：

引入依赖：

<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>
    <version>3.0.4</version>
</dependency>

配置加密密钥（生产环境通过命令行传入，避免硬编码）：

jasypt:
  encryptor:
    password: ${JASYPT_PASSWORD:dev_key} # 开发环境默认密钥，生产环境从环境变量获取

生成加密后的密码（通过代码或命令行）：

import org.jasypt.encryption.StringEncryptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
@Component
public class EncryptRunner implements CommandLineRunner {
    @Autowired
    private StringEncryptor encryptor;
    @Override
    public void run(String... args) throws Exception {
        String password = "prod_pwd";
        String encrypted = encryptor.encrypt(password);
        System.out.println("加密后：" + encrypted); // 输出如：EbfYkitulv73I2p0mXI50Q==
    }
}

在配置文件中使用加密值（用ENC()包裹）：

spring:
  datasource:
    password: ENC(EbfYkitulv73I2p0mXI50Q==)

7.4 多环境下的配置激活失败

常见原因：

环境标识拼写错误（如spring.profiles.active: deve，正确应为dev）；
配置文件命名错误（如application-devl.yml，正确应为application-dev.yml）；
单文件yaml中未用---分隔环境块，导致配置不生效；
Maven过滤未开启，@spring.profile.active@未被正确替换。

排查步骤：

检查启动日志，搜索The following profiles are active，确认激活的环境是否正确；
检查配置文件路径和命名，确保与环境标识匹配；
若使用Maven多环境，打包后解压jar包，查看BOOT-INF/classes/application.yml中spring.profiles.active是否被正确替换。

7.5 复杂配置的校验问题

使用@ConfigurationProperties封装配置时，若配置缺失或格式错误，可能导致业务异常。

解决方案：通过@Validated和jsR-303注解（如@NotNull、@Min）进行配置校验。

示例：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;
@ConfigurationProperties(prefix = "pay.api")
@Component
@Validated // 开启校验
public class PayApiProperties {
    @NotEmpty(message = "支付API地址不能为空")
    private String url;
    @Min(value = 1000, message = "超时时间不能小于1000毫秒")
    private int timeout;
    // getter和setter
}

若配置缺失或不符合规则，项目启动时会直接报错，避免运行时异常：

Binding to target org.springframework.boot.context.properties.bind.BindException: 
Failed to bind properties under 'pay.api' to com.example.config.PayApiProperties failed:
    Property: pay.api.url
    Value: null
    Reason: 支付API地址不能为空

总结

SpringBoot多环境配置的核心是“隔离与灵活切换”，结合实际开发经验，最佳实践如下：

配置文件格式：优先使用单文件yaml配置，通过---分隔环境，减少文件数量；
配置读取：简单配置用@Value，复杂配置用@ConfigurationProperties（配合校验）；
环境激活：开发环境用配置文件默认值，测试/生产环境通过命令行参数或环境变量指定，避免修改配置文件；
敏感信息：禁止明文存储，使用Jasypt加密或配置中心管理；
Maven联动：通过Maven profiles实现“打包绑定环境”，适合CI/CD自动化部署；
配置校验：对核心配置添加校验规则，确保启动阶段暴露问题。

到此这篇关于SpringBoot之多环境配置全解析的文章就介绍到这了,更多相关SpringBoot多环境配置内容请搜索编程China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持China编程(www.chinasem.cn)！

这篇关于SpringBoot多环境配置数据读取方式的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！