一文快速掌握 YAML 文件
一文快速掌握 YAML 文件
YAML（YAML Ain't a Markup Language）是一种人类可读的数据序列化语言，广泛应用于配置文件、数据交换等场景。本文将从基础语法到高级特性，全面介绍YAML的核心概念和使用方法。
一、前言
YAML（/ˈjæməl/，尾音类似camel骆驼）是
"YAML Ain't a Markup Language"
（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML的意思其实是：
"Yet Another Markup Language"
（仍是一种标记语言）。
YAML的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。
YAML的配置文件后缀为
.yml
，如：demo.yml 。
二、基本语法
- 大小写敏感
- 使用缩进表示层级关系
- 缩进不允许使用
tab
，只允许空格 - 缩进的空格数不重要，只要相同层级的元素左对齐即可
- '#'
表示注释
三、数据类型
YAML支持以下几种数据类型：
- 对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
- 数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
- 纯量（scalars）：单个的、不可再分的值
四、YAML 对象
对象键值对使用冒号结构表示
key: value
，冒号后面要加一个空格。
也可以使用
key:{key1: value1, key2: value2, ...}
。
还可以使用缩进表示层级关系；
key:
child-key: value
child-key2: value2
较为复杂的对象格式，可以使用问号加一个空格代表一个复杂的
key
，配合一个冒号加一个空格代表一个 value：
?
- complexkey1
- complexkey2
:
- complexvalue1
- complexvalue2
意思即对象的属性是一个数组
[complexkey1,complexkey2]
，对应的值也是一个数组
[complexvalue1,complexvalue2]
五、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
Python: python.org
Perl: use.perl.org
转换为
json
为：
{
languages: [ 'Ruby', 'Perl', 'Python'],
websites: {
YAML: 'yaml.org',
Ruby: 'ruby-lang.org',
Python: 'python.org',
Perl: 'use.perl.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连接，最后使用+代表时区
八、引用
&
锚点和
- 别名，可以用来引用:
defaults: &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' ]
九、总结
YAML的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。尽管它比较适合用来表达层次结构式（hierarchical model）的数据结构，不过也有精致的语法可以表示关系性（relational model）的数据。由于YAML使用空白字符和分行来分隔数据，使得它特别适合用
grep/Python/Perl/Ruby
操作。其让人最容易上手的特色是巧妙避开各种封闭符号，如：引号、各种括号等，这些符号在嵌套结构时会变得复杂而难以辨认。