YAML 语言教程

一、简介

YAML 语言（发音 /ˈjæməl/ ）的设计目标，就是方便人类读写。它实质上是一种通用的数据串行化格式。

它的基本语法规则如下。

  • 大小写敏感
  • 使用缩进表示层级关系
  • 缩进时不允许使用Tab键，只允许使用空格。
  • 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可

#表示注释，从这个字符一直到行尾，都会被解析器忽略。

YAML 支持的数据结构有三种。

  • 对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
  • 数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
  • 纯量（scalars）：单个的、不可再分的值

以下分别介绍这三种数据结构。

二、对象

对象的一组键值对，使用冒号结构表示。

1
animal: pets

转为 JavaScript 如下。

1
{ animal: 'pets' }

Yaml 也允许另一种写法，将所有键值对写成一个行内对象。

1
hash: { name: Steve, foo: bar }

转为 JavaScript 如下。

1
{ hash: { name: 'Steve', foo: 'bar' } }

较为复杂的对象格式，可以使用问号加一个空格代表一个复杂的key，配合一个冒号加一个空格代表一个值（value）。

1
2
3
4
5
6
?  
    - complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2

表示对象的属性是一个数组[complexkey1,complexkey2]，对应的值也是一个数组[complexvalue1,complexvalue2]

三、数组

一组连词线开头的行，构成一个数组。

1
2
3
4
animal:
 - Cat
 - Dog
 - Goldfish

转为 JavaScript 如下。

1
{animal:[ 'Cat', 'Dog', 'Goldfish' ]}

数据结构的子成员是一个数组，则可以在该项下面缩进一个空格。

1
2
3
4
-
 - Cat
 - Dog
 - Goldfish

转为 JavaScript 如下。

1
[ [ 'Cat', 'Dog', 'Goldfish' ] ]

数组也可以采用行内表示法。

1
animal: [Cat, Dog]

转为 JavaScript 如下。

1
{ animal: [ 'Cat', 'Dog' ] }

一个相对复杂的例子：

1
2
3
4
5
6
7
8
9
companies:
 -
  id: 1
  name: company1
  price: 200W
 -
  id: 2
  name: company2
  price: 500W

表示是companies属性是一个数组，每一个数组元素又是由id,name,price三个属性构成；

四、复合结构

对象和数组可以结合使用，形成复合结构。

1
2
3
4
5
6
7
8
9
languages:
 - Ruby
 - Perl
 - Python 
websites:
 YAML: yaml.org 
 Ruby: ruby-lang.org 
 Python: python.org 
 Perl: use.perl.org

转为 JavaScript 如下。

1
2
3
4
5
6
{ languages: [ 'Ruby', 'Perl', 'Python' ],
  websites: 
   { YAML: 'yaml.org',
     Ruby: 'ruby-lang.org',
     Python: 'python.org',
     Perl: 'use.perl.org' } }

五、纯量

纯量是最基本的、不可再分的值。以下数据类型都属于 JavaScript 的纯量。

  • 字符串
  • 布尔值
  • 整数
  • 浮点数
  • Null
  • 时间
  • 日期

数值直接以字面量的形式表示。

1
number: 12.30

转为 JavaScript 如下。

1
{ number: 12.30 }

布尔值用true和false表示。

1
isSet: true

转为 JavaScript 如下。

1
{ isSet: true }

null用~表示。

1
parent: ~

转为 JavaScript 如下。

1
{ parent: null }

时间采用 ISO8601 格式。

1
iso8601: 2001-12-14t21:59:43.10-05:00

转为 JavaScript 如下。

1
{ iso8601: new Date('2001-12-14t21:59:43.10-05:00') }

日期采用复合 iso8601 格式的年、月、日表示。

1
date: 1976-07-31

转为 JavaScript 如下。

{ date: new Date('1976-07-31') }

时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区

1
datetime: 2018-07-17T19:02:31+08:00

YAML 允许使用两个感叹号，强制转换数据类型。

1
2
e: !!str 123
f: !!str true

转为 JavaScript 如下。

1
{ e: '123', f: 'true' }

六、字符串

字符串是最常见，也是最复杂的一种数据类型。

字符串默认不使用引号表示。

1
str: 这是一行字符串

转为 JavaScript 如下。

1
{ str: '这是一行字符串' }

如果字符串之中包含空格或特殊字符，需要放在引号之中。

1
str: '内容： 字符串'

转为 JavaScript 如下。

1
{ str: '内容: 字符串' }

单引号和双引号都可以使用，双引号不会对特殊字符转义。

1
2
s1: '内容\n字符串'
s2: "内容\n字符串"

转为 JavaScript 如下。

1
{ s1: '内容\\n字符串', s2: '内容\n字符串' }

单引号之中如果还有单引号，必须连续使用两个单引号转义。

1
str: 'labor''s day'

转为 JavaScript 如下。

1
{ str: 'labor\'s day' }

