YAML 语言格式

1. 认识 YAML

　　YAML(Yet Another Markup Language)语言（发音 /ˈjæməl/ ）是一个类似 XML、JSON 的标记性语言。YAML 强调以数据为中心，并不是以标识语言为重点。因而 YAML 本身的定义比较简单，号称“一种人性化的数据格式语言”。目的就是方便人类读写。它实质上是一种通用的数据串行化格式。

1.1 YAML 的设计目标：

• 人类容易阅读

• 可用于不同程序间的数据交换

• 适合描述程序所使用的数据结构，特别是脚本语言

• 丰富的表达能力与可扩展性

• 易于使用

1.2 YAML 与 XML、JSON

• YAML 与 XML

  • 具有 XML 同样的优点，但比 XML 更加轻量、简单、敏捷等

• YAML 与 JSON

  • JSON 可以看作是 YAML 的子集，也就是说 JSON 能够做的事情，YAML 也能够做

  • YAML 能表示得比 JSON 更加简单和阅读，例如“字符串不需要引号”。所以 YAML 容易可以写成 JSON 的格式，但并不建议这种做

  • YAML 能够描述比 JSON 更加复杂的结构，例如“关系锚点”可以表示数据引用（如重复数据的引用）。

1.3 YAML 组织结构

　　YAML 文件可以由一或多个文档组成（也即相对独立的组织结构组成），文档间使用“---”（三个横线）在每文档开始作为分隔符。同时，文档也可以使用“...”（三个点号）作为结束符（可选）。

<br/>

• 如果只是单个文档，分隔符“---”可省略。

• 每个文档并不需要使用结束符“...”来表示结束，但是对于网络传输或者流来说，作为明确结束的符号，有利于软件处理。（例如不需要知道流关闭就能知道文档结束） <br/>

　　YAML 认为数据由以下三种结构组成：（每个文档由三种结构混合组成）

• 标量 （相当于数据类型）

• 序列 （相当于数组和列表）

• 键值表（相当于 Map 表）

2. YAML 编写规范

• 规范一：文档使用 Unicode 编码作为字符标准编码，例如 UTF-8

• 规范二：使用“#”来表示注释内容

  1.  
     # 客户订单
  2.  
     date: 2018-06-024
  3.  
     customer:
  4.  
     - name: Jai
  5.  
     items:
  6.  
     - no: 1234 # 订单号
  7.  
     - descript: cpu
  8.  
      

• 规范三：使用空格作为嵌套缩进工具。通常建议使用两个空格缩进，不建议使用 tab （甚至不支持）

• 规范四：序列表示

  • 使用“-”（横线） + 单个空格表示单个列表项
    1.  
       --- # 文档开始
    2.  
       - 第一章 简介
    3.  
       - 第二章 设计目录
    4.  
        
  • 使用"[]"表示一组数据
    1.  
       --- # 文档开始
    2.  
       [blue, red, green]
    3.  
        
  • 组合表示。每个结构都可以嵌套组成复杂的表示结构。
    1.  
       --- # 文档开始
    2.  
       - [blue, red, green] # 列表项本身也是一个列表
    3.  
       - [Age, Bag]
    4.  
       - site: {osc:www.oschina.net, baidu: www.baidu.com} # 这里是同 键值表 组合表示

• 规范五：键值表

  • 使用 “:”（冒号） + 空格表示单个键值对
    1.  
       # 客户订单
    2.  
       date: 2015-02-01
    3.  
       customer:
    4.  
       - name: Jai
    5.  
       items:
    6.  
       - no: 1234 # 订单号
    7.  
       - descript: cpu
    8.  
       - price: ￥800.00
    9.  
        
  • 使用"{}"表示一个键值表
    1.  
       # 客户订单
    2.  
       date: 2015-02-01
    3.  
       customer:
    4.  
       - name: Jai
    5.  
       items: {no: 1234, descript: cpu, price: ￥800.00}
    6.  
        
  • "? " 问号+空格表示复杂的键。当键是一个列表或键值表时，就需要使用本符号来标记。
    1.  
       # 使用一个列表作为键
    2.  
       ? [blue, reg, green]: Color
    3.  
       # 等价于
    4.  
       ? - blue
    5.  
       - reg
    6.  
       - gree
    7.  
       : Color
    8.  
        

  • 组合表示。每个结构都可以嵌套组成复杂的表示结构。

    1.  
       Color:
    2.  
       - blue
    3.  
       - red
    4.  
       - green
    5.  
        
    6.  
       # 相当于 (也是 JSON 的表示)
    7.  
       {Color: [blue, red, green]}
    8.  
        
    9.  
       div:
    10.  
        - border: {color: red, width: 2px}
    11.  
        - background: {color: green}
    12.  
        - padding: [0, 10px, 0, 10px]
    13.  
         
    14.  
        # 使用缩进表示的键值表与列表项
    15.  
        items:
    16.  
        - item: cpu
    17.  
        model: i3
    18.  
        price: ￥800.00
    19.  
        - item: HD
    20.  
        model: WD
    21.  
        price: ￥450.00
    22.  
         
    23.  
        # 上面使用 “-” 前导与缩进来表示多个列表项，相当于下面的JSON表示
    24.  
        items: [{item:cpu, model:i3, price:￥800.00}, {item:HD, model:WD, price: ￥450.00}]
    25.  
         

• 规范六：文本块

  • 使用 “|” 和文本内容缩进表示的块：保留块中已有的回车换行。相当于段落块

    1.  
       yaml: | # 注意 ":" 与 "|" 之间的空格
    2.  
       JSON的语法其实是YAML的子集，大部分的JSON文件都可以被YAML的解释器解释。
    3.  
       如果你想更深入的学习YAML，我建议你去 http://www.yaml.org 看看
    4.  
        

  • 使用 “>” 和文本内容缩进表示的块：将块中回车替换为空格，最终连接成一行。

    1.  
       yaml: > # 注意 ":" 与 ">" 之间的空格，另外可以使用空行来分段落
    2.  
       JSON的语法其实是YAML的子集，
    3.  
       大部分的JSON文件都可以被YAML的解释器解释。
    4.  
        
    5.  
       如果你想更深入的学习YAML，我建议你去 http://www.yaml.org 看看
    6.  
        

  • 使用定界符“”（双引号）、‘’（单引号）或回车表示的块：最终表示成一行。

    1.  
       yaml: # 使用回车的多行，最终连接成一行。
    2.  
       JSON的语法其实是YAML的子集，
    3.  
       大部分的JSON文件都可以被YAML的解释器解释。
    4.  
        
    5.  
       yaml: # 使用了双引号，双引号的好处是可以转义，即在里面可以使用特殊符号
    6.  
       "JSON的语法其实是YAML的子集，
    7.  
       大部分的JSON文件都可以被YAML的解释器解释。"
    8.  
        

