简介

YAML 是 “YAML Ain’t a Markup Language”（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：”Yet Another Markup Language”（仍是一种标记语言）。以数据为中心，比json、xml等更适合做配置文件。在Springboot中，推荐使用properties或者YAML文件来完成配置，但是对于较复杂的数据结构来说，YAML又远远优于properties。

语法

  1. 大小写敏感
  2. 使用缩进表示层级关系
  3. 缩进不允许使用制表符(Tab)，只允许空格（一般2个或4个空格）
  4. 缩进的空格数不重要，只要相同层级的元素左对齐即可
  5. 使用#作为注释，YAML中只有行注释

数据类型

对象

键值对的集合，又称为映射(mapping)/哈希(hash)/字典(dictionary)

  • 对象键值对使用冒号结构表示 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]

数组

一组按次序排列的值，又称为序列(sequence)/列表(list)

  • 以 - 开头的行表示构成一个数组： ```yaml
  • A
  • B

  • 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. }

纯量(scalars)

单个的、不可再分的值。包括：字符串、布尔值、整数、浮点数、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连接，最后使用+代表时区
    注意：字符串类型默认不需要加引号，如果加的话也可以，但有如下区别：
    “ “ ：双引号，不会转义字符串中的特殊字符，即特殊字符有效，如 /n 会实现换行等
    ‘ ‘ ：单引号，会转义字符串中的特殊字符，即特殊字符无效，最终会按普通字符显示

引用

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

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

相当于:

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

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

  • 下面是另一个例子： ```yaml
  • &showell Steve
  • Clark
  • Brian
  • Oren
  • *showell
    1. 转换为JavaScript代码如下：
    2. ```javascript
    3. [ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]