YAML入门

当前YAML 官网对于YAML的定义是 "YAML Ain't a Markup Language" （YAML 不是一种标记语言）。但是其实YAML最初的含义是 "Yet Another Markuo Language" 。 在YAML的官网上对于什么是YAML有两个解释：

  • YAML is a human-friendly data serialization（YAML是一种人类相对友好的数据序列化语言）

  • language for all programming languages（所有编程语言都可以使用的语言）

YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。

YAML 的配置文件后缀为 .yml，如：ansible_playbook.yml 。

基本语法

  • 大小写敏感

如字面上的意思，下面的例如它不会有格式错误。

One: 1
one: 2
  • 使用缩进表示层级关系

缩进的空格数不重要，只要相同层级的元素左对齐即可

缩进不允许使用tab，只能使用空格

# YAML
one:
  two: 2
  three:
    four: 4
    five: 5

// 以上的内容转成 JSON 后
"one": {
  "two": 2,
  "three": {
    "four": 4,
    "five": 5 
  }
}
  • # 表示注释
# 这是一条注释
# 这是另外一条注释

数据类型

YAML支持以下几种数据类型：

  • 对象：键值对的几何，又称为映射（mapping）/哈希（hashes）/字典（dictionary）
  • 数组：一组按次序排列的值，又称为序列（sequence）/列表（list）
  • 纯量（scalars）：单个的、不可再分的值

YAML对象（Mapping）

对象键值对使用冒号结构表示 key: value ，冒号后面要加一个空格。

也可以使用 key:(key1: value1, key2: value2, ...)。

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

key:
  child-key: value
  child-key2: value2

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

? 
  - complexkey1
  - complexkey2
: 
  - complexvalue1
  - complexvalue2

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

YAML 数组（Sequence）

以 - 开头的行表示构成一个数组：

- A
- B
- C

YAML 支持多维数组，可以使用行内表示：

key: [value1, vlaue2, ...]

数据结构的子成员是一个数组，则可以在该项下面缩进一个空格。

-
 - A
 - B
 - C

一个相对复杂的例子：

companies：
  -
    id: 1
    name: company1
    price: 2 millon
  -
    id: 2
    name: company2
    price: 5 millon

意思就是 companies 属性是一个数组，每一个数组中的袁术又是由 id、name、 price 三个属性构成。

数组也可以使用流式（flow）的方式表示：

companies: [{id: 1, name: company1, price: 2 millon},{id: 2, name: company2, price: 5 millon}]

复合结构

数组和对象可以构成复合结构，例：

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'
  }
}

纯量（scalars）

纯量是最基本的，不可再分的值，包括：

  • 字符串（String）
  • 布尔值（Boolean）
  • 整数（Integer）
  • 浮点数（Float）
  • 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:
  - haha
  - 'Hello world'   #可以使用双引号或者单引号包裹特殊字符
  - newline
    newline2                # 字符串可以拆分成多行，每一行会被转化成一个空格

date:
  - 2024-02-29      # 日期的格式必须是 ISO8601 格式，即 yyyy-MM-dd

datetime:
  - 2024-02-29T15:23:38+08:00   # 日期和时间都是使用ISO8601格式，时间和日期之间使用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官网：https://yaml.org/
  • YAML to JSON在线格式转换：https://www.bairesdev.com/tools/json2yaml/