• 规范七：数据类型的约定

  • 对一些常用数据类型的表示格式进行了约定，包括:

    1.  
       integer: 12345 # 整数标准形式
    2.  
       octal: 0o34 # 八进制表示，第二个是字母 o
    3.  
       hex: 0xFF # 十六进制表示
    4.  
        
    5.  
       float: 1.23e+3 # 浮点数
    6.  
       fixed: 13.67 # 固定小数
    7.  
       minmin: -.inf # 表示负无穷
    8.  
       notNumber: .NaN # 无效数字
    9.  
        
    10.  
        null: # 空值
    11.  
        boolean: [true, false] # 布尔值
    12.  
        string: '12345' # 字符串
    13.  
         
    14.  
        date: 2015-08-23 # 日期
    15.  
        datetime: 2015-08-23T02:02:00.1z # 日期时间
    16.  
        iso8601: 2015-08-23t21:59:43.10-05:00 # iso8601 日期格式
    17.  
        spaced: 2015-08-23 21:59:43.10 -5 # ?
    18.  
         

  • “!”（叹号）显式指示类型，或自定义类型标识。单叹号通常是自定义类型，双叹号是内置类型

    1.  
       isString: !!str 2015-08-23 # 强调是字符串不是日期数据
    2.  
       picture: !!binary | # Base64 图片
    3.  
       R0lGODlhDAAMAIQAAP//9/X
    4.  
       17unp5WZmZgAAAOfn515eXv
    5.  
       Pz7Y6OjuDg4J+fn5OTk6enp
    6.  
       56enmleECcgggoBADs=
    7.  
       #下面是内置类型
    8.  
       !!int # 整数类型
    9.  
       !!float # 浮点类型
    10.  
        !!bool # 布尔类型
    11.  
        !!str # 字符串类型
    12.  
        !!binary # 也是字符串类型
    13.  
        !!timestamp # 日期时间类型
    14.  
        !!null # 空值
    15.  
        !!set # 集合
    16.  
        !!omap, !!pairs # 键值列表或对象列表
    17.  
        !!seq # 序列，也是列表
    18.  
        !!map # 键值表
    19.  
         
    20.  
        #下面是一些例子：
    21.  
        --- !!omap
    22.  
        - Mark: 65
    23.  
        - Sammy: 63
    24.  
        - Key: 58
    25.  
         
    26.  
        --- !!set # 注意，“?”表示键为列表，在这里列表为 null
    27.  
        ? Mark
    28.  
        ? Sammy
    29.  
        ? Key
    30.  
         
    31.  
        # 下面是自定义的类型或标识
    32.  
        %TAG ! tag:clarkevans.com,2002: # % 是指令符号
    33.  
        --- !shape
    34.  
        # Use the ! handle for presenting
    35.  
        # tag:clarkevans.com,2002:circle
    36.  
        - !circle
    37.  
        center: &ORIGIN {x: 73, y: 129}
    38.  
        radius: 7
    39.  
        - !line
    40.  
        start: *ORIGIN
    41.  
        finish: { x: 89, y: 102 }
    42.  
        - !label
    43.  
        start: *ORIGIN
    44.  
        color: 0xFFEEBB
    45.  
        text: Pretty vector drawing.
    46.  
         

• 规范八：锚点与引用，定义数据的复用。

  • 第一步：使用 “&” 定义数据锚点（即要复制的数据）
  • 第二步：使用 “*” 引用上述锚点数据（即数据的复制目的地）
    1.  
       ---
    2.  
       hr:
    3.  
       - Mark McGwire
    4.  
       # Following node labeled SS
    5.  
       - &SS Sammy Sosa # 定义要复制的数据
    6.  
       rbi:
    7.  
       - *SS # Subsequent occurrence 这里是数据复制目标
    8.  
       - Ken Griffey
    9.  
        

1. 认识 YAML

YAML 语言（发音 /ˈjæməl/ ）的设计目标，强调以数据为中心，并不是以标识语言为重点。因而 YAML 本身的定义比较简单，号称“一种人性化的数据格式语言”。就是方便人类读写。它实质上是一种通用的数据串行化格式。

1.1 YAML 的设计目标：

• 人类容易阅读

• 可用于不同程序间的数据交换

• 适合描述程序所使用的数据结构，特别是脚本语言

• 丰富的表达能力与可扩展性

• 易于使用

1.2 YAML 与 XML、JSON

• YAML 与 XML

  • 具有 XML 同样的优点，但比 XML 更加简单、敏捷等

• YAML 与 JSON

  • JSON 可以看作是 YAML 的子集，也就是说 JSON 能够做的事情，YAML 也能够做

  • YAML 能表示得比 JSON 更加简单和阅读，例如“字符串不需要引号”。所以 YAML 容易可以写成 JSON 的格式，但并不建议这种做

  • YAML 能够描述比 JSON 更加复杂的结构，例如“关系锚点”可以表示数据引用（如重复数据的引用）。

1.3 YAML 组织结构

　　YAML 文件可以由一或多个文档组成（也即相对独立的组织结构组成），文档间使用“---”（三个横线）在每文档开始作为分隔符。同时，文档也可以使用“...”（三个点号）作为结束符（可选）。如下图所示：

<br/>

• 如果只是单个文档，分隔符“---”可省略。

• 每个文档并不需要使用结束符“...”来表示结束，但是对于网络传输或者流来说，作为明确结束的符号，有利于软件处理。（例如不需要知道流关闭就能知道文档结束） <br/>

　　YAML 认为数据由以下三种结构组成：（每个文档由三种结构混合组成）

• 标量 （相当于数据类型）

• 序列 （相当于数组和列表）

• 键值表（相当于 Map 表）

2. YAML 编写规范

