YAML語法介紹
一、為什麼學習它?
在資料格式描述和較複雜資料內容展示方面的配置檔案,JSON能夠很好的支援,包括語法突出顯示、自動格式化、驗證工具等。然而缺乏註釋,過於嚴格,長字串轉換會出現問題等等。對於運維人員,面對較複雜的資料結構來說,不得不尋找一個替代的方式。
YAML(YAML 不是標記語言)是一種非常靈活的格式,幾乎是 JSON 的超集,已經被用在一些著名的專案中,如 Travis CI、Circle CI 和 AWS CloudFormation。YAML 的庫幾乎和 JSON 一樣無處不在。除了支援註釋、換行符分隔、多行字串、裸字串和更靈活的型別系統之外,YAML 也支援引用檔案,以避免重複程式碼。
二、簡介
YAML 語言(發音 /ˈjæməl/ )的設計目標,就是方便人類讀寫。它實質上是一種通用的資料序列化格式。
YAML 有一個小的怪癖。所有的 YAML 檔案開始行都應該是 ---。這是 YAML 格式的一部分, 表明一個檔案的開始。
它的基本語法規則如下。
- 大小寫敏感
- 使用縮排表示層級關係
- 縮排時不允許使用Tab鍵,只允許使用空格。
- 縮排的空格數目不重要,只要相同層級的元素左側對齊即可
- #表示註釋,從這個字元一直到行尾,都會被解析器忽略。
YAML 支援的資料結構有三種。
物件:鍵值對的集合,又稱為對映(mapping)/ 雜湊(hashes) / 字典(dictionary)
陣列:一組按次序排列的值,又稱為序列(sequence) / 列表(list)
純量(scalars):單個的、不可再分的值
下面對這三種資料結構做詳細介紹:
三、物件
使用冒號代表,格式為key: value。冒號後面要加一個空格:
---
#即表示url屬性值;
url: https://www.liuluanyi.cn
轉為 JavaScript 如下:
{ url: 'https://www.liuluanyi.cn'}
Yaml 也允許另一種寫法,將所有鍵值對寫成一個行內物件。
---
host: { ip: 10.1.1.1, port: 2222 }
轉為 JavaScript 如下:
{ host: { ip: '10.1.1.1', port: 2222 } }
四、陣列
列表中的所有成員都開始於相同的縮排級別, 並且使用一個---
---
ipaddr:
# IP地址列表
- 120.168.117.21
- 120.168.117.22
- 120.168.117.23
轉為 JavaScript 如下:
ipaddr: [ '120.168.117.21', '120.168.117.22', '120.168.117.23' ]
資料結構的子成員是一個數組,則可以在該項下面縮排一個空格。
-
- source
- destination
- services
轉為 JavaScript 如下:
[ [ 'source', 'destination', 'services' ] ]
陣列也可以採用行內(或者流式)表示法。
services: [FTP, SSH]
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]
轉為 JavaScript 如下:
{ services: [ 'FTP', 'SSH' ] }
{ companies:
[ { id: 1, name: 'company1', price: '200W' },
{ id: 2, name: 'company2', price: '500W' } ] }
物件和陣列複合使用
languages:
- Ruby
- Perl
- Python
websites:
YAML: yaml.org
Ruby: ruby-lang.org
Python: python.org
轉為 JavaScript 如下:
{ languages: [ 'Ruby', 'Perl', 'Python' ],
websites: { YAML: 'yaml.org', Ruby: 'ruby-lang.org', Python: 'python.org' } }
常量
- 字串
- 布林值
- 整數
- 浮點數
- 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連線,最後使用+代表時區
轉為 JavaScript 如下:
{ boolean: [ true, false ],
float: [ 3.14, 685230.15 ],
int: [ 123, 685230 ],
null: { nodeName: 'node', parent: null },
string: [ '哈哈', 'Hello world', 'newline newline2' ],
date: [ Sat Feb 17 2018 08:00:00 GMT+0800 (中國標準時間) ],
datetime: [ Sat Feb 17 2018 15:02:31 GMT+0800 (中國標準時間) ] }
特殊符號
1、YAML 允許使用兩個感嘆號,強制轉換資料型別。
e: !!str 123
f: !!str true
轉為 JavaScript 如下:
{ e: '123', f: 'true' }
2、 … 和---配合使用,在一個配置檔案中代表一個檔案的結束:
---
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
---
time: 20:03:47
player: Sammy Sosa
action: grand slam
...
3、>
在字串中摺疊換行,|
保留換行符,這兩個符號是YAML中字串經常使用的符號,比如:
this: |
Foo
Bar
that: >
Foo
Bar
轉為 JavaScript 如下:
{ this: 'Foo\nBar\n', that: 'Foo Bar\n' }
4、引用。重複的內容在YAML中可以使用&來完成錨點定義,使用*來完成錨點引用,例如:
defaults: &defaults
adapter: postgres
host: localhost
development:
database: myapp_development
<<: *defaults
test:
database: myapp_test
<<: *defaults
轉為 JavaScript 如下:
{ defaults: { adapter: 'postgres', host: 'localhost' },
development:
{ database: 'myapp_development',
adapter: 'postgres',
host: 'localhost' },
test:
{ database: 'myapp_test',
adapter: 'postgres',
host: 'localhost' } }
注意,不能獨立的定義錨點,比如不能直接這樣寫: &SS Sammy Sosa;另外,錨點能夠定義更復雜的內容,比如:
default: &default
- Mark McGwire
- Sammy Sosa
hr: *default
那麼hr相當於引用了default的陣列,注意,hr: *default要寫在同一行。
來源:https://zhuanlan.zhihu.com/p/75067291
人最大的問題是總是帶著成見去看待人和事!