YAML 是專門用來寫配置文件的語言，非常簡潔和強大，遠比 JSON 格式方便俊庇。
本文介紹 YAML 的語法狮暑，以 JS-YAML 的實現(xiàn)為例。你可以去在線 Demo 驗證下面的例子辉饱。
一搬男、簡介
YAML 語言（發(fā)音 /?j?m?l/ ）的設計目標，就是方便人類讀寫彭沼。它實質(zhì)上是一種通用的數(shù)據(jù)串行化格式缔逛。
它的基本語法規(guī)則如下。
- 大小寫敏感
- 使用縮進表示層級關系
- 縮進時不允許使用Tab鍵姓惑，只允許使用空格褐奴。
- 縮進的空格數(shù)目不重要，只要相同層級的元素左側(cè)對齊即可
# 表示注釋于毙，從這個字符一直到行尾敦冬，都會被解析器忽略。
YAML 支持的數(shù)據(jù)結(jié)構有三種唯沮。
- 對象：鍵值對的集合脖旱，又稱為映射（mapping）/ 哈希（hashes） / 字典（dictionary）
- 數(shù)組：一組按次序排列的值，又稱為序列（sequence） / 列表（list）
- 純量（scalars）：單個的介蛉、不可再分的值
以下分別介紹這三種數(shù)據(jù)結(jié)構萌庆。
二、對象
對象的一組鍵值對币旧，使用冒號結(jié)構表示践险。
animal: pets
轉(zhuǎn)為 JavaScript 如下。
{ animal: 'pets' }
Yaml 也允許另一種寫法吹菱，將所有鍵值對寫成一個行內(nèi)對象巍虫。
hash: { name: Steve, foo: bar }
轉(zhuǎn)為 JavaScript 如下
{ hash: { name: 'Steve', foo: 'bar' } }
三、數(shù)組
一組連詞線開頭的行毁葱，構成一個數(shù)組垫言。
- Cat
- Dog
- Goldfish
轉(zhuǎn)為 JavaScript 如下贰剥。
[ 'Cat', 'Dog', 'Goldfish' ]
數(shù)據(jù)結(jié)構的子成員是一個數(shù)組倾剿，則可以在該項下面縮進一個空格。
-
- Cat
- Dog
- Goldfish
轉(zhuǎn)為 JavaScript 如下蚌成。
[ [ 'Cat', 'Dog', 'Goldfish' ] ]
數(shù)組也可以采用行內(nèi)表示法前痘。
animal: [Cat, Dog]
轉(zhuǎn)為 JavaScript 如下。
{ animal: [ 'Cat', 'Dog' ] }
四担忧、復合結(jié)構
對象和數(shù)組可以結(jié)合使用芹缔，形成復合結(jié)構。
languages:
- Ruby
- Perl
- Python
websites:
YAML: yaml.org
Ruby: ruby-lang.org
Python: python.org
Perl: use.perl.org
轉(zhuǎn)為 JavaScript 如下瓶盛。
{ languages: [ 'Ruby', 'Perl', 'Python' ],
websites:
{ YAML: 'yaml.org',
Ruby: 'ruby-lang.org',
Python: 'python.org',
Perl: 'use.perl.org' } }
五最欠、純量
純量是最基本的示罗、不可再分的值。以下數(shù)據(jù)類型都屬于 JavaScript 的純量芝硬。
- 字符串
- 布爾值
- 整數(shù)
- 浮點數(shù)
- Null
- 時間
- 日期
數(shù)值直接以字面量的形式表示蚜点。
number: 12.30
轉(zhuǎn)為 JavaScript 如下。
{ number: 12.30 }
布爾值用true和false表示拌阴。
isSet: true
轉(zhuǎn)為 JavaScript 如下绍绘。
{ isSet: true }
null用~表示。
parent: ~
轉(zhuǎn)為 JavaScript 如下迟赃。
{ parent: null }
時間采用 ISO8601 格式陪拘。
iso8601: 2001-12-14t21:59:43.10-05:00
轉(zhuǎn)為 JavaScript 如下。
{ iso8601: new Date('2001-12-14t21:59:43.10-05:00') }
日期采用復合 iso8601 格式的年纤壁、月左刽、日表示。
date: 1976-07-31
轉(zhuǎn)為 JavaScript 如下酌媒。
{ date: new Date('1976-07-31') }
YAML 允許使用兩個感嘆號悠反，強制轉(zhuǎn)換數(shù)據(jù)類型。
e: !!str 123
f: !!str true
轉(zhuǎn)為 JavaScript 如下馍佑。
{ e: '123', f: 'true' }
六斋否、字符串
字符串是最常見，也是最復雜的一種數(shù)據(jù)類型拭荤。
字符串默認不使用引號表示茵臭。
str: 這是一行字符串
轉(zhuǎn)為 JavaScript 如下。
{ str: '這是一行字符串' }
如果字符串之中包含空格或特殊字符舅世，需要放在引號之中旦委。
str: '內(nèi)容： 字符串'
轉(zhuǎn)為 JavaScript 如下。
{ str: '內(nèi)容: 字符串' }
單引號和雙引號都可以使用雏亚，雙引號不會對特殊字符轉(zhuǎn)義缨硝。
s1: '內(nèi)容\n字符串'
s2: "內(nèi)容\n字符串"
轉(zhuǎn)為 JavaScript 如下。
{ s1: '內(nèi)容\\n字符串', s2: '內(nèi)容\n字符串' }
單引號之中如果還有單引號罢低，必須連續(xù)使用兩個單引號轉(zhuǎn)義查辩。
str: 'labor''s day'
轉(zhuǎn)為 JavaScript 如下。
{ str: 'labor\'s day' }
字符串可以寫成多行网持，從第二行開始宜岛，必須有一個單空格縮進。換行符會被轉(zhuǎn)為空格功舀。
str: 這是一段
多行
字符串
轉(zhuǎn)為 JavaScript 如下萍倡。
{ str: '這是一段 多行 字符串' }
多行字符串可以使用|保留換行符，也可以使用>折疊換行辟汰。
this: |
Foo
Bar
that: >
Foo
Bar
轉(zhuǎn)為 JavaScript 代碼如下列敲。
{ this: 'Foo\nBar\n', that: 'Foo Bar\n' }
+表示保留文字塊末尾的換行阱佛，-表示刪除字符串末尾的換行。
s1: |
Foo
s2: |+
Foo
s3: |-
Foo
轉(zhuǎn)為 JavaScript 代碼如下戴而。
{ s1: 'Foo\n', s2: 'Foo\n\n\n', s3: 'Foo' }
字符串之中可以插入 HTML 標記岸梨。
message: |
<p style="color: red">
段落
</p>
轉(zhuǎn)為 JavaScript 如下重付。
{ message: '\n<p style="color: red">\n 段落\n</p>\n' }
七堪澎、引用
錨點&和別名*炼吴，可以用來引用。
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）壮莹，<<表示合并到當前數(shù)據(jù)，*用來引用錨點姻檀。
下面是另一個例子命满。
- &showell Steve
- Clark
- Brian
- Oren
- *showell
轉(zhuǎn)為 JavaScript 代碼如下。
[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]
八绣版、函數(shù)和正則表達式的轉(zhuǎn)換
這是 JS-YAML 庫特有的功能胶台，可以把函數(shù)和正則表達式轉(zhuǎn)為字符串。
# example.yml
fn: function () { return 1 }
reg: /test/
解析上面的 yml 文件的代碼如下杂抽。
var yaml = require('js-yaml');
var fs = require('fs');
try {
var doc = yaml.load(
fs.readFileSync('./example.yml', 'utf8')
);
console.log(doc);
} catch (e) {
console.log(e);
}
從 JavaScript 對象還原到 yaml 文件的代碼如下诈唬。
var yaml = require('js-yaml');
var fs = require('fs');
var obj = {
fn: function () { return 1 },
reg: /test/
};
try {
fs.writeFileSync(
'./example.yml',
yaml.dump(obj),
'utf8'
);
} catch (e) {
console.log(e);
}
九、參考鏈接
（完）
文章轉(zhuǎn)自:http://www.ruanyifeng.com/blog/2016/07/yaml.html?f=tt
注意點:
yaml文件是
不能識別TAB制表符的缩麸，所以記得 不要怕麻煩铸磅，多敲幾次空格。yaml文件的鍵值對中的值前面要有一個空格