• 规范一：文档使用 Unicode 编码作为字符标准编码，例如 UTF-8

• 规范二：使用“#”来表示注释内容

  1.  
     # 客户订单
  2.  
     date: 2015-02-01
  3.  
     customer:
  4.  
     - name: Jai
  5.  
     items:
  6.  
     - no: 1234 # 订单号
  7.  
     - descript: cpu
  8.  
      

• 规范三：使用空格作为嵌套缩进工具。通常建议使用两个空格缩进，不建议使用 tab （甚至不支持）

• 规范四：序列表示

  • 使用“-”（横线） + 单个空格表示单个列表项
    1.  
       --- # 文档开始
    2.  
       - 第一章 简介
    3.  
       - 第二章 设计目录
    4.  
        
  • 使用"[]"表示一组数据
    1.  
       --- # 文档开始
    2.  
       [blue, red, green]
    3.  
        
  • 组合表示。每个结构都可以嵌套组成复杂的表示结构。
    1.  
       --- # 文档开始
    2.  
       - [blue, red, green] # 列表项本身也是一个列表
    3.  
       - [Age, Bag]
    4.  
       - site: {osc:www.oschina.net, baidu: www.baidu.com} # 这里是同 键值表 组合表示

• 规范五：键值表

  • 使用 “:”（冒号） + 空格表示单个键值对
    1.  
       # 客户订单
    2.  
       date: 2015-02-01
    3.  
       customer:
    4.  
       - name: Jai
    5.  
       items:
    6.  
       - no: 1234 # 订单号
    7.  
       - descript: cpu
    8.  
       - price: ￥800.00
    9.  
        
  • 使用"{}"表示一个键值表
    1.  
       # 客户订单
    2.  
       date: 2015-02-01
    3.  
       customer:
    4.  
       - name: Jai
    5.  
       items: {no: 1234, descript: cpu, price: ￥800.00}
    6.  
        
  • "? " 问号+空格表示复杂的键。当键是一个列表或键值表时，就需要使用本符号来标记。
    1.  
       # 使用一个列表作为键
    2.  
       ? [blue, reg, green]: Color
    3.  
       # 等价于
    4.  
       ? - blue
    5.  
       - reg
    6.  
       - gree
    7.  
       : Color
    8.  
        

  • 组合表示。每个结构都可以嵌套组成复杂的表示结构。

    1.  
       Color:
    2.  
       - blue
    3.  
       - red
    4.  
       - green
    5.  
        
    6.  
       # 相当于 (也是 JSON 的表示)
    7.  
       {Color: [blue, red, green]}
    8.  
        
    9.  
       div:
    10.  
        - border: {color: red, width: 2px}
    11.  
        - background: {color: green}
    12.  
        - padding: [0, 10px, 0, 10px]
    13.  
         
    14.  
        # 使用缩进表示的键值表与列表项
    15.  
        items:
    16.  
        - item: cpu
    17.  
        model: i3
    18.  
        price: ￥800.00
    19.  
        - item: HD
    20.  
        model: WD
    21.  
        price: ￥450.00
    22.  
         
    23.  
        # 上面使用 “-” 前导与缩进来表示多个列表项，相当于下面的JSON表示
    24.  
        items: [{item:cpu, model:i3, price:￥800.00}, {item:HD, model:WD, price: ￥450.00}]
    25.  
         

• 规范六：文本块

  • 使用 “|” 和文本内容缩进表示的块：保留块中已有的回车换行。相当于段落块

    1.  
       yaml: | # 注意 ":" 与 "|" 之间的空格
    2.  
       JSON的语法其实是YAML的子集，大部分的JSON文件都可以被YAML的解释器解释。
    3.  
       如果你想更深入的学习YAML，我建议你去 http://www.yaml.org 看看
    4.  
        

  • 使用 “>” 和文本内容缩进表示的块：将块中回车替换为空格，最终连接成一行。

    1.  
       yaml: > # 注意 ":" 与 ">" 之间的空格，另外可以使用空行来分段落
    2.  
       JSON的语法其实是YAML的子集，
    3.  
       大部分的JSON文件都可以被YAML的解释器解释。
    4.  
        
    5.  
       如果你想更深入的学习YAML，我建议你去 http://www.yaml.org 看看
    6.  
        

  • 使用定界符“”（双引号）、‘’（单引号）或回车表示的块：最终表示成一行。

    1.  
       yaml: # 使用回车的多行，最终连接成一行。
    2.  
       JSON的语法其实是YAML的子集，
    3.  
       大部分的JSON文件都可以被YAML的解释器解释。
    4.  
        
    5.  
       yaml: # 使用了双引号，双引号的好处是可以转义，即在里面可以使用特殊符号
    6.  
       "JSON的语法其实是YAML的子集，
    7.  
       大部分的JSON文件都可以被YAML的解释器解释。"
    8.  
        

