SpringBoot 学习笔记 Part06

1. yaml简介

springboot常用的配置文件类型有 properties文件和yaml文件。在之前的学习中，我们都是用properties配置文件以 key=value 方式配置。而今天要学习的yaml配置文件，它是一种非常适合用来做以数据为中心的配置文件。

YAML 是 “YAML Ain’t Markup Language”（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）。

首先，我们先在springboot工程里的resources创建一个application.yml。

2. 基本语法

key-value映射格式为 key: value ，注意 key: 和 value 之间必须有一个空格。
yaml大小写敏感，使用缩进表示层级关系，且缩进不允许使用tab，只允许空格。缩进的空格数多少不重要，但是相同层级的元素一定要左对齐。
#表示注释。
字符串无需加引号，但若要加，则需要明白单引号和双引号的区别：
1. 单引号不会读取转义字符，例如字符串里有\n将会被原样打出。
2. 双引号会读取转移字符，如最简单java程序一样，双引号内若加\n会实现一次换行。

对于单双引号问题，我们可以进行一个简单的测试。

person:
  user-name: '张三\n大帅比'
  usee-name2: "张三\n大帅比"

打印结果：

张三\n大帅比
张三
大帅比

3. 数据类型

字面量：单个的、不可再分的值。number、string、boolean、date、null

k: v

数组：一组按次序排列的值。array、list、queue

#行内写法：
k: [v1,v2,v3]

#跨行写法：
k:
  - v1
  - v2
  - v3

对象：键值对的集合。object、map、set、hash

#行内写法：
k: {k1:v1,k2:v2,k3:v3}

#跨行写法：
k:
  k1: v1
  k2: v2
  k3: v3

4. yaml配置实例

首先先准备两个bean类。

@ConfigurationProperties(prefix = "person")
@Component
@ToString
@Data
public class Person {
    private String userName;
    private Boolean boss;
    private Date birth;
    private Integer age;
    private String[] interests;
    private List<String> animal;
    private Set<Double> salarys;
    private Map<String, Object> score;
    private Pet pet;
    private Map<String, List<Pet>> allPets;
}

@Data
public class Pet {
    private String name;
    private Double weight;
}

在yml配置文件里按以上语法填充数据。

person:
  user-name: 张三
  boss: false
  birth: 2022/1/28 18:00
  age: 18
  interests: [足球,篮球,南半球]
  animal:
    - 猫
    - 狗
  salarys:
    - 1000.00
    - 2000.00
  score:
    english:
      first: 30
      second: 40
      third: 50
    math: [11,22,408]
    chinese: {first: 128,second: 256}
  pet:
    name: 企鹅
    weight: 80
  all-pets:
    sick:
      - {name: tom}
      - {name: jerry,weight: 50}
    health: [{name: mario,weight: 60},{name: matial,weight: 70}]

开启springboot应用测试一下数据结果。

@RestController
public class HelloController {

    @Autowired
    Person person;

    @RequestMapping("helloYml")
    public Person helloYml(){
        return person;
    }
}

分析一下数据结果。

{
    "userName":"张三",
    "boss":false,
    "birth":"2022-01-28T10:00:00.000+00:00",
    "age":18,
    "interests":["足球","篮球","南半球"],
    "animal":["猫","狗"],
    "salarys":[1000.0,2000.0],
    "score":{
        "english":{"first":30,"second":40,"third":50},
        "math":{"0":11,"1":22,"2":408},
        "chinese":{"first":128,"second":256}
    },
    "pet":{"name":"企鹅","weight":80.0},
    "allPets":{
        "sick":[{"name":"tom","weight":null},
                {"name":"jerry","weight":50.0}],
        "health":[{"name":"mario","weight":60.0},
                  {"name":"matial","weight":70.0}]
    }
}

对几个重要的地方做一个总结。

bean 类型的 userName 在 yml 配置时可以写成 user-name 来代替大写。
由于 score 是 Map<String, Object>类型，值类型为 Object 。因此当我们第一行为 key=“english” 准备值的时候，用了第三种数据类型（即对象、键值对类型），因此后面的 math、chinese的值类型 Object 会自动和第一个。这样就解释了为什么我们在键入math的值并没有按照第三种数据类型来编写，它自动生成了以 “0” 为首个 key 的键值对。

5. 配置提示

自定义类的配置文件绑定一般没有友好的提示，这时需要手动导入一个依赖坐标。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

并在插件中添加一个configuration标签，设置打成jar包时，不要把processor打包进去，因为打包进去的话会大大浪费JVM的性能。

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <configuration>
        <excludes>
            <exclude>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-configuration-processor</artifactId>
            </exclude>
        </excludes>
    </configuration>
</plugin>