YAML文件使用指南

  • YAML文件简介
  • YAML文件的语法格式
  • 对象
  • 数组
  • 常量
  • YAML注释
  • YAML文件注意事项：


YAML文件简介

YAML不是一种标记语言的外语缩写；但为了强调这种语言以数据做为中心，而不是以置标语言为重点，而用返璞词重新命名。它是一种直观的能够被电脑识别的数据序列化格式，是一个可读性高并且容易被人类阅读，容易和脚本语言交互，用来表达资料序列的编程语言。
它是类似于标准通用标记语言的子集XML的数据描述语言，语法比XML简单很多。
在Springboot中，推荐使用properties或者YAML文件来完成配置，但是对于较复杂的数据结构来说，YAML又远远优于properties。本文就快速介绍YAML的常见语法格式。

YAML文件的语法格式

数据结构可以用类似大纲的缩排方式呈现，结构通过缩进来表示，连续的项目通过减号“-”来表示，map结构里面的key/value对用冒号“:”来分隔。样例如下：

server:
  port: 8081
  servlet:
    context-path: /javaboy

在处理层级关系的时候，properties需要使用大量的路径来描述层级（或者属性），比如environments.dev.url和environments.dev.name。其次，对于较为复杂的结构，比如数组（my.servers），写起来更为复杂。而对应的YAML格式文件就简单很多

对象

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

key: value

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

keys:
  key1: value1
  key2: value2

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

keys: {key1: value1, key2: value2}

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

?  
    - complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2

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

数组

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

language:
	- java
	- c
	- python

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

-
	- java
	- c
	- python

可以简单理解为：[[java,c,python]]
或是相对复杂的例子

classmates: 
	-
		id: 1
		name: zhangsan
		age: 18
	-
		id: 2
		name: lisi
		age: 19

意思是classmates是一个数组，里面的元素又是有id，name，age等属性组成的
数组也可以使用流式(flow)的方式表示：

classmates: {{id: 1,name: zhangsan,age: 18},{id: 2,name: lisi, age: 19}}

常量

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: ~  #使用~表示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连接，最后使用+代表时区

YAML注释

和properties相同，使用#作为注释，YAML中只有行注释。

YAML文件注意事项：

字串不一定要用双引号标识；
在缩排中空白字符的数目并不是非常重要，只要相同阶层的元素左侧对齐就可以了（不过不能使用TAB字符）；
允许在文件中加入选择性的空行，以增加可读性；
在一个档案中，可同时包含多个文件，并用“——”分隔；
选择性的符号“…”可以用来表示档案结尾（在利用串流的通讯中，这非常有用，可以在不关闭串流的情况下，发送结束讯号）。