SpringBoot 配置文件核心用法：Properties 与 YAML

配置示例：

mykey.key1 = bite

访问 /key 接口时，会返回配置文件中 mykey.key1 对应的值。

@PostConstruct 核心说明

@PostConstruct 是 Java EE 中的注解（Spring 也完全支持），作用是：在 Spring 容器创建完 Bean 实例、完成依赖注入后，自动执行标注了这个注解的方法。

简单说：Bean 先被创建 → 依赖注入（比如 @Autowired 注入的对象）→ @PostConstruct 方法执行。这常用于初始化数据、加载配置或预加载缓存，确保依赖注入完成后才能安全使用对象。

完整示例：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;

@Component
public class UserService {
    @Autowired
    private ConfigService configService;

    @PostConstruct
    public void init() {
        // 此时 configService 已经完成注入，可安全使用
        String config = configService.getConfig();
        System.out.println("Bean 初始化完成，加载配置：" + config);
    }
}

关键点：

1. 标注的方法必须是：无参数、无返回值（void）、非静态。
2. 执行时机：晚于 @Autowired 依赖注入，早于 Bean 被业务代码使用。

properties 缺点分析

properties 配置是以 key-value 的形式配置的，配置项较多时会有冗余信息，例如 spring.datasource.url。想要解决这个问题，就可以使用 yml 配置文件的格式化结构。

yml 配置文件说明

yml 是 YAML 的缩写，全称是 Yet Another Markup Language。它是树形结构的配置文件，基础语法是 key: value。

yml 基本语法

• key 和 value 之间使用英文冒号加空格的方式组成，空格不可省略。
• 支持多种数据类型，包括字符串、数字、布尔值、空值、日期等。

1. 基础键值对

# 正确写法（冒号后必须带空格）
server:
  port: 8080
  host: localhost

# 错误写法（无空格，配置无法解析）
# server:port:8080

2. 数据类型

# 字符串（默认无需引号，特殊字符需加引号）
name: 张三
nickname: "zhangsan:001"
remark: 'hello\nworld' # 单引号会转义特殊字符

# 数字
age: 20
score: 98.5

# 布尔值
enabled: true
disabled: false

# 空值
empty: null
# 或 ~

# 日期（ISO 8601 格式）
birthday: 2024-03-18

3. 集合 / 数组

# 写法 1：短横线 + 空格（推荐，层级清晰）
user:
  hobbies:
    - 篮球
    - 游泳
    - 编程

# 写法 2：中括号简写（单行）
user:
  tags: [Java, SpringBoot, MySQL]

4. 对象 / 嵌套配置

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/test
    username: root
    password: 123456
  redis:
    host: 127.0.0.1
    port: 6379
    timeout: 5000ms

5. 注释规则

# 单行注释（仅支持单行，用 # 开头）
server:
  port: 8080 # 端口配置（行内注释也需用 #）
# 多行注释需每行加 #

yml 使用进阶

配置对象

在 yml 中配置对象，如下所示：

student:
  id: 1
  name: Java
  age: 18

或者使用行内写法：

student: {id: 1, name: Java, age: 18}

此时就不能用 @Value 来读取配置中的对象了，需要使用 @ConfigurationProperties 注解来批量绑定。

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@ConfigurationProperties(prefix = "student")
@Component
@Data
public class Student {
    private int id;
    private String name;
    private int age;
}

调用类实现：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class StudentController {
    @Autowired
    private Student student;

    @RequestMapping("/readStudent")
    public String readStudent() {
        return student.toString();
    }
}

配置集合

配置文件也可以配置 List 集合：

dbtypes:
  name:
    - mysql
    - sqlserver
    - db2

同样使用 @ConfigurationProperties 读取：

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.List;

@Component
@ConfigurationProperties("dbtypes")
@Data
public class ListConfig {
    private List<String> name;
}

配置 Map

配置文件也可以配置 Map：

maptypes:
  map:
    k1: kk1
    k2: kk2
    k3: kk3

读取方式同上：

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.HashMap;

@Component
@ConfigurationProperties("maptypes")
@Data
public class MapConfig {
    private HashMap<String,String> map;
}

yml 优缺点

优点

1. 可读性高，写法简单，易于理解。
2. 支持更多的数据类型，可以简单表达对象、数组、List、Map 等数据形态。
3. 跨语言支持好，不仅 Java，Golang、Python、Ruby、JavaScript 等均可使用。

缺点

1. 不适合写复杂的配置文件，转换过程较繁琐，复杂配置下可读性可能下降。
2. 对格式要求严格，缩进或空格错误可能导致解析失败。

例如，properties 格式的复杂嵌套配置：

keycloak.realm = demo
keycloak.resource = fm-cache-cloud
keycloak.credentials.secret = d4589683-0ce7-4982-bcd3
keycloak.security[0].authRoles[0] = user

转换为 yml 则更直观：

keycloak:
  realm: demo
  resource: fm-cache-cloud
  credentials:
    secret: d4589683-0ce7-4982-bcd3
  security:
    - authRoles:
        - user

总之，虽然 yml 对格式敏感，但其清晰的层级结构在实际开发中通常优于 properties。