Yaml map和list配置的使用详解

YAML 语言（发音 /ˈjæməl/ ）的设计目标，就是方便人类读写。它实质上是一种通用的数据串行化格式。它的基本语法规则如下

• 大小写敏感
• 使用缩进表示层级关系
• 缩进时不允许使用Tab键，只允许使用空格。
• 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
• # 表示注释，从这个字符一直到行尾，都会被解析器忽略。

YAML 支持的数据结构有三种。本篇将会介绍三种数据结构在Spring Boot中的的使用

• 对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
• 数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
• 纯量（scalars）：单个的、不可再分的值

 首先我们使用单个的不可再分的值和单独的List类型和Map类型的值作为例子，如下为Java对象的代码：

@Configuration
@ConfigurationProperties(prefix = "microservice.baseyaml")
public class BaseYamlConfig {
    private String strVaule;
    private int intValue;
    private float floatValue;
    private boolean booleanValue;
    private List<String> listStrValue;
    private Map<String, String> mapStrValue;
    //getter setter方法省略
}

我们需要在application.yaml对上面的Java对象的属性进行配置，示例如下所示：

microservice:
  baseyaml:
    strVaule: strVaule
    intValue: 10
    floatValue: 8.5
    booleanValue: false
    listStrValue:
      -a
      -b
      -c
      -d
    mapStrValue:
      name: pharos
      age: 25

通过上面的配置可知，一般的单个的值是使用field:value的形式配置的，而List类型的值则是使用多个-value进行配置的，而Map类型的值，则是使用field:key:value进行配置的，可以配置多个key:value。上面的配置是最简单也是最基本的yaml配置，下面我们了解复杂的配置，也就是说，配置中为对象类型，或者List，Map中存储对象，如下为Java代码：

@Configuration
@ConfigurationProperties(prefix = "microservice.objectyaml")
public class ObjectYamlConfig {
    private ConfigPojo configPojo;
    private List<ConfigPojo> list;
    private Map<String,ConfigPojo> map;
    //getter settter方法省略
}
public class ConfigPojo {
    private String strVaule;
    private int intValue;
    private float floatValue;
    private boolean booleanValue;
    private List<String> listStrValue;
    private Map<String, String> mapStrValue;
    //getter settter方法省略
}

然后如下为上面代码的yaml配置，其实配置较为简单，规则就是List使用-分隔，Map则使用key:value类型，配置如下所示：

microservice:
  objectyaml:
    configPojo:
      strVaule: strVaule
      intValue: 10
      floatValue: 8.5
      booleanValue: false
      listStrValue:
        -a
        -b
        -c
        -d
      mapStrValue:
        name: pharos
        age: 25
    list:
      -
       strVaule: strVaule
       intValue: 10
       floatValue: 8.5
       booleanValue: false
       listStrValue:
        -a
        -b
        -c
        -d
       mapStrValue:
        name: pharos
        age: 25
      -
       strVaule: strVaule
       intValue: 10
       floatValue: 8.5
       booleanValue: false
       listStrValue:
        -a
        -b
        -c
        -d
       mapStrValue:
        name: pharos
        age: 25
    map:
      a:
       strVaule: strVaule
       intValue: 10
       floatValue: 8.5
       booleanValue: false
       listStrValue:
        -a
        -b
        -c
        -d
       mapStrValue:
        name: pharos
        age: 25
      b:
       strVaule: strVaule
       intValue: 10
       floatValue: 8.5
       booleanValue: false
       listStrValue:
        -a
        -b
        -c
        -d
       mapStrValue:
        name: pharos
        age: 25
      

相对而言，yaml配置比application.properties配置更为清晰，能够看出配置的字段属于什么类型，在Spring Boot中复杂的配置比较少，但是在Spring Cloud中有很多符合对象类型配置。了解yaml配置的使用有助于理解SpringBoot或者Spring Cloud中配置的解析。