YAML

Nov 28, 2016


本文来自:阮一峰:YAML 语言教程

简介

YAML 是专门用来写配置文件的语言,非常简洁和强大,远比 JSON 格式方便。
YAML 语言(发音 /ˈjæməl/ )的设计目标,就是方便人类读写。它实质上是一种通用的数据串行化格式。

它的基本语法规则如下:

大小写敏感
使用缩进表示层级关系
缩进时不允许使用Tab键,只允许使用空格
缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
# 表示注释,从这个字符一直到行尾,都会被解析器忽略

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

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

对象

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

Yaml: 
animal: pets

JavaScript: 
{ animal: 'pets' }

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

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

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

数组

一组连词线开头的行,构成一个数组:

Yaml:

- Cat
- Dog
- Goldfish

JavaScript:

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

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

Yaml:

-
 - Cat
 - Dog
 - Goldfish

JavaScript:

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

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

Yaml:
animal: [Cat, Dog]

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

复合结构

对象和数组可以结合使用,形成复合结构:

Yaml:

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

JavaScript:

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

纯量

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

布尔值

布尔值用true和false表示

数值

分为整数和浮点数

Null

null用 ~ 表示:

parent: ~ 

时间

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

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

日期

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

Yaml:
date: 1976-07-31

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

字符串

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

Yaml:
str: 这是一行字符串

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

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

Yaml:
str: '内容: 字符串'

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

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

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

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

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

Yaml:
str: 'labor''s day' 

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

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

Yaml:

str: 这是一段
  多行
  字符串

JavaScript:

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

多行字符串可以使用“|”保留换行符,也可以使用>折叠换行:

Yaml:

this: |
  Foo
  Bar
that: >
  Foo
  Bar

JavaScript:

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

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

Yaml:

s1: |
  Foo

s2: |+
  Foo


s3: |-
  Foo

JavaScript:

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

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

Yaml:

message: |

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

JavaScript:

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

强制类型转换

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

Yaml:
e: !!str 123
f: !!str true

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

引用

锚点&和别名,可以用来引用
&用来建立锚点,<< 表示合并到当前数据,
用来引用锚点:

Yaml:

defaults: &defaults
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  <<: *defaults

test:
  database: myapp_test
  <<: *defaults


JavaScript:

defaults:
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  adapter:  postgres
  host:     localhost

test:
  database: myapp_test
  adapter:  postgres
  host:     localhost

下面是另一个例子:

Yaml:

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

JavaScript:

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