• 规范七：数据类型的约定

  • 对一些常用数据类型的表示格式进行了约定，包括:

    1.  
       integer: 12345 # 整数标准形式
    2.  
       octal: 0o34 # 八进制表示，第二个是字母 o
    3.  
       hex: 0xFF # 十六进制表示
    4.  
        
    5.  
       float: 1.23e+3 # 浮点数
    6.  
       fixed: 13.67 # 固定小数
    7.  
       minmin: -.inf # 表示负无穷
    8.  
       notNumber: .NaN # 无效数字
    9.  
        
    10.  
        null: # 空值
    11.  
        boolean: [true, false] # 布尔值
    12.  
        string: '12345' # 字符串
    13.  
         
    14.  
        date: 2015-08-23 # 日期
    15.  
        datetime: 2015-08-23T02:02:00.1z # 日期时间
    16.  
        iso8601: 2015-08-23t21:59:43.10-05:00 # iso8601 日期格式
    17.  
        spaced: 2015-08-23 21:59:43.10 -5 # ?
    18.  
         

  • “!”（叹号）显式指示类型，或自定义类型标识。单叹号通常是自定义类型，双叹号是内置类型

    1.  
       isString: !!str 2015-08-23 # 强调是字符串不是日期数据
    2.  
       picture: !!binary | # Base64 图片
    3.  
       R0lGODlhDAAMAIQAAP//9/X
    4.  
       17unp5WZmZgAAAOfn515eXv
    5.  
       Pz7Y6OjuDg4J+fn5OTk6enp
    6.  
       56enmleECcgggoBADs=
    7.  
       #下面是内置类型
    8.  
       !!int # 整数类型
    9.  
       !!float # 浮点类型
    10.  
        !!bool # 布尔类型
    11.  
        !!str # 字符串类型
    12.  
        !!binary # 也是字符串类型
    13.  
        !!timestamp # 日期时间类型
    14.  
        !!null # 空值
    15.  
        !!set # 集合
    16.  
        !!omap, !!pairs # 键值列表或对象列表
    17.  
        !!seq # 序列，也是列表
    18.  
        !!map # 键值表
    19.  
         
    20.  
        #下面是一些例子：
    21.  
        --- !!omap
    22.  
        - Mark: 65
    23.  
        - Sammy: 63
    24.  
        - Key: 58
    25.  
         
    26.  
        --- !!set # 注意，“?”表示键为列表，在这里列表为 null
    27.  
        ? Mark
    28.  
        ? Sammy
    29.  
        ? Key
    30.  
         
    31.  
        # 下面是自定义的类型或标识
    32.  
        %TAG ! tag:clarkevans.com,2002: # % 是指令符号
    33.  
        --- !shape
    34.  
        # Use the ! handle for presenting
    35.  
        # tag:clarkevans.com,2002:circle
    36.  
        - !circle
    37.  
        center: &ORIGIN {x: 73, y: 129}
    38.  
        radius: 7
    39.  
        - !line
    40.  
        start: *ORIGIN
    41.  
        finish: { x: 89, y: 102 }
    42.  
        - !label
    43.  
        start: *ORIGIN
    44.  
        color: 0xFFEEBB
    45.  
        text: Pretty vector drawing.
    46.  
         

• 规范八：锚点与引用，定义数据的复用。

  • 第一步：使用 “&” 定义数据锚点（即要复制的数据）
  • 第二步：使用 “*” 引用上述锚点数据（即数据的复制目的地）
    1.  
       ---
    2.  
       hr:
    3.  
       - Mark McGwire
    4.  
       # Following node labeled SS
    5.  
       - &SS Sammy Sosa # 定义要复制的数据
    6.  
       rbi:
    7.  
       - *SS # Subsequent occurrence 这里是数据复制目标
    8.  
       - Ken Griffey
    9.  
        

• 人类容易阅读

• 可用于不同程序间的数据交换

• 适合描述程序所使用的数据结构，特别是脚本语言

• 丰富的表达能力与可扩展性

• 易于使用

1.2 YAML 与 XML、JSON

• YAML 与 XML

  • 具有 XML 同样的优点，但比 XML 更加简单、敏捷等

• YAML 与 JSON

  • JSON 可以看作是 YAML 的子集，也就是说 JSON 能够做的事情，YAML 也能够做

  • YAML 能表示得比 JSON 更加简单和阅读，例如“字符串不需要引号”。所以 YAML 容易可以写成 JSON 的格式，但并不建议这种做

  • YAML 能够描述比 JSON 更加复杂的结构，例如“关系锚点”可以表示数据引用（如重复数据的引用）。

1.3 YAML 组织结构

　　YAML 文件可以由一或多个文档组成（也即相对独立的组织结构组成），文档间使用“---”（三个横线）在每文档开始作为分隔符。同时，文档也可以使用“...”（三个点号）作为结束符（可选）。如下图所示：

<br/>

• 如果只是单个文档，分隔符“---”可省略。

• 每个文档并不需要使用结束符“...”来表示结束，但是对于网络传输或者流来说，作为明确结束的符号，有利于软件处理。（例如不需要知道流关闭就能知道文档结束） <br/>

　　YAML 认为数据由以下三种结构组成：（每个文档由三种结构混合组成）

• 标量 （相当于数据类型）

• 序列 （相当于数组和列表）

• 键值表（相当于 Map 表）

2. YAML 编写规范

• 规范一：文档使用 Unicode 编码作为字符标准编码，例如 UTF-8

• 规范二：使用“#”来表示注释内容

  1.  
     # 客户订单
  2.  
     date: 2015-02-01
  3.  
     customer:
  4.  
     - name: Jai
  5.  
     items:
  6.  
     - no: 1234 # 订单号
  7.  
     - descript: cpu
  8.  
      

• 规范三：使用空格作为嵌套缩进工具。通常建议使用两个空格缩进，不建议使用 tab （甚至不支持）

• 规范四：序列表示

  • 使用“-”（横线） + 单个空格表示单个列表项
    1.  
       --- # 文档开始
    2.  
       - 第一章 简介
    3.  
       - 第二章 设计目录
    4.  
        
  • 使用"[]"表示一组数据
    1.  
       --- # 文档开始
    2.  
       [blue, red, green]
    3.  
        
  • 组合表示。每个结构都可以嵌套组成复杂的表示结构。
    1.  
       --- # 文档开始
    2.  
       - [blue, red, green] # 列表项本身也是一个列表
    3.  
       - [Age, Bag]
    4.  
       - site: {osc:www.oschina.net, baidu: www.baidu.com} # 这里是同 键值表 组合表示

• 规范五：键值表

  • 使用 “:”（冒号） + 空格表示单个键值对
    1.  
       # 客户订单
    2.  
       date: 2015-02-01
    3.  
       customer:
    4.  
       - name: Jai
    5.  
       items:
    6.  
       - no: 1234 # 订单号
    7.  
       - descript: cpu
    8.  
       - price: ￥800.00
    9.  
        
  • 使用"{}"表示一个键值表
    1.  
       # 客户订单
    2.  
       date: 2015-02-01
    3.  
       customer:
    4.  
       - name: Jai
    5.  
       items: {no: 1234, descript: cpu, price: ￥800.00}
    6.  
        
  • "? " 问号+空格表示复杂的键。当键是一个列表或键值表时，就需要使用本符号来标记。
    1.  
       # 使用一个列表作为键
    2.  
       ? [blue, reg, green]: Color
    3.  
       # 等价于
    4.  
       ? - blue
    5.  
       - reg
    6.  
       - gree
    7.  
       : Color
    8.  
        

  • 组合表示。每个结构都可以嵌套组成复杂的表示结构。

    1.  
       Color:
    2.  
       - blue
    3.  
       - red
    4.  
       - green
    5.  
        
    6.  
       # 相当于 (也是 JSON 的表示)
    7.  
       {Color: [blue, red, green]}
    8.  
        
    9.  
       div:
    10.  
        - border: {color: red, width: 2px}
    11.  
        - background: {color: green}
    12.  
        - padding: [0, 10px, 0, 10px]
    13.  
         
    14.  
        # 使用缩进表示的键值表与列表项
    15.  
        items:
    16.  
        - item: cpu
    17.  
        model: i3
    18.  
        price: ￥800.00
    19.  
        - item: HD
    20.  
        model: WD
    21.  
        price: ￥450.00
    22.  
         
    23.  
        # 上面使用 “-” 前导与缩进来表示多个列表项，相当于下面的JSON表示
    24.  
        items: [{item:cpu, model:i3, price:￥800.00}, {item:HD, model:WD, price: ￥450.00}]
    25.  
         

