一、简介

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' } }

三、数组

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

  1. - Cat
  2. - Dog
  3. - Goldfish

转为 JavaScript 如下。

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

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

  1. -
  2.  - Cat
  3.  - Dog
  4.  - Goldfish

转为 JavaScript 如下。

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

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

  1. animal: [Cat, Dog]

转为 JavaScript 如下。

  2. { animal: [ 'Cat', 'Dog' ] }

四、复合结构

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

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

转为 JavaScript 如下。

  1. { languages: [ 'Ruby', 'Perl', 'Python' ],
  2.   websites: 
  3.    { YAML: 'yaml.org',
  4.      Ruby: 'ruby-lang.org',
  5.      Python: 'python.org',
  6.      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 如下。

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

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

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

转为 JavaScript 如下。

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

六、字符串

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

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

  1. str: 这是一行字符串

转为 JavaScript 如下。

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

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

  1. str: '内容： 字符串'

转为 JavaScript 如下。

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

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

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

转为 JavaScript 如下。

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

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

  1. str: 'labor''s day'

转为 JavaScript 如下。

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

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

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

转为 JavaScript 如下。

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

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

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

转为 JavaScript 代码如下。

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

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

  1. s1: |
  2.   Foo
  4. s2: |+
  5.   Foo
  8. s3: |-
  9.   Foo

转为 JavaScript 代码如下。

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

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

  1. message: |
  3.   <p style="color: red">
  4.     段落
  5.   </p>

转为 JavaScript 如下。

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

七、引用

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

  1. defaults: &defaults
  2.   adapter:  postgres
  3.   host:     localhost
  5. development:
  6.   database: myapp_development
  7.   <<: *defaults
  9. test:
  10.   database: myapp_test
  11.   <<: *defaults

等同于下面的代码。

  2. defaults:
  3.   adapter:  postgres
  4.   host:     localhost
  6. development:
  7.   database: myapp_development
  8.   adapter:  postgres
  9.   host:     localhost
  11. test:
  12.   database: myapp_test
  13.   adapter:  postgres
  14.   host:     localhost

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

下面是另一个例子。

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

转为 JavaScript 代码如下。

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