1. 简介

YAML 是 YAML Ain't a Markup Language（YAML 不是一种标记语言）的递归缩写。是一个可读性高，用来表达数据序列的格式。YAML 的配置文件后缀为 .yml。

YAML是一个类似 XML、JSON 的数据序列化语言，YAML是专门用来写配置文件的语言，非常简洁和强大，使用比 json更方便。它实质上是一种通用的数据串行化格式。其强调以数据为中心，旨在方便人类使用。并且适用于日常常见任务的现代编程语言。因而 YAML 本身的定义比较简单，号称“一种人性化的数据格式语言”。

yaml 和 json 互相转换工具：

2. 基本语法

  • 大小写敏感。
  • 使用缩进表示层级关系。
  • 缩进不允许使用 Tab键，只允许空格。
  • 缩进空格数目不重要，只要相同层级的元素左侧对齐。
  • #表示注释。
  • 字符串默认不用加单引号和双引号，双引号不会转义里面的特殊字符，单引号会转义里面的字符。
  • 字符后缩进一个空格，如冒号，逗号，短横杆（-)等
  • ---表示 一个文件或文档的开始，用于分隔文件或文档，(只有一个文档时可不写)
  • ...表示一个文档的结束(如果有 ---表示一个新文档的开始，则 ...可省略，规范写法需要 ...)
  • |+表示保留每行尾部的换行符 \n的同时，保留内容结尾处的换行符 \n。|+其实等同于 |
  • |-表示保留每行尾部的换行符 \n的同时，删除内容结尾处的换行符 \n。

3. 数据类型

YAML 支持以下几种数据类型：

  • 对象：键值对的集合，又称为映射（mapping）/ 哈希（hash） / 字典（dictionary）
  • 数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
  • 纯量：单个的、不可再分的值，字符串、布尔值、整数、浮点数、Null、时间、日期

参考：

3.1 对象

对象键值对使用冒号结构表示 key: value，冒号后面要加一个空格。

name: wohu
gender: male

也可以使用 key:{key1: value1, key2: value2, ...}，了解即可，不推荐这种写法。

person: {name: wohu, gender: male}

还可以使用缩进表示层级关系

person:
 name: wohu
 gender: male

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

?  
    - complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2

意思即对象的属性是一个数组 [complexkey1,complexkey2]，对应的值也是一个数组 [complexvalue1,complexvalue2]。

3.2 数组

以 - 开头的行表示构成一个数组，并且 - 后有一个空格, 或者将所有元素用 [ ] 括起来放在同一行

- A
- B
- C

支持多维数组，可以使用行内表示，了解即可，不推荐这种写法。

key: [value1, value2, ...]

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

-
 - A
 - B
 - C

一个相对复杂的例子：

companies:
    -
        id: 1
        name: company1
        price: 200W
    -
        id: 2
        name: company2
        price: 500W

意思是 companies 属性是一个数组，每一个数组元素又是由 id、name、price 三个属性构成。

数组也可以使用流式(flow)的方式表示：

companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]

3.3 复合结构

数组和对象可以构成复合结构，例：

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

转换为 json 为：

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

3.4 纯量

纯量是最基本的，不可再分的值，包括：

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

使用一个例子来快速了解纯量的基本使用：

boolean: 
    - TRUE  #true,True都可以
    - FALSE  #false，False都可以
float:
    - 3.14
    - 6.8523015e+5  #可以使用科学计数法
int:
    - 123
    - 0b1010_0111_0100_1010_1110    #二进制表示
null:
    nodeName: 'node'
    parent: ~  #使用~表示null
    parent1: Null  
    parent2: null  
    parent3:  
string:
    - 哈哈					# 默认不使用引号表示
    - 'Hello world'  # 可以使用双引号或者单引号包裹特殊字符
    - 'labor’‘s day' # 单引号之中如果还有单引号，必须连续使用两个单引号转义
    - newline  # 字符串可以写成多行，从第二行开始，必须有一个单空格缩进，换行符会被转为空格
      newline2    #字符串可以拆成多行，每一行会被转化成一个空格
date:
    - 2018-02-17    #日期必须使用ISO 8601格式，即yyyy-MM-dd
datetime: 
    -  2018-02-17T15:02:31+08:00    #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区

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

this: |
 Foo
 Bar
that: >
 Foo
 Bar

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

s1: |
 Foo

s2: |+
 Foo

s3: |-
 Foo

3.5 引用

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

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

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

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

转为 json如下：

[
  "Steve",
  "Clark",
  "Brian",
  "Oren",
  "Steve"
]

4. 元素换行

  • |，保留每行尾部的换行符 \n
  • >，删除每行尾部的换行符 \n，则看似多行文本，则在程序中会将其视为一行
# 实例16：
Client: |
  - A
  - B
# 保存内容：{"Client": "- A\n- B"}

# 实例：
Client: >
  - A
  - B
# 保存内容：{"Client": "- A - B"}
  • |+，保留每行尾部的换行符 \n的同时，保留内容结尾处的换行符 \n。
  • |-，保留每行尾部的换行符 \n 的同时，删除内容结尾处的换行符 \n。
s1: |
  Foo
 
s2: |+
  Foo
 
s3: |-
  Foo

转换为 json内容为：

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