• 规范六：文本块

  • 使用 “|” 和文本内容缩进表示的块：保留块中已有的回车换行。相当于段落块

    1.  
       yaml: | # 注意 ":" 与 "|" 之间的空格
    2.  
       JSON的语法其实是YAML的子集，大部分的JSON文件都可以被YAML的解释器解释。
    3.  
       如果你想更深入的学习YAML，我建议你去 http://www.yaml.org 看看
    4.  
        

  • 使用 “>” 和文本内容缩进表示的块：将块中回车替换为空格，最终连接成一行。

    1.  
       yaml: > # 注意 ":" 与 ">" 之间的空格，另外可以使用空行来分段落
    2.  
       JSON的语法其实是YAML的子集，
    3.  
       大部分的JSON文件都可以被YAML的解释器解释。
    4.  
        
    5.  
       如果你想更深入的学习YAML，我建议你去 http://www.yaml.org 看看
    6.  
        

  • 使用定界符“”（双引号）、‘’（单引号）或回车表示的块：最终表示成一行。

    1.  
       yaml: # 使用回车的多行，最终连接成一行。
    2.  
       JSON的语法其实是YAML的子集，
    3.  
       大部分的JSON文件都可以被YAML的解释器解释。
    4.  
        
    5.  
       yaml: # 使用了双引号，双引号的好处是可以转义，即在里面可以使用特殊符号
    6.  
       "JSON的语法其实是YAML的子集，
    7.  
       大部分的JSON文件都可以被YAML的解释器解释。"
    8.  
        

• 规范七：数据类型的约定

  • 对一些常用数据类型的表示格式进行了约定，包括:

    1.  
       integer: 12345 # 整数标准形式
    2.  
       octal: 0o34 # 八进制表示，第二个是字母 o
    3.  
       hex: 0xFF # 十六进制表示
    4.  
        
    5.  
       float: 1.23e+3 # 浮点数
    6.  
       fixed: 13.67 # 固定小数
    7.  
       minmin: -.inf # 表示负无穷
    8.  
       notNumber: .NaN # 无效数字
    9.  
        
    10.  
        null: # 空值
    11.  
        boolean: [true, false] # 布尔值
    12.  
        string: '12345' # 字符串
    13.  
         
    14.  
        date: 2015-08-23 # 日期
    15.  
        datetime: 2015-08-23T02:02:00.1z # 日期时间
    16.  
        iso8601: 2015-08-23t21:59:43.10-05:00 # iso8601 日期格式
    17.  
        spaced: 2015-08-23 21:59:43.10 -5 # ?
    18.  
         

  • “!”（叹号）显式指示类型，或自定义类型标识。单叹号通常是自定义类型，双叹号是内置类型

    1.  
       isString: !!str 2015-08-23 # 强调是字符串不是日期数据
    2.  
       picture: !!binary | # Base64 图片
    3.  
       R0lGODlhDAAMAIQAAP//9/X
    4.  
       17unp5WZmZgAAAOfn515eXv
    5.  
       Pz7Y6OjuDg4J+fn5OTk6enp
    6.  
       56enmleECcgggoBADs=
    7.  
       #下面是内置类型
    8.  
       !!int # 整数类型
    9.  
       !!float # 浮点类型
    10.  
        !!bool # 布尔类型
    11.  
        !!str # 字符串类型
    12.  
        !!binary # 也是字符串类型
    13.  
        !!timestamp # 日期时间类型
    14.  
        !!null # 空值
    15.  
        !!set # 集合
    16.  
        !!omap, !!pairs # 键值列表或对象列表
    17.  
        !!seq # 序列，也是列表
    18.  
        !!map # 键值表
    19.  
         
    20.  
        #下面是一些例子：
    21.  
        --- !!omap
    22.  
        - Mark: 65
    23.  
        - Sammy: 63
    24.  
        - Key: 58
    25.  
         
    26.  
        --- !!set # 注意，“?”表示键为列表，在这里列表为 null
    27.  
        ? Mark
    28.  
        ? Sammy
    29.  
        ? Key
    30.  
         
    31.  
        # 下面是自定义的类型或标识
    32.  
        %TAG ! tag:clarkevans.com,2002: # % 是指令符号
    33.  
        --- !shape
    34.  
        # Use the ! handle for presenting
    35.  
        # tag:clarkevans.com,2002:circle
    36.  
        - !circle
    37.  
        center: &ORIGIN {x: 73, y: 129}
    38.  
        radius: 7
    39.  
        - !line
    40.  
        start: *ORIGIN
    41.  
        finish: { x: 89, y: 102 }
    42.  
        - !label
    43.  
        start: *ORIGIN
    44.  
        color: 0xFFEEBB
    45.  
        text: Pretty vector drawing.
    46.  
         

• 规范八：锚点与引用，定义数据的复用。

  • 第一步：使用 “&” 定义数据锚点（即要复制的数据）
  • 第二步：使用 “*” 引用上述锚点数据（即数据的复制目的地）
    1.  
       ---
    2.  
       hr:
    3.  
       - Mark McGwire
    4.  
       # Following node labeled SS
    5.  
       - &SS Sammy Sosa # 定义要复制的数据
    6.  
       rbi:
    7.  
       - *SS # Subsequent occurrence 这里是数据复制目标
    8.  
       - Ken Griffey
    9.  
        

1.1 YAML 的设计目标：

