6、《YAML vs Properties：配置文件进阶玩法》

YAML vs Properties：配置文件进阶玩法

在Spring Boot开发中，配置文件是应用不可或缺的组成部分。本文将通过多环境配置、外部化配置和**@ConfigurationProperties绑定**三个核心场景，深度对比YAML与Properties配置格式的特性，并辅以实战代码示例。

---

一、格式特性对比

1.1 Properties文件

# 扁平化键值对
app.name=OrderService
server.port=8080
datasource.url=jdbc:mysql://localhost:3306/mydb

1.2 YAML文件

# 结构化层级表示
app:
  name: OrderService
server:
  port: 8080
datasource:
  url: jdbc:mysql://localhost:3306/mydb

核心差异：

• 结构表达：YAML通过缩进实现层级结构
• 数据类型：YAML原生支持数组/对象等复杂类型
• 可读性：YAML更适合复杂配置场景
• 多文档支持：YAML可用---分隔多组配置

---

二、多环境配置实战

2.1 环境隔离方案

两种格式都支持application-{profile}.yml/properties命名规范

YAML多环境配置示例：

# application-dev.yml
spring:
  profiles: dev
server:
  port: 8081
logging:
  level:
    root: debug

---
# application-prod.yml
spring:
  profiles: prod
server:
  port: 80
logging:
  level:
    root: warn

Properties多环境配置示例：

# application-dev.properties
spring.profiles=dev
server.port=8081
logging.level.root=debug

# application-prod.properties
spring.profiles=prod
server.port=80
logging.level.root=warn

2.2 激活方式

# 命令行激活
java -jar app.jar --spring.profiles.active=prod

# 系统环境变量
export SPRING_PROFILES_ACTIVE=dev

---

三、外部化配置进阶

3.1 配置加载优先级

Spring Boot按以下顺序加载配置（数字越小优先级越高）：

1. 命令行参数
2. 外部配置文件（jar包同目录/config子目录）
3. 内部配置文件（classpath内）
4. @Configuration类上的@PropertySource

3.2 动态覆盖配置

# 命令行覆盖示例
java -jar app.jar --server.port=9090

# 环境变量注入（Linux/Mac）
export SERVER_PORT=9090

---

四、@ConfigurationProperties绑定实战

4.1 配置类定义

@Configuration
@ConfigurationProperties(prefix = "app")
public class AppConfig {
    private String name;
    private List<String> servers;
    private Map<String, String> metadata;
    
    // 省略getter/setter
}

4.2 YAML配置绑定

app:
  name: InventoryService
  servers:
    - 192.168.1.101
    - 192.168.1.102
  metadata:
    env: production
    region: us-east

4.3 Properties配置绑定

app.name=InventoryService
app.servers[0]=192.168.1.101
app.servers[1]=192.168.1.102
app.metadata.env=production
app.metadata.region=us-east

4.4 类型安全验证

@Validated
public class AppConfig {
    @NotEmpty
    private String name;
    
    @Size(min = 1, max = 5)
    private List<String> servers;
}

---

五、混合配置策略

5.1 格式混用原则

• 优先使用YAML管理复杂配置
• 使用Properties进行简单覆盖
• 通过spring.config.use-legacy-processing=true启用混合处理

5.2 组合配置示例

# application.yml
spring:
  datasource:
    url: jdbc:h2:mem:testdb
    username: sa
    password: 

# application-prod.properties
spring.datasource.url=jdbc:mysql://prod-db:3306/mydb
spring.datasource.username=prod_user

---

六、最佳实践建议

1. 多环境场景：优先使用YAML多文档特性
2. 团队协作：保持一致的缩进规范（建议2空格）
3. 安全配置：敏感信息使用外部化配置
4. 版本控制：将基础配置纳入版本管理
5. 配置校验：结合@Validated进行参数验证

---

附录：配置格式选择矩阵

场景	推荐格式	说明
简单键值对配置	Properties	快速上手，直观简洁
复杂层级配置	YAML	结构清晰，可读性更佳
需要类型推断的场景	YAML	自动识别boolean/number等类型
需要多文档支持的配置	YAML	使用---分隔多个配置块
需要与shell脚本配合	Properties	方便环境变量直接映射

通过合理选择配置格式，结合Spring Boot的强大特性，可以构建出灵活高效的配置管理体系。
下期预告：《Spring Boot Starter：揭秘依赖管理的终极奥义》——手把手教你打造专属Starter！