SpringBoot（二）YAML 配置文件语法

SpringBoot 使用 application.properties 或 application.yml 文件作为全局配置文件（文件名是固定的），用于修改 SpringBoot 自动配置的默认值，properties文件是创建完Springboot项目后自带的配置文件，如果想要替换成yml文件，在resources 目录下（与properties同目录下）创建application.yml 配置文件即可，当 properties 文件与 yml 文件中都有统一个配置时，生效的是properties文件中的配置。

本篇主要整理 yml 配置文件的语法。

一、YAML简介

YAML（YAML Ain’t Markup Language）
​ YAML A Markup Language：是一个标记语言
​ YAML isn’t Markup Language：不是一个标记语言；

标记语言：
​ YAML：以数据为中心，比json、xml等更适合做配置文件；
​ YAML：配置例子
与以前的xml文件相比，yml 配置文件的语法更简洁，省去了许多开始结束标签，但是 yml 配置文件对空格的要求比较严格，同一缩进下的内容认为是同一层级的属性，此外，配置值时冒号后面必须要加一个空格。

server:
  port: 8081

​ XML：

<server>
	<port>8081</port>
</server>

二、YAML语法：

1、基本语法

k:(空格)v：表示一对键值对（空格必须有）；

以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

server:
    port: 8081
    path: /hello

属性和值也是大小写敏感；

2、值的写法

（1）字面量：普通的值（数字，字符串，布尔）

​ k: v：字面直接来写；

​ 字符串默认不用加上单引号或者双引号；

​ “”：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思

​ name: “zhangsan \n lisi”：输出；zhangsan 换行 lisi

​ ‘’：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据

​ name: ‘zhangsan \n lisi’：输出；zhangsan \n lisi

（2）对象、Map（属性和值）（键值对）：

​ k: v：在下一行来写对象的属性和值的关系；注意缩进

​ 对象还是k: v的方式

friends:
		lastName: zhangsan
		age: 20

行内写法：

friends: {lastName: zhangsan,age: 18}

（3）集合（List、Set）：

用 - (空格) 值 ,表示数组中的一个元素

pets:
 - cat
 - dog
 - pig

行内写法

pets: [cat,dog,pig]

3、用yml配置文件为 javaBean 注入值

配置文件

person:
    lastName: hello
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {k1: v1,k2: 12}
    lists:
      - lisi
      - zhaoliu
    dog:
      name: 小狗
      age: 12

javaBean：

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中person下面的所有属性进行一一映射
 *
 *@Component： 将类扫描到容器中，只有这个组件是容器中的组件，才能用容器提供的@ConfigurationProperties功能；
 *
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

4、yml配置文件中进行配置时，没有自动提示的解决方法：

pom.xml 中添加依赖：配置文件处理器，以后编写 yml 配置文件就有提示了

<!--导入配置文件处理器，配置文件进行绑定就会有提示-->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-configuration-processor</artifactId>
			<optional>true</optional>
		</dependency>