YAML 是 “YAML Ain’t a Markup Language”（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：”Yet Another Markup Language”（仍是一种标记语言）。

YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。

YAML 的配置文件后缀为 .yml，如：runoob.yml 。

基本语法

  • 大小写敏感
  • 使用缩进表示层级关系
  • 缩进不允许使用tab，只允许空格
  • 缩进的空格数不重要，只要相同层级的元素左对齐即可
  • ‘#’表示注释

数据类型

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

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

YAML 对象

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

也可以使用 key:{key1: value1, key2: value2, …}。

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

  1. key: 
  2.     child-key: value
  3.     child-key2: value2

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

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

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

YAML 数组

以 - 开头的行表示构成一个数组：

  1. - A
  2. - B
  3. - C

YAML 支持多维数组，可以使用行内表示：

  1. key: [value1, value2, ...]

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

  1. -
  2.  - A
  3.  - B
  4.  - C

一个相对复杂的例子：

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

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

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

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

复合结构

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

  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

转换为 json 为：

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

纯量

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

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

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

  1. boolean: 
  2.     - TRUE  #true,True都可以
  3.     - FALSE  #false，False都可以
  4. float:
  5.     - 3.14
  6.     - 6.8523015e+5  #可以使用科学计数法
  7. int:
  8.     - 123
  9.     - 0b1010_0111_0100_1010_1110    #二进制表示
  10. null:
  11.     nodeName: 'node'
  12.     parent: ~  #使用~表示null
  13. string:
  14.     - 哈哈
  15.     - 'Hello world'  #可以使用双引号或者单引号包裹特殊字符
  16.     - newline
  17.       newline2    #字符串可以拆成多行，每一行会被转化成一个空格
  18. date:
  19.     - 2018-02-17    #日期必须使用ISO 8601格式，即yyyy-MM-dd
  20. datetime: 
  21.     -  2018-02-17T15:02:31+08:00    #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区

引用

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

  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

相当于:

  1. defaults:
  2.   adapter:  postgres
  3.   host:     localhost
  5. development:
  6.   database: myapp_development
  7.   adapter:  postgres
  8.   host:     localhost
  10. test:
  11.   database: myapp_test
  12.   adapter:  postgres
  13.   host:     localhost

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

下面是另一个例子:

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

转为 JavaScript 代码如下:

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

参考地址：