YAML入門教程
簡介
YAML 是 "YAML Ain't a Markup Language"(YAML 不是一種標記語言)的遞迴縮寫。在開發的這種語言時,YAML 的意思其實是:"Yet Another Markup Language"(仍是一種標記語言)。
YAML 的語法和其他高階語言類似,並且可以簡單表達清單、散列表,標量等資料形態。它使用空白符號縮排和大量依賴外觀的特色,特別適合用來表達或編輯資料結構、各種配置檔案、傾印除錯內容、檔案大綱(例如:許多電子郵件標題格式和YAML非常接近
YAML 的配置檔案字尾為 .yml
,如:runoob.yml 。
YAML 是 json 的超集
基本語法
- 大小寫敏感
- 使用縮排表示層級關係
- 縮排不允許使用tab,只允許空格
- 縮排的空格數不重要,只要相同層級的元素左對齊即可
- '#'表示註釋
資料型別
YAML 支援以下幾種資料型別:
- 物件:鍵值對的集合,又稱為對映(mapping)/ 雜湊(hashes) / 字典(dictionary)
- 陣列:一組按次序排列的值,又稱為序列(sequence) / 列表(list)
- 純量(scalars):單個的、不可再分的值
YAML 物件
物件鍵值對使用冒號結構表示 key: value,冒號後面要加一個空格。
也可以使用 key:{key1: value1, key2: value2, ...}
還可以使用縮排表示層級關係;
key:
child-key: value
child-key2: value2
較為複雜的物件格式,可以使用問號加一個空格代表一個複雜的 key,配合一個冒號加一個空格代表一個 value:
?
- complexkey1
- complexkey2
:
- complexvalue1
- complexvalue2
意思即物件的屬性是一個數組 [complexkey1,complexkey2]
,對應的值也是一個數組 [complexvalue1,complexvalue2]
YAML 陣列
以 -
開頭的行表示構成一個數組:
- A
- B
- C
YAML 支援多維陣列,可以使用行內表示:
key: [value1, value2, ...]
資料結構的子成員是一個數組,則可以在該項下面縮排一個空格。
-
- A
- B
- C
一個相對複雜的例子:
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}]
複合結構
陣列和物件可以構成複合結構,例:
languages:
- Ruby
- Perl
- Python
websites:
YAML: yaml.org
Ruby: ruby-lang.org
Python: python.org
Perl: use.perl.org
轉換為 json 為:
{
languages: [ 'Ruby', 'Perl', 'Python'],
websites: {
YAML: 'yaml.org',
Ruby: 'ruby-lang.org',
Python: 'python.org',
Perl: 'use.perl.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連線,最後使用+代表時區
引用
&
錨點和 *
別名,可以用來引用:
defaults: &defaults
adapter: postgres
host: localhost
development:
database: myapp_development
<<: *defaults
test:
database: myapp_test
<<: *defaults
相當於:
defaults:
adapter: postgres
host: localhost
development:
database: myapp_development
adapter: postgres
host: localhost
test:
database: myapp_test
adapter: postgres
host: localhost
&
用來建立錨點(defaults),<<
表示合併到當前資料,*
用來引用錨點。
下面是另一個例子:
- &showell Steve
- Clark
- Brian
- Oren
- *showell
轉為 JavaScript 程式碼如下:
[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]
參考地址:阮一峰yaml語言 微信收藏 簡書yaml快速入門