編程免不了要寫配置文件靠抑，YAML 是專門用來寫配置文件的語言奢驯，非常簡潔和強(qiáng)大黍檩，遠(yuǎn)比 JSON 格式方便叉袍。
本文介紹 YAML 的語法，以 JS-YAML 的實(shí)現(xiàn)為例刽酱。你可以去在線 Demo 驗(yàn)證下面的例子喳逛。
一、簡介
YAML 語言（發(fā)音 /?j?m?l/ ）的設(shè)計(jì)目標(biāo)棵里，就是方便人類讀寫润文。它實(shí)質(zhì)上是一種通用的數(shù)據(jù)串行化格式。
它的基本語法規(guī)則如下殿怜。
- 大小寫敏感
- 使用縮進(jìn)表示層級(jí)關(guān)系
- 縮進(jìn)時(shí)不允許使用Tab鍵典蝌，只允許使用空格。
- 縮進(jìn)的空格數(shù)目不重要头谜，只要相同層級(jí)的元素左側(cè)對(duì)齊即可
# 表示注釋骏掀，從這個(gè)字符一直到行尾，都會(huì)被解析器忽略柱告。
YAML 支持的數(shù)據(jù)結(jié)構(gòu)有三種截驮。
- 對(duì)象：鍵值對(duì)的集合，又稱為映射（mapping）/ 哈希（hashes） / 字典（dictionary）
- 數(shù)組：一組按次序排列的值际度，又稱為序列（sequence） / 列表（list）
- 純量（scalars）：單個(gè)的侧纯、不可再分的值
以下分別介紹這三種數(shù)據(jù)結(jié)構(gòu)。
二甲脏、對(duì)象
對(duì)象的一組鍵值對(duì)，使用冒號(hào)結(jié)構(gòu)表示妹笆。
animal: pets
轉(zhuǎn)為 JavaScript 如下块请。
{ animal: 'pets' }
Yaml 也允許另一種寫法，將所有鍵值對(duì)寫成一個(gè)行內(nèi)對(duì)象拳缠。
hash: { name: Steve, foo: bar }
轉(zhuǎn)為 JavaScript 如下墩新。
{ hash: { name: 'Steve', foo: 'bar' } }
三、數(shù)組
一組連詞線開頭的行窟坐，構(gòu)成一個(gè)數(shù)組海渊。
- Cat
- Dog
- Goldfish
轉(zhuǎn)為 JavaScript 如下。
[ 'Cat', 'Dog', 'Goldfish' ]
數(shù)據(jù)結(jié)構(gòu)的子成員是一個(gè)數(shù)組哲鸳，則可以在該項(xiàng)下面縮進(jìn)一個(gè)空格臣疑。
-
- Cat
- Dog
- Goldfish
轉(zhuǎn)為 JavaScript 如下。
[ [ 'Cat', 'Dog', 'Goldfish' ] ]
數(shù)組也可以采用行內(nèi)表示法徙菠。
animal: [Cat, Dog]
轉(zhuǎn)為 JavaScript 如下讯沈。
{ animal: [ 'Cat', 'Dog' ] }
四、復(fù)合結(jié)構(gòu)
對(duì)象和數(shù)組可以結(jié)合使用婿奔，形成復(fù)合結(jié)構(gòu)缺狠。
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ù)
- 浮點(diǎn)數(shù)
- Null
- 時(shí)間
- 日期
數(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 }
時(shí)間采用 ISO8601 格式练湿。
iso8601: 2001-12-14t21:59:43.10-05:00
轉(zhuǎn)為 JavaScript 如下猴仑。
{ iso8601: new Date('2001-12-14t21:59:43.10-05:00') }
日期采用復(fù)合 iso8601 格式的年、月肥哎、日表示辽俗。
date: 1976-07-31
轉(zhuǎn)為 JavaScript 如下。
{ date: new Date('1976-07-31') }
YAML 允許使用兩個(gè)感嘆號(hào)篡诽，強(qiáng)制轉(zhuǎn)換數(shù)據(jù)類型崖飘。
e: !!str 123
f: !!str true
轉(zhuǎn)為 JavaScript 如下。
{ e: '123', f: 'true' }
六杈女、字符串
字符串是最常見朱浴，也是最復(fù)雜的一種數(shù)據(jù)類型。
字符串默認(rèn)不使用引號(hào)表示达椰。
str: 這是一行字符串
轉(zhuǎn)為 JavaScript 如下翰蠢。
{ str: '這是一行字符串' }
如果字符串之中包含空格或特殊字符，需要放在引號(hào)之中啰劲。
str: '內(nèi)容： 字符串'
轉(zhuǎn)為 JavaScript 如下梁沧。
{ str: '內(nèi)容: 字符串' }
單引號(hào)和雙引號(hào)都可以使用，雙引號(hào)不會(huì)對(duì)特殊字符轉(zhuǎn)義蝇裤。
s1: '內(nèi)容\n字符串'
s2: "內(nèi)容\n字符串"
轉(zhuǎn)為 JavaScript 如下廷支。
{ s1: '內(nèi)容\\n字符串', s2: '內(nèi)容\n字符串' }
單引號(hào)之中如果還有單引號(hào)，必須連續(xù)使用兩個(gè)單引號(hào)轉(zhuǎn)義栓辜。
str: 'labor''s day'
轉(zhuǎn)為 JavaScript 如下恋拍。
{ str: 'labor\'s day' }
字符串可以寫成多行，從第二行開始啃憎，必須有一個(gè)單空格縮進(jìn)芝囤。換行符會(huì)被轉(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 標(biāo)記先壕。
message: |
<p style="color: red">
段落
</p>
轉(zhuǎn)為 JavaScript 如下瘩扼。
{ message: '\n<p style="color: red">\n 段落\n</p>\n' }
七、引用
錨點(diǎ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
&用來建立錨點(diǎn)（defaults）谆棺，<<表示合并到當(dāng)前數(shù)據(jù)栽燕，*用來引用錨點(diǎn)。
下面是另一個(gè)例子改淑。
- &showell Steve
- Clark
- Brian
- Oren
- *showell
轉(zhuǎn)為 JavaScript 代碼如下碍岔。
[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]
八、函數(shù)和正則表達(dá)式的轉(zhuǎn)換
這是 JS-YAML 庫特有的功能朵夏，可以把函數(shù)和正則表達(dá)式轉(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 對(duì)象還原到 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);
}