• 人类容易阅读

• 可用于不同程序间的数据交换

• 适合描述程序所使用的数据结构，特别是脚本语言

• 丰富的表达能力与可扩展性

• 易于使用

1.2 YAML 与 XML、JSON

• YAML 与 XML

  • 具有 XML 同样的优点，但比 XML 更加简单、敏捷等

• YAML 与 JSON

  • JSON 可以看作是 YAML 的子集，也就是说 JSON 能够做的事情，YAML 也能够做

  • YAML 能表示得比 JSON 更加简单和阅读，例如“字符串不需要引号”。所以 YAML 容易可以写成 JSON 的格式，但并不建议这种做

  • YAML 能够描述比 JSON 更加复杂的结构，例如“关系锚点”可以表示数据引用（如重复数据的引用）。

1.3 YAML 组织结构

　　YAML 文件可以由一或多个文档组成（也即相对独立的组织结构组成），文档间使用“---”（三个横线）在每文档开始作为分隔符。同时，文档也可以使用“...”（三个点号）作为结束符（可选）。如下图所示：

<br/>

• 如果只是单个文档，分隔符“---”可省略。

• 每个文档并不需要使用结束符“...”来表示结束，但是对于网络传输或者流来说，作为明确结束的符号，有利于软件处理。（例如不需要知道流关闭就能知道文档结束） <br/>

　　YAML 认为数据由以下三种结构组成：（每个文档由三种结构混合组成）

• 标量 （相当于数据类型）

• 序列 （相当于数组和列表）

• 键值表（相当于 Map 表）

2. YAML 编写规范

• 规范一：文档使用 Unicode 编码作为字符标准编码，例如 UTF-8

• 规范二：使用“#”来表示注释内容

  1.  
     # 客户订单
  2.  
     date: 2015-02-01
  3.  
     customer:
  4.  
     - name: Jai
  5.  
     items:
  6.  
     - no: 1234 # 订单号
  7.  
     - descript: cpu
  8.  
      

• 规范三：使用空格作为嵌套缩进工具。通常建议使用两个空格缩进，不建议使用 tab （甚至不支持）

• 规范四：序列表示

  • 使用“-”（横线） + 单个空格表示单个列表项
    1.  
       --- # 文档开始
    2.  
       - 第一章 简介
    3.  
       - 第二章 设计目录
    4.  
        
  • 使用"[]"表示一组数据
    1.  
       --- # 文档开始
    2.  
       [blue, red, green]
    3.  
        
  • 组合表示。每个结构都可以嵌套组成复杂的表示结构。
    1.  
       --- # 文档开始
    2.  
       - [blue, red, green] # 列表项本身也是一个列表
    3.  
       - [Age, Bag]
    4.  
       - site: {osc:www.oschina.net, baidu: www.baidu.com} # 这里是同 键值表 组合表示

• 规范五：键值表

  • 使用 “:”（冒号） + 空格表示单个键值对
    1.  
       # 客户订单
    2.  
       date: 2015-02-01
    3.  
       customer:
    4.  
       - name: Jai
    5.  
       items:
    6.  
       - no: 1234 # 订单号
    7.  
       - descript: cpu
    8.  
       - price: ￥800.00
    9.  
        
  • 使用"{}"表示一个键值表
    1.  
       # 客户订单
    2.  
       date: 2015-02-01
    3.  
       customer:
    4.  
       - name: Jai
    5.  
       items: {no: 1234, descript: cpu, price: ￥800.00}
    6.  
        
  • "? " 问号+空格表示复杂的键。当键是一个列表或键值表时，就需要使用本符号来标记。
    1.  
       # 使用一个列表作为键
    2.  
       ? [blue, reg, green]: Color
    3.  
       # 等价于
    4.  
       ? - blue
    5.  
       - reg
    6.  
       - gree
    7.  
       : Color
    8.  
        

  • 组合表示。每个结构都可以嵌套组成复杂的表示结构。

    1.  
       Color:
    2.  
       - blue
    3.  
       - red
    4.  
       - green
    5.  
        
    6.  
       # 相当于 (也是 JSON 的表示)
    7.  
       {Color: [blue, red, green]}
    8.  
        
    9.  
       div:
    10.  
        - border: {color: red, width: 2px}
    11.  
        - background: {color: green}
    12.  
        - padding: [0, 10px, 0, 10px]
    13.  
         
    14.  
        # 使用缩进表示的键值表与列表项
    15.  
        items:
    16.  
        - item: cpu
    17.  
        model: i3
    18.  
        price: ￥800.00
    19.  
        - item: HD
    20.  
        model: WD
    21.  
        price: ￥450.00
    22.  
         
    23.  
        # 上面使用 “-” 前导与缩进来表示多个列表项，相当于下面的JSON表示
    24.  
        items: [{item:cpu, model:i3, price:￥800.00}, {item:HD, model:WD, price: ￥450.00}]
    25.  
         

• 规范六：文本块

  • 使用 “|” 和文本内容缩进表示的块：保留块中已有的回车换行。相当于段落块

    1.  
       yaml: | # 注意 ":" 与 "|" 之间的空格
    2.  
       JSON的语法其实是YAML的子集，大部分的JSON文件都可以被YAML的解释器解释。
    3.  
       如果你想更深入的学习YAML，我建议你去 http://www.yaml.org 看看
    4.  
        

  • 使用 “>” 和文本内容缩进表示的块：将块中回车替换为空格，最终连接成一行。

    1.  
       yaml: > # 注意 ":" 与 ">" 之间的空格，另外可以使用空行来分段落
    2.  
       JSON的语法其实是YAML的子集，
    3.  
       大部分的JSON文件都可以被YAML的解释器解释。
    4.  
        
    5.  
       如果你想更深入的学习YAML，我建议你去 http://www.yaml.org 看看
    6.  
        

  • 使用定界符“”（双引号）、‘’（单引号）或回车表示的块：最终表示成一行。

    1.  
       yaml: # 使用回车的多行，最终连接成一行。
    2.  
       JSON的语法其实是YAML的子集，
    3.  
       大部分的JSON文件都可以被YAML的解释器解释。
    4.  
        
    5.  
       yaml: # 使用了双引号，双引号的好处是可以转义，即在里面可以使用特殊符号
    6.  
       "JSON的语法其实是YAML的子集，
    7.  
       大部分的JSON文件都可以被YAML的解释器解释。"
    8.  
        

