YAML語法和用法

YAML是一個可讀性高，易於理解，用來表達數據序列化的格式。它的語法和其他高級語言類似，並且可以簡單表達清單（數組）、散列表，標量等數據形態。它使用空白符號縮進和大量依賴外觀的特色，特別適合用來表達或編輯數據結構、各種配置文件等。

YAML的配置文件后綴為 .yml，例如Springboot項目中使用到的配置文件 application.yml 。

 

數據類型

• 純量（scalars）：單個的、不可再分的值
• 對象：鍵值對的集合，又稱為映射（mapping）/ 哈希（hashes） / 字典（dictionary）
• 數組：一組按次序排列的值，又稱為序列（sequence） / 列表（list）

標量

標量是最基礎的數據類型，不可再分的值，他們一般用於表示單個的變量，有以下七種：

• 字符串
• 布爾值
• 整數
• 浮點數
• Null
• 時間
• 日期

# 字符串
string.value: Hello!
# 布爾值，true或false
boolean.value: true
boolean.value1: false
# 整數
int.value: 10
int.value1: 0b1010_0111_0100_1010_1110 # 二進制
# 浮點數
float.value: 3.14159
float.value1: 314159e-5 # 科學計數法
# Null，~代表null
null.value: ~
# 時間，時間使用ISO 8601格式，時間和日期之間使用T連接，最后使用+代表時區
datetime.value: !!timestamp 2021-10-20T10:31:00+08:00
# 日期,日期必須使用ISO 8601格式，即yyyy-MM-dd
date.value: !!timestamp 2021-04-13

對象

單個變量可以用鍵值對，使用冒號結構表示 key: value，注意冒號后面要加一個空格。可以使用縮進層級的鍵值對表示一個對象，如下所示：

person: #對象
  name: 老王
  age: 18
  man: true

數組

可以用短橫桿加空格 -開頭的行組成數組的每一個元素，如下的address字段：

person: #對象
  name: 老王
  age: 18
  man: true
  address: #數組
    - 深圳
    - 北京
    - 廣州

顯示指定類型

有時我們需要顯示指定某些值的類型，可以使用 !（感嘆號）顯式指定類型。!單嘆號通常是自定義類型，!!雙嘆號是內置類型，例如：

# 指定為字符串
string.value: !!str HelloWorld!
# !!timestamp指定為日期時間類型
datetime.value: !!timestamp 2021-10-20T02:31:00+08:00

內置的類型如下：

• !!int：整數類型
• !!float：浮點類型
• !!bool：布爾類型
• !!str：字符串類型
• !!binary：二進制類型
• !!timestamp：日期時間類型
• !!null：空值
• !!set：集合類型
• !!omap，!!pairs：鍵值列表或對象列表
• !!seq：序列
• !!map：散列表類型

 示例

person: #對象
  name: 老王
  age: 18
  man: true
  address: #數組
    - 深圳
    - 北京
    - 廣州
  twoArr: #數組字段的成員也是數組
    - - 1
      - 2
      - 3
    - - 11
      - 12
      - 13
  childs: #數組成員是對象
    - name: 小紅
      age: 10
    - name: 小王
      age: 15
  name2: | #文本塊
    Hello Java!!
    I am fine!
    Thanks! GoodBye!
  name3: "Hello Java!!\nI am fine!\nThanks! GoodBye!" #文本塊和加雙引號的效果一樣，雙引號能轉義特殊字符


person2: {name: 老王2, age: 18, man: true, address: [深圳, 北京, 廣州],twoArr:[[1,2,3],[11,12,13]],childs: [{name: 小紅, age: 10}, {name: 小王, age: 15}]}

#引用會用到 &錨點符合和 星號符號，&用來建立錨點，<< 表示合並到當前數據， 用來引用錨點。
xiaohong: &xiaohong
  name: 小紅
  age: 20
dept:
  id: D15D8E4F6D68A4E88E
  <<: *xiaohong
# 上面最終相當於如下：
xiaohong2:
  name: 小紅
  age: 20
dept2:
  id: D15D8E4F6D68A4E88E
  name: 小紅
  age: 20
