YAML 入门教程

发布时间 2023-04-21 18:04:52作者: Mlianga
YAML

基本语法:
大小写敏感
使用缩进表示层级关系
缩进不允许使用tab,只允许使用空格
缩进的空格数不重要,只要相同层级的元素左对齐即可
# 表示注释

数据类型
YAML 支持以下集中数据类型:
对象:键值对的集合,又称为映射/哈希/字典
数组:一组按次序排列的值,又称为序列/列表
纯量:单个的、不可再分的值

YAML 对象
对象键值对使用冒号结构表示 key:value,冒号后面要加一个空格
也可以使用 key:{key1:value1,key2:value2...}
还可以使用缩进表示层级关系:
key:
child-key: value
child-key2: value2

较为复杂的对象格式,可以使用问好加一个空格代表一个复杂的key ,配合一个冒号加一个空格来表示value:
?
- complexkey1
- complexkey2
:
- complexvalue1
- complexvalue2
意思即对象的属性是一个数组[key1,key2],对应的值也是一个数组[value1,value2]

YAML 数组
以- 开头的行表示构成一个数组:
- A
- B
- C

YAML 支持多维数组,可以使用行内表示:
key:[value1,value2,...]

数据结构的子成员是一个数组,则可以在该项下面缩进一个空格
-
- A
- B
- C
一个相对复杂的例子:
companies:
-
id: 1
name: company1
price: 200w

-
id: 2
name: company2
price: 500w
意思是 companies 属性是一个数组,每一个数组元素又是由id、name、price三个属性狗策构成。
数组也可以使用流式(flow)的方式表示
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
Perl:use.perl.org
转换为json 为:
{
language: ['Ruby','Perl','Python'],
websites:{
YAML: 'yaml.org',
Ruby: 'ruby-lang.org',
Python: 'python.org',
Perl: 'user.perl.org'
}
}

纯量
纯量是最基本的,不可再分的值,包括:
字符串
布尔值
整数
浮点数
Null
时间
日期

使用一个例子来快速了解纯量的基本使用:
boolean:
- TRUE #true,True 都可以
- FALSE # false,False 都可
float:
- 3.14
- 6.2344223 # 可以使用科学计数法
int:
- 123
- 0b1010_0111_0100_1010_1110 # 二进制表示
null:
nodeName: 'node'
parent: ~ # 使用~表示 null
string:
- 哈哈
- 'hello' #可以使用双引号或单引号包裹特殊字符
- newline
newline2 # 字符串可以拆成多行,每一行会被转化成一个空格
date:
- 2018-02-17 # 日期必须使用ISO 8601 格式,即yyyy-MM-dd
datetime:
- 2018-02-17T15:02:31+08:00 #时间使用ISO 8601 格式,时间和日期之间使用T连接,最后使用+代表时区

引用
& 锚点和* 别名,可以用来引用:
default: &defaults
adapter: postgres
host: localhost

development:
database: myapp_development
<<: *defaults

test:
database: myapp_test
<<: *defaults

相当于:

defaults:
adapter: postgres
host: localhost

development:
database: myapp_development
adapter: postgres
host: localhost

test:
database: myapp_test
adapter: postgres
host: localhost

&用来建立锚点(defaults),<<表示合并到当前数据,*用来引用锚点
下面是另一个例子:
- &showell Steve
- Clark
- Brian
- Oren
- *showell

转为JavaScript 代码如下:
['Steve','Clark','Brian','Oren','Steve']