• 规范七：数据类型的约定

  • 对一些常用数据类型的表示格式进行了约定，包括:

    1.  
       integer: 12345 # 整数标准形式
    2.  
       octal: 0o34 # 八进制表示，第二个是字母 o
    3.  
       hex: 0xFF # 十六进制表示
    4.  
        
    5.  
       float: 1.23e+3 # 浮点数
    6.  
       fixed: 13.67 # 固定小数
    7.  
       minmin: -.inf # 表示负无穷
    8.  
       notNumber: .NaN # 无效数字
    9.  
        
    10.  
        null: # 空值
    11.  
        boolean: [true, false] # 布尔值
    12.  
        string: ‘12345‘ # 字符串
    13.  
         
    14.  
        date: 2015-08-23 # 日期
    15.  
        datetime: 2015-08-23T02:02:00.1z # 日期时间
    16.  
        iso8601: 2015-08-23t21:59:43.10-05:00 # iso8601 日期格式
    17.  
        spaced: 2015-08-23 21:59:43.10 -5 # ?
    18.  
         

  • “!”（叹号）显式指示类型，或自定义类型标识。单叹号通常是自定义类型，双叹号是内置类型

    1.  
       isString: !!str 2015-08-23 # 强调是字符串不是日期数据
    2.  
       picture: !!binary | # Base64 图片
    3.  
       R0lGODlhDAAMAIQAAP//9/X
    4.  
       17unp5WZmZgAAAOfn515eXv
    5.  
       Pz7Y6OjuDg4J+fn5OTk6enp
    6.  
       56enmleECcgggoBADs=
    7.  
       #下面是内置类型
    8.  
       !!int # 整数类型
    9.  
       !!float # 浮点类型
    10.  
        !!bool # 布尔类型
    11.  
        !!str # 字符串类型
    12.  
        !!binary # 也是字符串类型
    13.  
        !!timestamp # 日期时间类型
    14.  
        !!null # 空值
    15.  
        !!set # 集合
    16.  
        !!omap, !!pairs # 键值列表或对象列表
    17.  
        !!seq # 序列，也是列表
    18.  
        !!map # 键值表
    19.  
         
    20.  
        #下面是一些例子：
    21.  
        --- !!omap
    22.  
        - Mark: 65
    23.  
        - Sammy: 63
    24.  
        - Key: 58
    25.  
         
    26.  
        --- !!set # 注意，“?”表示键为列表，在这里列表为 null
    27.  
        ? Mark
    28.  
        ? Sammy
    29.  
        ? Key
    30.  
         
    31.  
        # 下面是自定义的类型或标识
    32.  
        %TAG ! tag:clarkevans.com,2002: # % 是指令符号
    33.  
        --- !shape
    34.  
        # Use the ! handle for presenting
    35.  
        # tag:clarkevans.com,2002:circle
    36.  
        - !circle
    37.  
        center: &ORIGIN {x: 73, y: 129}
    38.  
        radius: 7
    39.  
        - !line
    40.  
        start: *ORIGIN
    41.  
        finish: { x: 89, y: 102 }
    42.  
        - !label
    43.  
        start: *ORIGIN
    44.  
        color: 0xFFEEBB
    45.  
        text: Pretty vector drawing.
    46.  
         

• 规范八：锚点与引用，定义数据的复用。

  • 第一步：使用 “&” 定义数据锚点（即要复制的数据）
  • 第二步：使用 “*” 引用上述锚点数据（即数据的复制目的地）
    1.  
       ---
    2.  
       hr:
    3.  
       - Mark McGwire
    4.  
       # Following node labeled SS
    5.  
       - &SS Sammy Sosa # 定义要复制的数据
    6.  
       rbi:
    7.  
       - *SS # Subsequent occurrence 这里是数据复制目标
    8.  
       - Ken Griffey
    9.  
        

• 参考链接
• YAML 1.2 规格
• YAML from Wikipedia
• YAML for Ruby

规范一：文档使用 Unicode 编码作为字符标准编码，例如 UTF-8

规范二：使用“#”来表示注释内容

1.  
   # 客户订单
2.  
   date: 2015-02-01
3.  
   customer:
4.  
   - name: Jai
5.  
   items:
6.  
   - no: 1234 # 订单号
7.  
   - descript: cpu
8.  
    

规范三：使用空格作为嵌套缩进工具。通常建议使用两个空格缩进，不建议使用 tab （甚至不支持）

规范四：序列表示

• 使用“-”（横线） + 单个空格表示单个列表项
  1.  
     --- # 文档开始
  2.  
     - 第一章 简介
  3.  
     - 第二章 设计目录
  4.  
      
• 使用"[]"表示一组数据
  1.  
     --- # 文档开始
  2.  
     [blue, red, green]
  3.  
      
• 组合表示。每个结构都可以嵌套组成复杂的表示结构。
  1.  
     --- # 文档开始
  2.  
     - [blue, red, green] # 列表项本身也是一个列表
  3.  
     - [Age, Bag]
  4.  
     - site: {osc:www.oschina.net, baidu: www.baidu.com} # 这里是同 键值表 组合表示

规范五：键值表

• 使用 “:”（冒号） + 空格表示单个键值对
  1.  
     # 客户订单
  2.  
     date: 2015-02-01
  3.  
     customer:
  4.  
     - name: Jai
  5.  
     items:
  6.  
     - no: 1234 # 订单号
  7.  
     - descript: cpu
  8.  
     - price: ￥800.00
  9.  
      
• 使用"{}"表示一个键值表
  1.  
     # 客户订单
  2.  
     date: 2015-02-01
  3.  
     customer:
  4.  
     - name: Jai
  5.  
     items: {no: 1234, descript: cpu, price: ￥800.00}
  6.  
      
• "? " 问号+空格表示复杂的键。当键是一个列表或键值表时，就需要使用本符号来标记。
  1.  
     # 使用一个列表作为键
  2.  
     ? [blue, reg, green]: Color
  3.  
     # 等价于
  4.  
     ? - blue
  5.  
     - reg
  6.  
     - gree
  7.  
     : Color
  8.  
      

