YAML语言教程

编程免不了要写配置文件，怎么写配置也是一门学问。

YAML是专门用来写配置文件的语言，非常简洁和强大，远比JSON格式方便。

简介

YAML语言(发音/ˈjæməl/)的设计目标，就是方便人类读写。它实质上是一种能用的数据串行化格式。它的基本语法规则如下。

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

YAML支持的数据结构有三种

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

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

对象

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

animal: pets

转换为JavaScript 如下

{animal: 'pets'}

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

hash: {name: Steve, foo: bar}

转换为JavaScript如下

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

数组

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

- Cat
- Dog
- Goldfish

转换为javaScript如下。

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

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

-
 - Cat
 - Dog
 - Goldfish

转换JavaScript如下。

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

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

animal: [Cat, Dog]

转为JavaScrip如下

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

复合结构

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

languages:
 - Ruby
 - Perl
 - Python
websites:
 YAML: yaml.org
 Ruby: ruby-lang.org
 Python: python.org
 Perl: user.perl.org

转为JavaScript如下。

{
languages:['Ruby', 'Perl', 'Python']
websites:{
        YAML: 'yaml.org',
        Ruby: 'ruby-lang.org',
        Python: 'python.org',
        Perl: 'user.perl.org'
    }
}

纯量

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

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

数值

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

number: 12.30

转为JavaScript 如下

{number: 12.30}

布尔值

布尔值用true和false表示

isSet: true

转换为JavaScript如下。

{isSet: true}

null

null用~表示

parent: ~

时间

时间采用ISO8601格式

iso8601: 2001-12-14t21:59:43.1008:00

转换为JavaScript如下

{iso8601=Sat Dec 15 13:59:43 CST 2001}

日期

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

date: 1976-07-31

转为JavaScript如下

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

强制类型转换

集合的默认实现是

字符串

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

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

str: 这是一行字符串

转为JavaScript如下

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

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

str: '内容： 字符串'

转为JavaScript如下

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

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

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

转为JavaScript如下。

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

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

str: 'labor''s day'

转为JavaScript如下。

{str: 'labor\'s day'}

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

str: 这是一段
 多行
 字符串

转为JavaScript如下

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

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

this: |
    Foo
    Bar
that: >
    Foo
    Bar

转为JavaScript代码如下。

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

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

# |只会保留末尾的一个换行符
s1: |
    Foo

# |+有几个换行符保留几个换行符
s2: |+
    Foo

# |- 结尾一个不保留挑行符   
s3: |-
    Foo

转为JavaScript代码如下。

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

引用

&用来建立锚点(defaults), <<表示合并到当前数据, * 用来引用锚点。

- &showell Steve
- Clark
- Brian
- Oren
- *showell

转为JavaScript代码如下

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

另一个例子

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