YAML快速入門

docker -compose中使用yaml格式的配置文件，因此準備學習一下這方面的知識，正好網上有一篇寫的不錯，直接抄了過來，原文鏈接：

https://www.jianshu.com/p/97222440cd08

YAML快速入門

下面馬上展現YAML最基本，最經常使用的一些使用格式：
首先YAML中容許表示三種格式，分別是常量值，對象和數組
例如：

#即表示url屬性值；
url: http://www.wolfcode.cn 
#即表示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: |
  <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

注意，不能獨立的定義錨點，好比不能直接這樣寫： &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測試經過

做者：叩丁狼教育 連接：https://www.jianshu.com/p/97222440cd08 來源：簡書 簡書著做權歸做者全部，任何形式的轉載都請聯繫做者得到受權並註明出處。