Spring 配置文件详解：Properties 与 YAML 格式对比及实战

4.2. 读取配置文件

如果想要主动的读取配置文件中的内容，可以使用 @Value 注解来实现。注解使用 @Value("${}") 的格式读取，如下代码所示：

package com.yang.test1_30_1;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/prop")
public class PropertiesController {
    @Value("${spring.datasource.url}")
    private String url;
    @Value("${my.key1}")
    private Integer key1;
    @Value("${my.key2}")
    private Boolean key2;

    @RequestMapping("/read")
    public String readProperties() {
        System.out.println(key1);
        System.out.println(key2);
        return "从配置文件中，读取 url" + url;
    }
}

spring.application.name=Test1_30_1
server.port=8081
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/testdb?characterEncoding=utf8&useSSL=false
spring.datasource.username=root
spring.datasource.password=root
my.key1=5
my.key2=true

4.3. properties 缺点分析

properties 配置文件以 key-value（键值对） 形式进行配置，其核心缺点是存在大量冗余信息，具体表现如下：

spring.datasource.url=jdbc:mysql://127.0.0.1:3306/testdb?characterEncoding=utf8&useSSL=false
spring.datasource.username=root
spring.datasource.password=root

可见配置的 key 中，spring.datasource 这一前缀会重复出现多次，此类重复内容即为冗余信息，增加了配置文件的编写成本与维护复杂度。

还有一点需要注意：如果我们在 application.properties 里面加入了一些中文注释，当我们关闭项目之后再次打开，就会出现乱码。我们只需使用快捷键 ctrl + alt + s 打开 IDEA 的设置，把下面两个地方改成 UTF-8 即可。

五、yml 配置文件说明

5.1. yml 基本语法

yml 是树形结构的配置文件，它的基础语法是 "key: value"。key 和 value 之间使用英文冒号和空格组成，并且空格不能省略。

# 单层 yaml
yaml:
  aa: hello
# 多层 yaml
spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/testdb?
    username: root
    password: root

5.2. yml 进阶

1. yml 配置不同数据及 null

# 字符串
string.value: Hello
# 布尔值
boolean.value1: true
boolean.value2: false
# 整数
int.value: 10
# 浮点数
float.value: 3.14
# Null
null.value: ~

获取配置的方式与 properties 的方式一样，都是使用 @Value 注解。

package com.yang.test1_31_1;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RequestMapping("/yaml")
@RestController
public class YamlController {
    @Value("${yaml}")
    private String yaml;
    @Value("${spring.datasource.username}")
    private String username;

    @RequestMapping("/read")
    public String read() {
        System.out.println(yaml);
        System.out.println(username);
        return "success";
    }
}

2. 配置对象

student:
  id: 1
  name: John
  age: 21

这里想要获取配置，需要使用另外一个注解 @ConfigurationProperties 来读取。

package com.yang.test1_31_2;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

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

package com.yang.test1_31_2;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RequestMapping("/yaml")
@RestController
public class TestController {
    @Autowired
    private Student student;

    @RequestMapping("/read")
    public void read() {
        System.out.println(student);
    }
}

3. 配置集合

集合的读取和对象的方式一样。

dbtypes:
  name:
    - mysql
    - sqlserver
    - db1

package com.yang.test1_31_3;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import java.util.List;

@Configuration
@ConfigurationProperties(prefix = "dbtypes")
@Data
public class DbType {
    private List<String> name;
}

package com.yang.test1_31_3;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/yaml")
public class TestController {
    @Autowired
    private DbType dbType;

    @RequestMapping("/read")
    public String read() {
        System.out.println(dbType);
        return "success";
    }
}

4. 配置 map

maptypes:
  map:
    k1: aaa
    k2: bbb
    k3: ccc

package com.yang.test1_31_4;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import java.util.Map;

@Configuration
@ConfigurationProperties(prefix = "maptypes")
@Data
public class MapConfig {
    private Map<String, String> map;
}

package com.yang.test1_31_4;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/yaml")
public class TestController {
    @Autowired
    private MapConfig mapConfig;

    @RequestMapping("/read")
    public String read() {
        System.out.println(mapConfig);
        return "success";
    }
}

5.3. yml 优缺点

一、优点

1. 可读性与易用性佳：写法简单直观，采用树形结构，降低了理解成本，便于开发和维护时快速获取配置信息。
2. 支持更多数据类型：可轻松表达对象、数组、List、Map 等多种数据形态，能更灵活地满足项目中不同结构的配置需求，无需像 properties 格式那样重复书写冗余的键前缀。
3. 跨语言兼容性强：不仅可在 Java 中使用，还支持 Golang、Python、Ruby、JavaScript 等多种编程语言，适用范围更广，便于多语言协作的项目统一配置风格。

二、缺点

1. 不适合复杂配置场景：面对复杂配置（如多层嵌套、多维度关联的配置），转换为 yml 格式时需花费较多精力，且配置层级过多后可读性会显著下降，代码编写难度也随之增加。
2. 格式要求严格：对语法格式（如 key 与 value 间需加英文冒号和空格、层级缩进等）有极强的约束性，微小的格式错误（如缺少空格、缩进不一致）就可能导致配置加载失败，即文档中提到的'一个空格可能会引起一场血案'。