YAML教程

面向读者

本教程的目标读者包括使用JSON和XML文件进行配置设置的Web开发人员。 任何打算以人类可读的结构化数据格式编写标记的程序员也可以学习YAML。

前提条件

本教程的先决条件包括HTML，XML和JSON的基本知识。 YAML专门针对常见用例（如配置文件，日志文件和跨语言共享文件以及数据共享）而设计。

问题反馈

我们不能保证您在学习此Yaml教程的过程中不会遇到任何问题。本教程中的讲解，示例和代码等只是根据作者的理解来概括写出。由于作者水平和能力有限，因此不保正所有编写的文章都准确无误。但是如果有遇到任何错误或问题，请反馈给我们，我们会及时纠正以方便后续读者阅读。

快速入门

下面展示YAML最基本，最常用的一些使用格式：
首先YAML中允许表示三种格式，分别是常量值，对象和数组
例如：

#即表示url属性值；url: http://www.zyi.net#即表示server.host属性的值；server:
    host: http://www.zyiz.net#数组，即表示server为[a,b,c]server:
    - 120.168.0.21    - 120.168.0.22    - 120.168.0.23#常量pi: 3.14   #定义一个数值3.14hasChild: true  #定义一个boolean值name: '你好YAML'   #定义一个字符串YAML

注释

和properties文件格式相同，使用#作为注释开始，YAML中只有行注释。

基本格式要求 -

1. YAML大小写敏感；

2. 使用缩进代表层级关系；

3. 缩进只能使用空格，不能使用TAB，不要求空格个数，只需要相同层级左对齐（一般2个或4个空格）

对象

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

key: valueYAML

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

key: 
    child-key: value    child-key2: value2YAML

YAML中还支持流式(flow)语法表示对象，比如上面例子可以写为：

key: {child-key: value, child-key2: value2}YAML

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

?  
    - complexkey1    - complexkey2:
    - complexvalue1    - complexvalue2YAML

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

数组

使用一个短横线加一个空格代表一个数组项：

hobby:
    - Java    - LOLYAML

当然也可以有这样的写法：

-
    - Java    - LOLYAML

可以简单理解为：[[Java,LOL]]
一个相对复杂的例子：

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

表示是companies属性是一个数组，每一个数组元素又是由id,name,price三个属性构成；
数组也可以使用流式(flow)的方式表示：

常量

YAML中提供了多种常量结构，包括：整数，浮点数，字符串，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: ~  #使用~表示nullstring:
    - 哈哈    - 'Hello world'  #可以使用双引号或者单引号包裹特殊字符
    - newline
      newline2    #字符串可以拆成多行，每一行会被转化成一个空格date:
    - 2018-07-17    #日期必须使用ISO 8601格式，即yyyy-MM-dddatetime: 
    -  2018-07-17T19:02:31+08:00    #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区YAML

一些特殊符号

YAML中提供了很多特殊符号，在这里简单介绍常用的一些：
第1种，--- YAML可以在同一个文件中，使用—-表示一个文档的开始；比如Springboot中profile的定义：

server:
    address: 192.168.1.100---spring:
    profiles: development    server:
        address: 127.0.0.1---spring:
    profiles: production    server:
        address: 192.168.1.120YAML

代表定义了两个profile，一个是development，一个production；也常常使用---来分割不同的内容，比如记录日志：

---Time: 2018-07-17T15:02:31+08:00User: edWarning:
     This is an error message for the log file---Time: 2018-07-17T15:05:21+08:00User: edWarning:
    A slightly different error message.YAML

第2种，... 和---配合使用，在一个配置文件中代表一个文件的结束：

---time: 20:03:20player: Sammy Sosaaction: strike (miss)...---time: 20:03:47player: Sammy Sosaaction: grand slam...YAML

相当于在一个yaml文件中连续写了两个yaml配置项。

第3种，!! YAML中使用!!做类型强行转换：

string:
    - !!str 54321
    - !!str trueYAML

相当于把数字和布尔类型强转为字符串。当然允许转型的类型很多，比如：

--- !!set- Mark McGwire: 65- Sammy Sosa: 63- Sammy Sosa: 63- Ken Griffy: 58YAML

将数组解析为set，简单理解，转化的内容就是：[{Ken Griffy=58}, {Mark McGwire=65}, {Sammy Sosa=63}]，重复的Sammy Sosa去掉；

第4种，>在字符串中折叠换行，| 保留换行符，这两个符号是YAML中字符串经常使用的符号，比如：

accomplishment: >
 Mark set a major league
 home run record in 1998.stats: |
 65 Home Runs
 0.278 Batting AverageYAML

那么结果是：

stats=65 Home Runs
 0.278 Batting Average,YAML

即| 符号保留了换行符，而accomplishment的结果为：

accomplishment=Mark set a major league home run record in 1998.YAML

即将换行符转化成了空格；要注意一点的是，每行的文本前一定要有一个空格。
|符号常见用于在YAML中配置HTML片段：

phraseTemplate: |
  <p style="color: red">
    some template ${msg}
  </p>YAML

第5种，引用。重复的内容在YAML中可以使用&来完成锚点定义，使用*来完成锚点引用，例如：

hr:- Mark McGwire- &SS Sammy Sosarbi:- *SS - Ken GriffeyYAML

可以看到，在hr中，使用&SS为Sammy Sosa设置了一个锚点（引用），名称为SS，在rbi中，使用*SS完成了锚点使用，那么结果为：

{rbi=[Sammy Sosa, Ken Griffey], hr=[Mark McGwire, Sammy Sosa]}YAML

也可以这样定义：

SS: &SS Sammy Sosahr:
 - Mark McGwire - *SSrbi:
 - *SS 
 - Ken GriffeyYAML

第6种，合并内容。主要和锚点配合使用，可以将一个锚点内容直接合并到一个对象中。来看一个示例：

merge:
  - &CENTER { x: 1, y: 2 }
  - &LEFT { x: 0, y: 2 }
  - &BIG { r: 10 }
  - &SMALL { r: 1 }sample1: 
    <<: *CENTER
    r: 10sample2:
    << : [ *CENTER, *BIG ]
    other: hahasample3:
    << : [ *CENTER, *BIG ]
    r: 100YAML

在merge中，定义了四个锚点，分别在sample中使用。
sample1中，<<: *CENTER意思是引用{x: 1,y: 2}，并且合并到sample1中，那么合并的结果为：sample1={r=10, y=2, x=1}

sample2中，<<: [*CENTER, *BIG] 意思是联合引用{x: 1,y: 2}和{r: 10}，并且合并到sample2中，那么合并的结果为：sample2={other=haha, x=1, y=2, r=10}

sample3中，引入了*CENTER, *BIG，还使用了r: 100覆盖了引入的r: 10，所以sample3值为：sample3={r=100, y=2, x=1}

有了合并，就可以在配置中把相同的基础配置抽取出来，在不同的子配置中合并引用即可。