当前位置：首页 > news >正文

Spring Boot外部化配置深度解析

news 2026/5/28 23:55:39

Spring Boot外部化配置深度解析

引言

外部化配置是Spring Boot的核心特性之一，允许将应用配置与代码分离，使得同一个应用可以在不同环境（开发、测试、生产）使用不同的配置。Spring Boot提供了多层次的配置加载机制，从多个来源按优先级加载配置，实现配置的灵活管理。

一、配置源优先级

1.1 配置加载顺序

Spring Boot按照以下顺序加载配置（高优先级覆盖低优先级）：命令行参数；系统环境变量；应用程序属性（application.yml等）；RandomValuePropertySource；profile-specific配置文件；打包在JAR中的默认配置。

1.2 配置属性源

// 获取所有配置属性源 @Autowired private ConfigurableEnvironment environment; public void listPropertySources() { for (PropertySource<?> source : environment.getPropertySources()) { System.out.println(source.getName() + ": " + source.getSource()); } }

二、配置文件详解

2.1 多环境配置

# application.yml - 默认配置 spring: application: name: myapp profiles: active: dev # application-dev.yml - 开发环境 spring: datasource: url: jdbc:mysql://localhost:3306/dev_db username: dev_user password: dev_pass # application-prod.yml - 生产环境 spring: datasource: url: jdbc:mysql://prod-db:3306/prod_db username: prod_user password: ${DB_PASSWORD} # application-test.yml - 测试环境 spring: datasource: url: jdbc:h2:mem:testdb

2.2 YAML配置

# 复杂结构配置 server: port: 8080 servlet: context-path: /api session: timeout: 30m spring: datasource: hikari: maximum-pool-size: 20 minimum-idle: 5 connection-timeout: 30000 idle-timeout: 600000 myapp: cache: caffeine: spec: maximumSize=1000,expireAfterWrite=10m retry: max-attempts: 3 backoff: initial-interval: 1000 multiplier: 2.0 max-interval: 10000

三、配置绑定

3.1 @ConfigurationProperties

@ConfigurationProperties(prefix = "myapp.service") public class ServiceProperties { private String baseUrl; private int timeout = 5000; private boolean enabled = true; private List<String> allowedOrigins = new ArrayList<>(); private Map<String, String> headers = new HashMap<>(); public String getBaseUrl() { return baseUrl; } public void setBaseUrl(String baseUrl) { this.baseUrl = baseUrl; } // getters and setters } @Configuration @EnableConfigurationProperties(ServiceProperties.class) public class ServiceConfig { }

3.2 松散绑定

// application.yml中可以使用以下格式 myapp: service: base-url: http://localhost # 绑定到 baseUrl timeout-ms: 5000 # 绑定到 timeout enabled-flag: true # 绑定到 enabled

3.3 数据校验

@ConfigurationProperties(prefix = "myapp.service") @Validated public class ServiceProperties { @NotBlank private String baseUrl; @Min(1000) @Max(60000) private int timeout = 5000; @Pattern(regexp = "\\d+\\.\\d+\\.\\d+\\.\\d+") private String ipAddress; @Email private String adminEmail; }

四、环境变量和系统属性

4.1 环境变量配置

# Linux/Mac export SPRING_DATASOURCE_URL=jdbc:mysql://localhost:3306/mydb export SPRING_DATASOURCE_USERNAME=root export SPRING_DATASOURCE_PASSWORD=secret # Windows set SPRING_DATASOURCE_URL=jdbc:mysql://localhost:3306/mydb

4.2 命令行参数

java -jar app.jar --spring.profiles.active=prod \ --server.port=8443 \ --myapp.service.base-url=http://api.example.com

4.3 随机值配置

# 生成随机值 myapp: secret: ${random.uuid} number: ${random.int} long-number: ${random.long} port: ${random.int[1024,65536]} value: ${random.value}

五、配置加密

5.1 Jasypt集成

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

# 配置文件 jasypt: encryptor: algorithm: PBEWithMD5AndDES password: ${JASYPT_PASSWORD} iv-generator-classname: org.jasypt.iv.RandomIvGenerator myapp: database: password: ENC(加密后的密文)

// 加密工具类 @Service public class PasswordEncryptService { private final StringEncryptor stringEncryptor; public StringEncryptService(StringEncryptor stringEncryptor) { this.stringEncryptor = stringEncryptor; } public String encrypt(String plainText) { return stringEncryptor.encrypt(plainText); } public String decrypt(String encryptedText) { return stringEncryptor.decrypt(encryptedText); } }

5.2 敏感配置外部化

# 启动时指定加密密钥 java -Djasypt.encryptor.password=mySecretPassword \ -jar app.jar

六、配置导入

6.1 Spring Boot 2.4+导入

# 从外部文件导入配置 spring: config: import: optional:file:./config.yaml import: optional:classpath:defaults.properties

6.2 Profile条件导入

spring: config: import: - optional:classpath:application-common.yml - optional:classpath:application-${spring.profiles.active}.yml

七、配置刷新

7.1 Spring Cloud配置刷新

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-config</artifactId> </dependency>

management: endpoints: web: exposure: include: refresh,health,info

@RefreshScope @ConfigurationProperties(prefix = "myapp.service") public class ServiceProperties { // 配置更新后会自动刷新 }

7.2 配置监听

@Component public class ConfigChangeListener { @EventListener public void onApplicationEvent( EnvironmentChangeEvent event) { for (String key : event.getKeys()) { System.out.println("配置变更: " + key + " = " + environment.getProperty(key)); } } }

八、最佳实践

8.1 配置组织

resources/ ├── application.yml # 公共配置 ├── application-dev.yml # 开发环境 ├── application-test.yml # 测试环境 ├── application-prod.yml # 生产环境 └── application-local.yml # 本地覆盖

8.2 配置分层

# application.yml spring: application: name: myapp profiles: active: ${SPRING_PROFILES_ACTIVE:dev} # 公共配置 myapp: version: 1.0.0 description: My Application # 环境特定配置在对应文件中