YAML檔案格式入門
YAML快速入門
https://www.jianshu.com/p/97222440cd08
https://yaml.org/spec/1.2/spec.pdf
http://nodeca.github.io/js-yaml/
我們學習Java，都是先介紹properties檔案，使用properties檔案配合Properties物件能夠很方便的適用於應用配置上。然後在引入XML的時候，我們介紹properties格式在表現層級關係和結構關係的時候，十分欠缺，而XML在資料格式描述和較複雜資料內容展示方面，更加優秀。到後面介紹JSON格式的時候，我們發現JSON格式比較XML格式，更加方便（除去資料格式限制之外），所以現在很多配置檔案（比如Nginx和大部分指令碼語言的配置檔案）都習慣使用JSON的方式來完成，包括Springboot的出現目的也是在一定程度上去掉XML的繁瑣配置。
在Springboot中，推薦使用properties或者YAML檔案來完成配置，但是對於較複雜的資料結構來說，YAML又遠遠優於properties。本文就快速介紹YAML的常見語法格式。
先來看一個Springboot中的properties檔案和對應YAML檔案的對比：
properties(示例來源於Springboot User guide):
environments.dev.url=http://dev.bar.com
environments.dev.name=Developer Setup
environments.prod.url=http://foo.bar.com
environments.prod.name=My Cool App
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com
可以明顯的看到，在處理層級關係的時候，properties需要使用大量的路徑來描述層級（或者屬性），比如environments.dev.url和environments.dev.name。其次，對於較為複雜的結構，比如陣列（my.servers），寫起來更為複雜。而對應的YAML格式檔案就簡單很多：
YAML格式
environments:
dev:
url: http://dev.bar.com
name: Developer Setup
prod:
url: http://foo.bar.com
name: My Cool App
my:
servers:
- dev.bar.com
- foo.bar.com
可以直觀的看到，YAML使用冒號加縮排的方式代表層級（屬性）關係，使用短橫槓(-)代表陣列元素。
經過這個示例的演示，可以很明顯的看到YAML針對properties檔案的優異之處。
快速入門
下面立刻展示YAML最基本，最常用的一些使用格式：
首先YAML中允許表示三種格式，分別是常量值，物件和陣列
例如：
即表示url屬性值；
即表示server.host屬性的值；
server:
host: http://www.wolfcode.cn
陣列，即表示server為[a,b,c]
server:
- 120.168.117.21
- 120.168.117.22
- 120.168.117.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)的方式表示：
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]
常量
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-02-17 #日期必須使用ISO 8601格式，即yyyy-MM-dd
datetime:
- 2018-02-17T15: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-02-17T15:02:31+08:00
User: ed
Warning:
This is an error message for the log file
---
Time: 2018-02-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: |
some template ${msg}
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
注意，不能獨立的定義錨點，比如不能直接這樣寫： &SS Sammy Sosa；另外，錨點能夠定義更復雜的內容，比如：
default: &default
- Mark McGwire
- Sammy Sosa
hr: *default
那麼hr相當於引用了default的陣列，注意，hr: *default要寫在同一行。
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}
有了合併，我們就可以在配置中，把相同的基礎配置抽取出來，在不同的子配置中合併引用即可。
以上示例均通過Snakeyaml測試通過
瞭解更多
如果要了解更多關於YAML的詳情，可以瞭解（本文參考）：
1，YAML1.2規範：http://yaml.org/spec/1.2/spec.pdf
2，JS-YAML線上示例：http://nodeca.github.io/js-yaml/