YAML(YML)——入门
YAML是"YAML Ain’t a Markup Language"(YAML不是一种标记语言)的递归缩写;是一个可读性高,用来表达数据序列化的格式。YAML的应用场景之一是作为SpringBoot的配置文件。
一、YAML和properties对比
说到SpringBoot的配置文件,那就不得不提起SpringBoot推荐使用的properties,下面我们通过一个简单的例子来看一下两者的区别:
- properties
environments.dev.url=http://dev.bar.com
environments.dev.name=Developer Setup
environments.prod.url=http://foo.bar.com
environments.prod.name=My Cool App
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com
- YAML
environments:
dev:
url: http://dev.bar.com
name: Developer Setup
prod:
url: http://foo.bar.com
name: My Cool App
my:
servers:
- dev.bar.com
- foo.bar.com
- 通过简单的对比,我们不难发现:在层级关系上,properties需要使用完整的路径来表示;在较为复杂的结构,例如数组上,格式也是较为繁琐。而YAML则是使用冒号加缩进的方式代表层级关系,使用短横杠(-)代表数组元素,书写起来相对简便,视觉上也较为直观。
二、YAML的基本使用
下面介绍YAML的基本格式要求、注释的使用、YAML中允许表示三种格式(常量值,对象和数组)和一些特殊的符号的使用。
1. 基本的格式要求
- YAML大小写敏感
- 使用缩进代表层级关系,缩进只能使用空格,不能使用TAB,不要求空格个数,只需要相同层级左对齐(一般2个或4个空格)
2. 注释
- YAML使用#作为注释,特别的是YAML中只有行注释。
3. 常量值
- 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连接,最后使用+代表时区
4. 对象
- 使用冒号代表,格式为key: value。冒号后面要加一个空格
key: value
- 可以使用缩进表示层级关系
key:
child-key: value
child-key2: value2
//特别的,YAML中还支持流式(flow)语法表示对象
key: {child-key: value, child-key2: value2}
- 较为复杂的对象格式,可以使用问号加一个空格代表一个复杂的key,配合一个冒号加一个空格代表一个value
?
- complexkey1
- complexkey2
:
- complexvalue1
- complexvalue2
//意思即对象的属性是一个数组[complexkey1,complexkey2],
//对应的值也是一个数组[complexvalue1,complexvalue2]
5. 数组
- 使用一个短横线加一个空格代表一个数组项
hobby:
- Java
- LOL
//另一种写法,[[Java,LOL]]
-
- Java
- LOL
//更复杂的,companies属性是一个数组,每一个数组元素又是由id,name,price三个属性构成;
companies:
-
id: 1
name: company1
price: 200W
-
id: 2
name: company2
price: 500W
//数组也可以使用流式(flow)的方式表示:
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]
6. 特殊符号
- 在同一个文件中使用三减号 — 表示一个文档的开始或者分割不同的内容
//代表定义了两个profile,一个是development,一个production
server:
address: 192.168.1.100
---
spring:
profiles: development
server:
address: 127.0.0.1
---
spring:
profiles: production
server:
address: 192.168.1.120
//记录日志中分割不同的内容
---
Time: 2018-02-17T15:02:31+08:00
User: ed
Warning:
This is an error message for the log file
---
Time: 2018-02-17T15:05:21+08:00
User: ed
Warning:
A slightly different error message.
- … 和—配合使用,在一个配置文件中代表一个文件的结束
---
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
---
- 使用!!做类型强行转换
string:
- !!str 54321
- !!str true
//相当于把数字和布尔类型强转为字符串
- 在字符串中 >折叠换行符,| 保留换行符
accomplishment: >
Mark set a major league
home run record in 1998.
stats: |
65 Home Runs
0.278 Batting Average
//输出:
accomplishment=Mark set a major league home run record in 1998.
//即将换行符转化成了空格;要注意一点的是,每行的文本前一定要有一个空格。
stats=65 Home Runs
0.278 Batting Average
//即| 符号保留了换行符
- 重复的内容在YAML中可以使用&来完成锚点定义,使用*来完成锚点引用
hr:
- Mark McGwire
- &SS Sammy Sosa
rbi:
- *SS
- Ken Griffey
//结果为:
{hr=[Mark McGwire, Sammy Sosa],rbi=[Sammy Sosa, Ken Griffey]}
- <<和锚点配合使用,可以将一个锚点内容直接合并到一个对象中。
merge:
- &CENTER { x: 1, y: 2 }
- &LEFT { x: 0, y: 2 }
- &BIG { r: 10 }
- &SMALL { r: 1 }
sample1:
<<: *CENTER
r: 10
sample2:
<< : [ *CENTER, *BIG ]
other: haha
sample3:
<< : [ *CENTER, *BIG ]
r: 100
//结果
//1. 引用{x: 1,y: 2},并且合并到sample1中
sample1={r=10, y=2, x=1}
//2.联合引用{x: 1,y: 2}和{r: 10},并且合并到sample2中
sample2={other=haha, x=1, y=2, r=10}
//3.引入了*CENTER, *BIG,还使用了r: 100覆盖了引入的r: 10
sample3={r=100, y=2, x=1}