yaml语法及规范

在数据格式描述和较复杂数据内容展示方面的配置文件，JSON能够很好的支持，包括语法突出显示、自动格式化、验证工具等。然而缺乏注释，过于严格，长字符串转换会出现问题等等。对于运维人员，面对较复杂的数据结构来说，不得不寻找一个替代的方式。
YAML（YAML 不是标记语言）是一种非常灵活的格式，几乎是 JSON 的超集，已经被用在一些著名的项目中，如 Travis CI、Circle CI 和 AWS CloudFormation。YAML 的库几乎和 JSON 一样无处不在。除了支持注释、换行符分隔、多行字符串、裸字符串和更灵活的类型系统之外，YAML 也支持引用文件，以避免重复代码。

• YAML语法规范；
• YAML文本块得使用；
• YAML锚点与引用；
• YAML存量，数据类型约定；
• YAML对象及数组的使用规则。

YAML简介
YAML语言的设计参考了JSON，XML和SDL等语言。YAML 强调以数据为中心,简洁易读,编写简单。
YAML 语言（发音 /ˈjæməl/ ）的设计目标，就是方便人类读写。它实质上是一种通用的数据串行化格式。
YAML 有一个小的怪癖。所有的 YAML 文件开始行都应该是 ---。这是 YAML 格式的一部分, 表明一个文件的开始。

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

YAML语法及规范

语法特点

• 大小写敏感
• 通过缩进表示层级关系
• 禁止使用tab缩进，只能使用空格键
• 缩进的空格数目不重要，只要相同层级左对齐即可
• 使用#表示注释

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

引号

双引号""：不会转义字符串里面的特殊字符，特殊字符作为本身想表示的意思。
name: "123\n123" 
输出： 123 换行 123

单引号''：会将字符串里面的特殊字符转义为字符串处理
name: "123\n123"
输出： 123\n123
如果不加引号将会转义特殊字符，当成字符串处理

文本块

|：使用|标注的文本内容缩进表示的块，可以保留块中已有的回车换行

value: |
   hello
   world!
输出：hello 换行 world！

+表示保留文字块末尾的换行，-表示删除字符串末尾的换行。
value: |
hello

value: |-
hello

value: |+
hello

输出：hello\n hello hello\n\n(有多少个回车就有多少个\n)

注意 “|” 与 文本之间须另起一行

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

value: > hello
world!

输出：hello 空格 world！

注意 “>” 与 文本之间的空格

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

锚点与引用

使用 & 定义数据锚点（即要复制的数据），使用 * 引用锚点数据（即数据的复制目的地）

name: &a yaml
book: *a
books: 
   - java
   - *a
   - python

输出book： yaml
输出books：[java,yaml,python]

注意*引用部分不能追加内容

• 存量，数据类型约定 *

纯量是最基本的、不可再分的值。
- 字符串
使用”或”“或不使用引号
value0: 'hello World!'
value1: "hello World!"
value2: hello World!

布尔值
true或false表示。

数字
12 #整数 
014 # 八进制整数 
0xC ＃十六进制整数 
13.4 ＃浮点数 
1.2e+34 ＃指数 
.inf空值 ＃无穷大

空值
null或~表示

日期
使用 iso-8601 标准表示日期

date: 2018-01-01t16:59:43.10-05:00
在springboot中yaml文件的时间格式 date: yyyy/MM/dd HH:mm:ss

强制类型转换
YAML 允许使用个感叹号!，强制转换数据类型，单叹号通常是自定义类型，双叹号是内置类型。
money: !!str
123
date: !Boolean
true

内置类型：
!!int # 整数类型 
!!float # 浮点类型 
!!bool # 布尔类型 
!!str # 字符串类型 
!!binary # 也是字符串类型 
!!timestamp # 日期时间类型 
!!null # 空值 
!!set # 集合 
!!omap,!!pairs # 键值列表或对象列表
!!seq # 序列，也是列表 !!map # 键值表

