YAML教程

YAML是「YAML Is not markup language」的縮寫形式,是一種數據序列化語言,設計爲人性化的,並且適用於其他編程語言的日常任務。本教程詳細介紹了一些重要的神經語言編程技巧。

面向讀者

本教程的目標讀者包括使用JSON和XML文件進行配置設置的Web開發人員。 任何打算以人類可讀的結構化數據格式編寫標記的程序員也可以學習YAML。

前提條件

本教程的先決條件包括HTML,XML和JSON的基本知識。 YAML專門針對常見用例(如配置文件,日誌文件和跨語言共享文件以及數據共享)而設計。

問題反饋

我們不能保證您在學習此Yaml教程的過程中不會遇到任何問題。本教程中的講解,示例和代碼等只是根據作者的理解來概括寫出。由於作者水平和能力有限,因此不保正所有編寫的文章都準確無誤。但是如果有遇到任何錯誤或問題,請反饋給我們,我們會及時糾正以方便後續讀者閱讀。

快速入門

下面展示YAML最基本,最常用的一些使用格式:
首先YAML中允許表示三種格式,分別是常量值,對象和數組
例如:

#即表示url屬性值;
url: http://www.yiibai.com
#即表示server.host屬性的值;
server:
    host: http://www.yiibai.com
#數組,即表示server爲[a,b,c]
server:
    - 120.168.0.21
    - 120.168.0.22
    - 120.168.0.23
#常量
pi: 3.14   #定義一個數值3.14
hasChild: true  #定義一個boolean值
name: '你好YAML'   #定義一個字符串

註釋

properties文件格式相同,使用#作爲註釋開始,YAML中只有行註釋。

基本格式要求 -

  1. YAML大小寫敏感;
  2. 使用縮進代表層級關係;
  3. 縮進只能使用空格,不能使用TAB,不要求空格個數,只需要相同層級左對齊(一般2個或4個空格)

對象

使用冒號代表,格式爲key: value。冒號後面要加一個空格:

key: value

可以使用縮進表示層級關係;

key: 
    child-key: value
    child-key2: value2

YAML中還支持流式(flow)語法表示對象,比如上面例子可以寫爲:

key: {child-key: value, child-key2: value2}

較爲複雜的對象格式,可以使用問號加一個空格代表一個複雜的key,配合一個冒號加一個空格代表一個值(value)。

?  
    - complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2

表示對象的屬性是一個數組[complexkey1,complexkey2],對應的值也是一個數組[complexvalue1,complexvalue2]

數組

使用一個短橫線加一個空格代表一個數組項:

hobby:
    - Java
    - LOL

當然也可以有這樣的寫法:

-
    - Java
    - LOL

可以簡單理解爲:[[Java,LOL]]
一個相對複雜的例子:

companies:
    -
        id: 1
        name: company1
        price: 200W
    -
        id: 2
        name: company2
        price: 500W

表示是companies屬性是一個數組,每一個數組元素又是由id,name,price三個屬性構成;
數組也可以使用流式(flow)的方式表示:

常量

YAML中提供了多種常量結構,包括:整數,浮點數,字符串,NULL,日期,布爾,時間。下面使用一個例子來快速瞭解常量的基本使用:

boolean: 
    - TRUE  #true,True都可以
    - FALSE  #false,False都可以
float:
    - 3.14
    - 6.8523015e+5  #可以使用科學計數法
int:
    - 123
    - 0b1010_0111_0100_1010_1110    #二進制表示
null:
    nodeName: 'node'
    parent: ~  #使用~表示null
string:
    - 哈哈
    - 'Hello world'  #可以使用雙引號或者單引號包裹特殊字符
    - newline
      newline2    #字符串可以拆成多行,每一行會被轉化成一個空格
date:
    - 2018-07-17    #日期必須使用ISO 8601格式,即yyyy-MM-dd
datetime: 
    -  2018-07-17T19:02:31+08:00    #時間使用ISO 8601格式,時間和日期之間使用T連接,最後使用+代表時區

一些特殊符號