#還有一種文件內引用，引用已經定義好的變量，如下：
base.host: https://www.cnblogs.com/ooo0
add.person.url: ${base.host}/p/15428552.html

 自定義配置類:

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

import java.util.List;

@Configuration
@ConfigurationProperties(prefix = "person")
@Getter
@Setter
public class PersonYaml {
    private String name;
    private int age;
    private boolean man;
    private List<String> address;
    private List<List<Integer>> twoArr;
    private List<Child> childs;
    private String name2;
    private String name3;

    @Getter
    @Setter
    @ToString
    public static class Child {
        private String name;
        private int age;
    }
}

@Slf4j
@Api(tags = "YamlController")
@RequestMapping("yaml")
@RestController
public class YamlController {

    @Value("${string.value}")
    private String stringValue;
    @Value("${boolean.value}")
    private boolean booleanValue;
    @Value("${boolean.value1}")
    private boolean booleanValue1;
    @Value("${int.value}")
    private int intValue;
    @Value("${int.value1}")
    private int intValue1;
    @Value("${float.value}")
    private float floatValue;
    @Value("${float.value1}")
    private float floatValue1;
    @Value("${null.value}")
    private String nullValue;
    @Value("${datetime.value}")
    private Date datetimeValue;
    @Value("${date.value}")
    private Date datevalue;

    @Autowired
    private PersonYaml personYaml;
    @Autowired
    private Person2Yaml person2Yaml;

    @Value("${xiaohong.name}")
    private String xiaohongName;
    @Value("${dept.name}")
    private String deptName;
    @Value("${xiaohong2.name}")
    private String xiaohong2Name;
    @Value("${dept2.name}")
    private String dept2Name;
    @Value("${add.person.url}")
    private String addPersonUrl;


    @GetMapping("/test")
    public void test(String test) {
        log.info("stringValue:" + stringValue);
        log.info("booleanValue:" + booleanValue);
        log.info("booleanValue1:" + booleanValue1);
        log.info("intValue:" + intValue);
        log.info("intValue1:" + intValue1);
        log.info("floatValue:" + floatValue);
        log.info("floatValue1:" + floatValue1);
        log.info("nullValue:" + nullValue);
        log.info("datetimeValue:" + datetimeValue);
        log.info("datevalue:" + datevalue);

        {
            String name = personYaml.getName();
            log.info("name:" + name);
            int age = personYaml.getAge();
            log.info("age:" + age);
            boolean man = personYaml.isMan();
            log.info("man:" + man);
            List<String> address = personYaml.getAddress();
            log.info("address:" + address);
            List<List<Integer>> twoArr = personYaml.getTwoArr();
            log.info("twoArr:" + twoArr);
            List<PersonYaml.Child> childs = personYaml.getChilds();
            log.info("childs:" + childs);
            String name2 = personYaml.getName2();
            log.info("name2:" + name2);
            String name3 = personYaml.getName3();
            log.info("name3:" + name3);
        }

        {
            String name = person2Yaml.getName();
            log.info("name:" + name);
            int age = person2Yaml.getAge();
            log.info("age:" + age);
            boolean man = person2Yaml.isMan();
            log.info("man:" + man);
            List<String> address = person2Yaml.getAddress();
            log.info("address:" + address);
            List<List<Integer>> twoArr = person2Yaml.getTwoArr();
            log.info("twoArr:" + twoArr);
            List<Person2Yaml.Child> childs = person2Yaml.getChilds();
            log.info("childs:" + childs);
            String name2 = person2Yaml.getName2();
            log.info("name2:" + name2);
            String name3 = person2Yaml.getName3();
            log.info("name3:" + name3);
        }

        log.info("xiaohongName:" + xiaohongName);
        log.info("deptName:" + deptName);
        log.info("xiaohong2Name:" + xiaohong2Name);
        log.info("dept2Name:" + dept2Name);
        log.info("addPersonUrl:" + addPersonUrl);

    }

}

附:

springboot 讀取配置文件

SpringBoot 獲取配置 @Value

Spring Boot 使用YAML配置