对象

Map（属性和值）（键值对）的形式：
key:(空格)v ：表示一堆键值对，空格不可省略。

car:
    color: red
    brand: BMW

一行写法

car:{
   color: red，brand: BMW}

相当于json：
{"color":"red","brand":"BMW"}


使用冒号代表，格式为key: value。冒号后面要加一个空格：

---
#即表示url属性值；
url: https://www.liuluanyi.cn 
转为 JavaScript 如下:

{ url: 'https://www.liuluanyi.cn'}
Yaml 也允许另一种写法，将所有键值对写成一个行内对象。

--- 
host: { ip: 10.1.1.1, port: 2222 } 
转为 JavaScript 如下:

{ host: { ip: '10.1.1.1', port: 2222 } }

数组

一组连词线开头的行，构成一个数组。
brand:
   - audi
   - bmw
   - ferrari
一行写法
brand: [audi,bmw,ferrari]

相当于json
["auri","bmw","ferrari"]


列表中的所有成员都开始于相同的缩进级别, 并且使用一个 --- 作为开头(一个横杠和一个空格):

---
ipaddr:
# IP地址列表
- 120.168.117.21
- 120.168.117.22
- 120.168.117.23
转为 JavaScript 如下:

 ipaddr: [ '120.168.117.21', '120.168.117.22', '120.168.117.23' ]
数据结构的子成员是一个数组，则可以在该项下面缩进一个空格。

-
 - source
 - destination
 - services
转为 JavaScript 如下:

[ [ 'source', 'destination', 'services' ] ]
数组也可以采用行内(或者流式)表示法。

services: [FTP, SSH]
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]
转为 JavaScript 如下:

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

对象和数组复合使用

languages:
 - Ruby
 - Perl
 - Python 
websites:
 YAML: yaml.org 
 Ruby: ruby-lang.org 
 Python: python.org 
转为 JavaScript 如下:

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

常量

• 字符串
• 布尔值
• 整数
• 浮点数
• 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
string:
    - 哈哈
    - 'Hello world'  #可以使用双引号或者单引号包裹特殊字符
    - newline
      newline2    #字符串可以拆成多行，每一行会被转化成一个空格
date:
    - 2018-02-17    #日期必须使用ISO 8601格式，即yyyy-MM-dd
datetime: 
    -  2018-02-17T15:02:31+08:00    #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区
转为 JavaScript 如下:

{ boolean: [ true, false ],
  float: [ 3.14, 685230.15 ],
  int: [ 123, 685230 ],
  null: { nodeName: 'node', parent: null },
  string: [ '哈哈', 'Hello world', 'newline newline2' ],
  date: [ Sat Feb 17 2018 08:00:00 GMT+0800 (中国标准时间) ],
  datetime: [ Sat Feb 17 2018 15:02:31 GMT+0800 (中国标准时间) ] }

特殊符号

1、YAML 允许使用两个感叹号，强制转换数据类型。

e: !!str 123
f: !!str true
转为 JavaScript 如下:

{ e: '123', f: 'true' }
2、 … 和---配合使用，在一个配置文件中代表一个文件的结束：

---
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
---
time: 20:03:47
player: Sammy Sosa
action: grand slam
...
3、>在字符串中折叠换行，| 保留换行符，这两个符号是YAML中字符串经常使用的符号，比如：

this: |
  Foo
  Bar
that: >
  Foo
  Bar
转为 JavaScript 如下:

{ this: 'Foo\nBar\n', that: 'Foo Bar\n' }
4、引用。重复的内容在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' } }
注意，不能独立的定义锚点，比如不能直接这样写： &SS Sammy Sosa；另外，锚点能够定义更复杂的内容，比如：
default: &default
    - Mark McGwire
    - Sammy Sosa
hr: *default
那么hr相当于引用了default的数组，注意，hr: *default要写在同一行。