YAML中提供了很多特殊符號,在這裏簡單介紹常用的一些:
第1種--- YAML可以在同一個文件中,使用—-表示一個文檔的開始;比如Springboot中profile的定義:

server:
    address: 192.168.1.100
---
spring:
    profiles: development
    server:
        address: 127.0.0.1
---
spring:
    profiles: production
    server:
        address: 192.168.1.120

代表定義了兩個profile,一個是development,一個production;也常常使用---來分割不同的內容,比如記錄日誌:

---
Time: 2018-07-17T15:02:31+08:00
User: ed
Warning:
     This is an error message for the log file
---
Time: 2018-07-17T15:05:21+08:00
User: ed
Warning:
    A slightly different error message.

第2種...---配合使用,在一個配置文件中代表一個文件的結束:

---
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
---
time: 20:03:47
player: Sammy Sosa
action: grand slam
...

相當於在一個yaml文件中連續寫了兩個yaml配置項。

第3種!! YAML中使用!!做類型強行轉換:

string:
    - !!str 54321
    - !!str true

相當於把數字和布爾類型強轉爲字符串。當然允許轉型的類型很多,比如:

--- !!set
- Mark McGwire: 65
- Sammy Sosa: 63
- Sammy Sosa: 63
- Ken Griffy: 58

將數組解析爲set,簡單理解,轉化的內容就是:[{Ken Griffy=58}, {Mark McGwire=65}, {Sammy Sosa=63}],重複的Sammy Sosa去掉;

第4種>在字符串中摺疊換行,| 保留換行符,這兩個符號是YAML中字符串經常使用的符號,比如:

accomplishment: >
 Mark set a major league
 home run record in 1998.
stats: |
 65 Home Runs
 0.278 Batting Average

那麼結果是:

stats=65 Home Runs
 0.278 Batting Average,

| 符號保留了換行符,而accomplishment的結果爲:

accomplishment=Mark set a major league home run record in 1998.

即將換行符轉化成了空格;要注意一點的是,每行的文本前一定要有一個空格。
|符號常見用於在YAML中配置HTML片段:

phraseTemplate: |
  <p style="color: red">
    some template ${msg}
  </p>

第5種,引用。重複的內容在YAML中可以使用&來完成錨點定義,使用*來完成錨點引用,例如:

hr:
- Mark McGwire
- &SS Sammy Sosa
rbi:
- *SS 
- Ken Griffey

可以看到,在hr中,使用&SS爲Sammy Sosa設置了一個錨點(引用),名稱爲SS,在rbi中,使用*SS完成了錨點使用,那麼結果爲:

{rbi=[Sammy Sosa, Ken Griffey], hr=[Mark McGwire, Sammy Sosa]}

也可以這樣定義:

SS: &SS Sammy Sosa
hr:
 - Mark McGwire
 - *SS
rbi:
 - *SS 
 - Ken Griffey

第6種,合併內容。主要和錨點配合使用,可以將一個錨點內容直接合併到一個對象中。來看一個示例:

merge:
  - &CENTER { x: 1, y: 2 }
  - &LEFT { x: 0, y: 2 }
  - &BIG { r: 10 }
  - &SMALL { r: 1 }

sample1: 
    <<: *CENTER
    r: 10

sample2:
    << : [ *CENTER, *BIG ]
    other: haha

sample3:
    << : [ *CENTER, *BIG ]
    r: 100

在merge中,定義了四個錨點,分別在sample中使用。
sample1中,<<: *CENTER意思是引用{x: 1,y: 2},並且合併到sample1中,那麼合併的結果爲:sample1={r=10, y=2, x=1}

sample2中,<<: [*CENTER, *BIG] 意思是聯合引用{x: 1,y: 2}{r: 10},並且合併到sample2中,那麼合併的結果爲:sample2={other=haha, x=1, y=2, r=10}

sample3中,引入了*CENTER, *BIG,還使用了r: 100覆蓋了引入的r: 10,所以sample3值爲:sample3={r=100, y=2, x=1}

有了合併,就可以在配置中把相同的基礎配置抽取出來,在不同的子配置中合併引用即可。