YAML 檔案詳解

- 1、什麼是YAML
- 2、基本文法
- 3、資料類型
- 4、文本塊
- 5、顯示指定類型
- 6、引用
- 7、單檔案多配置

1、什麼是YAML

YAML是"YAML Ain’t a Markup Language"（YAML不是一種标記語言）的遞歸縮寫。YAML的意思其實是：“Yet Another Markup Language”（仍是一種标記語言）。主要強度這種語音是以資料為中心，而不是以标記語言為重心，例如像xml語言就會使用大量的标記。

YAML是一個可讀性高，易于了解，用來表達資料序列化的格式。它的文法和其他進階語言類似，并且可以簡單表達清單（數組）、散清單，标量等資料形态。它使用空白符号縮進和大量依賴外觀的特色，特别适合用來表達或編輯資料結構、各種配置檔案等。

YAML的配置檔案字尾為 .yml，例如Springboot項目中使用到的配置檔案 application.yml 。

2、基本文法

YAML使用可列印的Unicode字元，可使用UTF-8或UTF-16。
資料結構采用鍵值對的形式，即鍵名稱: 值，注意冒号後面要有空格。
每個清單（數組）成員以單行表示，并用短杠+空白（- ）起始。或使用方括号（[]），并用逗号+空白（, ）分開成員。
每個散清單的成員用冒号+空白（: ）分開鍵值和内容。或使用大括号（{ }），并用逗号+空白（, ）分開。
字元串值一般不使用引号，必要時可使用，使用雙引号表示字元串時，會轉義字元串中的特殊字元（例如\n）。使用單引号時不會轉義字元串中的特殊字元。
大小寫敏感
使用縮進表示層級關系，縮進不允許使用tab，隻允許空格，因為有可能在不同系統下tab長度不一樣
縮進的空格數可以任意，隻要相同層級的元素左對齊即可
在單一檔案中，可用連續三個連字号（—）區分多個檔案。還有選擇性的連續三個點号（…）用來表示檔案結尾。
'#'表示注釋，可以出現在一行中的任何位置，單行注釋
在使用逗号及冒号時，後面都必須接一個空白字元，是以可以在字元串或數值中自由加入分隔符号（例如：5,280或http://www.wikipedia.org）而不需要使用引号。

3、資料類型

純量（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-04-13T10:31:00+08:00
# 日期,日期必須使用ISO 8601格式，即yyyy-MM-dd
date.value: !!timestamp 2021-04-13

這樣，我們就可以在程式中引入了，如下：

@RestController
@RequestMapping("demo")
public class PropConfig {

    @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;
}

對象

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

person:
  name: 鋒聲
  age: 18
  man: true

然後在程式對這幾個屬性進行指派到Person對象中，注意Person類要加get/set方法，不然屬性會無法正确取到配置檔案的值。使用@ConfigurationProperties注入對象，@value不能很好的解析複雜對象。

@Configuration
@ConfigurationProperties(prefix = "person")
@Getter
@Setter
public class Person {
    private String name;
    private int age;
    private boolean man;
}

當然也可以使用 key:{key1: value1, key2: value2, …}的形式，如下：

數組

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

person:
  name: 鋒聲
  age: 18
  man: true
  address:
    - 深圳
    - 北京
    - 廣州

也可以使用中括号進行行内顯示形式，如下：

person:
  name: 鋒聲
  age: 18
  man: true
  address: [深圳, 北京, 廣州]

在代碼中引入方式如下：

@Configuration
@ConfigurationProperties(prefix = "person")
@Getter
@Setter
@ToString
public class Person {
    private String name;
    private int age;
    private boolean man;
    private List<String> address;
}

如果數組字段的成員也是一個數組，可以使用嵌套的形式，如下：

person:
  name: 鋒聲
  age: 18
  man: true
  address: [深圳, 北京, 廣州]
  twoArr:
    -
      - 2
      - 3
      - 1
    -
      - 10
      - 12
      - 30

@Configuration
@ConfigurationProperties(prefix = "person")
@Getter
@Setter
@ToString
public class Person {
    private String name;
    private int age;
    private boolean man;java
    private List<String> address;
    private List<List<Integer>> twoArr;
}

如果數組成員是一個對象，則用如下兩種形式形式：

childs:
  -
    name: 鋒聲
    age: 10
  -
    name: 鋒聲
    age: 15

childs: [{name: 小紅, age: 10}, {name: 小王, age: 15}]

4、文本塊

如果你想引入多行的文本塊，可以使用|符号，注意在冒号:和 |符号之間要有空格。

person:
  name: |
    Hello Java!!
    I am fine!
    Thanks! GoodBye!

它和加雙引号的效果一樣，雙引号能轉義特殊字元：

person:
  name: "Hello Java!!\nI am fine!\nThanks! GoodBye!"

5、顯示指定類型

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

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

内置的類型如下：

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

6、引用

引用會用到 &錨點符合和星号符号，&用來建立錨點，<< 表示合并到目前資料，用來引用錨點。

fengsheng: &fengsheng
  name: 鋒聲
  age: 20

dept:
  id: D15D8E4F6D68A4E88E
  <<: *fengsheng

上面最終相當于如下：

fengsheng:
  name: 鋒聲
  age: 20

dept:
  id: D15D8E4F6D68A4E88E
  name: 鋒聲
  age: 20

還有一種檔案内引用，引用已經定義好的變量，如下：

base.host: https://chenpi.com
add.person.url: ${base.host}/person/add

7、單檔案多配置

可以在同一個檔案中，實作多文檔分區，即多配置。在一個yml檔案中，通過 — 分隔多個不同配置，根據spring.profiles.active 的值來決定啟用哪個配置

#公共配置
spring:
  profiles:
    active: pro # 指定使用哪個文檔塊


#開發環境配置
spring:
  profiles: dev # profiles屬性代表配置的名稱
server:
  port: 8080


#生産環境配置
spring:
  profiles: pro
server:
  port: 8081

YAML 檔案詳解