• 组合表示。每个结构都可以嵌套组成复杂的表示结构。

  1.  
     Color:
  2.  
     - blue
  3.  
     - red
  4.  
     - green
  5.  
      
  6.  
     # 相当于 (也是 JSON 的表示)
  7.  
     {Color: [blue, red, green]}
  8.  
      
  9.  
     div:
  10.  
      - border: {color: red, width: 2px}
  11.  
      - background: {color: green}
  12.  
      - padding: [0, 10px, 0, 10px]
  13.  
       
  14.  
      # 使用缩进表示的键值表与列表项
  15.  
      items:
  16.  
      - item: cpu
  17.  
      model: i3
  18.  
      price: ￥800.00
  19.  
      - item: HD
  20.  
      model: WD
  21.  
      price: ￥450.00
  22.  
       
  23.  
      # 上面使用 “-” 前导与缩进来表示多个列表项，相当于下面的JSON表示
  24.  
      items: [{item:cpu, model:i3, price:￥800.00}, {item:HD, model:WD, price: ￥450.00}]
  25.  
       

规范六：文本块

• 使用 “|” 和文本内容缩进表示的块：保留块中已有的回车换行。相当于段落块

  1.  
     yaml: | # 注意 ":" 与 "|" 之间的空格
  2.  
     JSON的语法其实是YAML的子集，大部分的JSON文件都可以被YAML的解释器解释。
  3.  
     如果你想更深入的学习YAML，我建议你去 http://www.yaml.org 看看
  4.  
      

• 使用 “>” 和文本内容缩进表示的块：将块中回车替换为空格，最终连接成一行。

  1.  
     yaml: > # 注意 ":" 与 ">" 之间的空格，另外可以使用空行来分段落
  2.  
     JSON的语法其实是YAML的子集，
  3.  
     大部分的JSON文件都可以被YAML的解释器解释。
  4.  
      
  5.  
     如果你想更深入的学习YAML，我建议你去 http://www.yaml.org 看看
  6.  
      

• 使用定界符“”（双引号）、‘’（单引号）或回车表示的块：最终表示成一行。

  1.  
     yaml: # 使用回车的多行，最终连接成一行。
  2.  
     JSON的语法其实是YAML的子集，
  3.  
     大部分的JSON文件都可以被YAML的解释器解释。
  4.  
      
  5.  
     yaml: # 使用了双引号，双引号的好处是可以转义，即在里面可以使用特殊符号
  6.  
     "JSON的语法其实是YAML的子集，
  7.  
     大部分的JSON文件都可以被YAML的解释器解释。"
  8.  
      

规范七：数据类型的约定

• 对一些常用数据类型的表示格式进行了约定，包括:

  1.  
     integer: 12345 # 整数标准形式
  2.  
     octal: 0o34 # 八进制表示，第二个是字母 o
  3.  
     hex: 0xFF # 十六进制表示
  4.  
      
  5.  
     float: 1.23e+3 # 浮点数
  6.  
     fixed: 13.67 # 固定小数
  7.  
     minmin: -.inf # 表示负无穷
  8.  
     notNumber: .NaN # 无效数字
  9.  
      
  10.  
      null: # 空值
  11.  
      boolean: [true, false] # 布尔值
  12.  
      string: ‘12345‘ # 字符串
  13.  
       
  14.  
      date: 2015-08-23 # 日期
  15.  
      datetime: 2015-08-23T02:02:00.1z # 日期时间
  16.  
      iso8601: 2015-08-23t21:59:43.10-05:00 # iso8601 日期格式
  17.  
      spaced: 2015-08-23 21:59:43.10 -5 # ?
  18.  
       

• “!”（叹号）显式指示类型，或自定义类型标识。单叹号通常是自定义类型，双叹号是内置类型

  1.  
     isString: !!str 2015-08-23 # 强调是字符串不是日期数据
  2.  
     picture: !!binary | # Base64 图片
  3.  
     R0lGODlhDAAMAIQAAP//9/X
  4.  
     17unp5WZmZgAAAOfn515eXv
  5.  
     Pz7Y6OjuDg4J+fn5OTk6enp
  6.  
     56enmleECcgggoBADs=
  7.  
     #下面是内置类型
  8.  
     !!int # 整数类型
  9.  
     !!float # 浮点类型
  10.  
      !!bool # 布尔类型
  11.  
      !!str # 字符串类型
  12.  
      !!binary # 也是字符串类型
  13.  
      !!timestamp # 日期时间类型
  14.  
      !!null # 空值
  15.  
      !!set # 集合
  16.  
      !!omap, !!pairs # 键值列表或对象列表
  17.  
      !!seq # 序列，也是列表
  18.  
      !!map # 键值表
  19.  
       
  20.  
      #下面是一些例子：
  21.  
      --- !!omap
  22.  
      - Mark: 65
  23.  
      - Sammy: 63
  24.  
      - Key: 58
  25.  
       
  26.  
      --- !!set # 注意，“?”表示键为列表，在这里列表为 null
  27.  
      ? Mark
  28.  
      ? Sammy
  29.  
      ? Key
  30.  
       
  31.  
      # 下面是自定义的类型或标识
  32.  
      %TAG ! tag:clarkevans.com,2002: # % 是指令符号
  33.  
      --- !shape
  34.  
      # Use the ! handle for presenting
  35.  
      # tag:clarkevans.com,2002:circle
  36.  
      - !circle
  37.  
      center: &ORIGIN {x: 73, y: 129}
  38.  
      radius: 7
  39.  
      - !line
  40.  
      start: *ORIGIN
  41.  
      finish: { x: 89, y: 102 }
  42.  
      - !label
  43.  
      start: *ORIGIN
  44.  
      color: 0xFFEEBB
  45.  
      text: Pretty vector drawing.
  46.  
       

规范八：锚点与引用，定义数据的复用。

• 第一步：使用 “&” 定义数据锚点（即要复制的数据）
• 第二步：使用 “*” 引用上述锚点数据（即数据的复制目的地）
  1.  
     ---
  2.  
     hr:
  3.  
     - Mark McGwire
  4.  
     # Following node labeled SS
  5.  
     - &SS Sammy Sosa # 定义要复制的数据
  6.  
     rbi:
  7.  
     - *SS # Subsequent occurrence 这里是数据复制目标
  8.  
     - Ken Griffey
  9.