yaml語法大全,讓你不再只是使用字串型別

2021-04-13 19:00:12

什麼是YAML

YAML是"YAML Ain’t a Markup Language"(YAML不是一種標示語言)的遞迴縮寫。YAML的意思其實是:「Yet Another Markup Language」(仍是一種標示語言)。主要強度這種語音是以資料為中心,而不是以標記語音為重心,例如像xml語言就會使用大量的標記。

YAML是一個可讀性高,易於理解,用來表達資料序列化的格式。它的語法和其他高階語言類似,並且可以簡單表達清單(陣列)、雜湊表,標量等資料形態。它使用空白符號縮排和大量依賴外觀的特色,特別適合用來表達或編輯資料結構、各種組態檔等。

YAML的組態檔字尾為 .yml,例如Springboot專案中使用到的組態檔 application.yml

基本語法

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

資料型別

  • 純量(scalars):單個的、不可再分的值
  • 物件:鍵值對的集合,又稱為對映(mapping)/ 雜湊(hashes) / 字典(dictionary)
  • 陣列:一組按次序排列的值,又稱為序列(sequence) / 列表(list)

標量

標量是最基礎的資料型別,不可再分的值,他們一般用於表示單個的變數,有以下七種:

  1. 字串
  2. 布林值
  3. 整數
  4. 浮點數
  5. Null
  6. 時間
  7. 日期
# 字串
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不能很好的解析複雜物件。

package com.nobody;

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

/**
 * @Description
 * @Author Mr.nobody
 * @Date 2021/4/13
 * @Version 1.0.0
 */
@Configuration
@ConfigurationProperties(prefix = "my.person")
@Getter
@Setter
public class Person {
    private String name;
    private int age;
    private boolean man;
}

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

person: {name: 陳皮, age: 18, man: true}

陣列

可以用短橫杆加空格 -開頭的行組成陣列的每一個元素,如下的address欄位:

person:
  name: 陳皮
  age: 18
  man: true
  address:
    - 深圳
    - 北京
    - 廣州

也可以使用中括號進行行內顯示形式,如下:

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

在程式碼中引入方式如下:

package com.nobody;

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;

/**
 * @Description
 * @Author Mr.nobody
 * @Date 2021/4/13
 * @Version 1.0.0
 */
@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
package com.nobody;

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
@ToString
public class Person {
    private String name;
    private int age;
    private boolean man;
    private List<String> address;
    private List<List<Integer>> twoArr;
}

如果陣列成員是一個物件,則用如下兩種形式形式:

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

文字塊

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

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

它和加雙引號的效果一樣,雙引號能跳脫特殊字元:

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

顯示指定型別

有時我們需要顯示指定某些值的型別,可以使用 !(感嘆號)顯式指定型別。!單歎號通常是自定義型別,!!雙歎號是內建型別,例如:

# 指定為字串
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:雜湊表型別

參照

參照會用到 &錨點符合和 *星號符號,&用來建立錨點,<< 表示合併到當前資料,* 用來參照錨點。

xiaohong: &xiaohong
  name: 小紅
  age: 20

dept:
  id: D15D8E4F6D68A4E88E
  <<: *xiaohong

上面最終相當於如下:

xiaohong:
  name: 小紅
  age: 20

dept:
  id: D15D8E4F6D68A4E88E
  name: 小紅
  age: 20

還有一種檔案內參照,參照已經定義好的變數,如下:

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

單檔案多設定

可以在同一個檔案中,實現多檔案分割區,即多設定。在一個yml檔案中,通過 — 分隔多個不同設定,根據spring.profiles.active 的值來決定啟用哪個設定

#公共設定
spring:
  profiles:
    active: pro # 指定使用哪個檔案塊
---
#開發環境設定
spring:
  profiles: dev # profiles屬性代表設定的名稱

server:
  port: 8080
---
#生產環境設定
spring:
  profiles: pro

server:
  port: 8081