字符串可以写成多行，从第二行开始，必须有一个单空格缩进。换行符会被转为空格。

1
2
3
str: 这是一段
  多行
  字符串

转为 JavaScript 如下。

1
{ str: '这是一段 多行 字符串' }

多行字符串可以使用|保留换行符，也可以使用>折叠换行。

1
2
3
4
5
6
this: |
  Foo
  Bar
that: >
  Foo
  Bar

转为 JavaScript 代码如下。

1
{ this: 'Foo\nBar\n', that: 'Foo Bar\n' }

+表示保留文字块末尾的换行，-表示删除字符串末尾的换行。

1
2
3
4
5
s1: |
  Foo

s2: |+
  Foo
1
2
s3: |-
  Foo

转为 JavaScript 代码如下。

1
{ s1: 'Foo\n', s2: 'Foo\n\n\n', s3: 'Foo' }

字符串之中可以插入 HTML 标记。

1
2
3
4
5
message: |

  <p style="color: red">
    段落
  </p>

转为 JavaScript 如下。

1
{ message: '\n<p style="color: red">\n  段落\n</p>\n' }

七、引用

锚点&和别名*，可以用来引用。

1
2
3
4
5
6
7
8
9
10
11
defaults: &defaults
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  <<: *defaults

test:
  database: myapp_test
  <<: *defaults

等同于下面的代码。

1
2
3
4
5
6
7
8
9
10
11
12
13
defaults:
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  adapter:  postgres
  host:     localhost

test:
  database: myapp_test
  adapter:  postgres
  host:     localhost

&用来建立锚点（defaults），<<表示合并到当前数据，*用来引用锚点。

下面是另一个例子。

1
2
3
4
5
- &showell Steve 
- Clark 
- Brian 
- Oren 
- *showell

转为 JavaScript 代码如下。

1
[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]

八、函数和正则表达式的转换

这是 JS-YAML 库特有的功能，可以把函数和正则表达式转为字符串。

1
2
3
# example.yml
fn: function () { return 1 }
reg: /test/

解析上面的 yml 文件的代码如下。

1
2
3
4
5
6
7
8
9
10
11
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 文件的代码如下。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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);
}

九、一些特殊符号

YAML中提供了很多特殊符号，在这里简单介绍常用的一些：
第1种，--- YAML可以在同一个文件中，使用—-表示一个文档的开始；比如Springboot中profile的定义：

1
2
3
4
5
6
7
8
9
10
11
12
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；也常常使用---来分割不同的内容，比如记录日志：

1
2
3
4
5
6
7
8
9
10
---
Time: 2018-07-17T15:02:31+08:00
User: ed
Warning:
     This is an error message for the log file
---
Time: 2018-07-17T15:05:21+08:00
User: ed
Warning:
    A slightly different error message.

第2种，... 和---配合使用，在一个配置文件中代表一个文件的结束：

1
2
3
4
5
6
7
8
9
10
---
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
---
time: 20:03:47
player: Sammy Sosa
action: grand slam
...

相当于在一个yaml文件中连续写了两个yaml配置项。

第3种，!! YAML中使用!!做类型强行转换：

1
2
3
string:
    - !!str 54321
    - !!str true

相当于把数字和布尔类型强转为字符串。当然允许转型的类型很多，比如：

1
2
3
4
5
--- !!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中字符串经常使用的符号，比如：

1
2
3
4
5
6
accomplishment: >
 Mark set a major league
 home run record in 1998.
stats: |
 65 Home Runs
 0.278 Batting Average

那么结果是：

1
2
stats=65 Home Runs
 0.278 Batting Average,

即| 符号保留了换行符，而accomplishment的结果为：

1
accomplishment=Mark set a major league home run record in 1998.

即将换行符转化成了空格；要注意一点的是，每行的文本前一定要有一个空格。
|符号常见用于在YAML中配置HTML片段：

1
2
3
4
phraseTemplate: |
  <p style="color: red">
    some template ${msg}
  </p>

第5种，引用。重复的内容在YAML中可以使用&来完成锚点定义，使用*来完成锚点引用，例如：

1
2
3
4
5
6
hr:
- Mark McGwire
- &SS Sammy Sosa
rbi:
- *SS 
- Ken Griffey

可以看到，在hr中，使用&SS为Sammy Sosa设置了一个锚点（引用），名称为SS，在rbi中，使用*SS完成了锚点使用，那么结果为：

1
{rbi=[Sammy Sosa, Ken Griffey], hr=[Mark McGwire, Sammy Sosa]}

也可以这样定义：

1
2
3
4
5
6
7
SS: &SS Sammy Sosa
hr:
 - Mark McGwire
 - *SS
rbi:
 - *SS 
 - Ken Griffey

第6种，合并内容。主要和锚点配合使用，可以将一个锚点内容直接合并到一个对象中。来看一个示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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}

有了合并，就可以在配置中把相同的基础配置抽取出来，在不同的子配置中合并引用即可。