YAML 和 JSON 的区别:各自适合什么场景

YAML 和 JSON 的区别:语法、注释、数据类型和安全性有何不同,会悄悄改变数据的 YAML 陷阱,以及配置文件和 API 该选哪种格式。

阅读约 2 分钟

YAML 和 JSON 描述的是同一类数据:对象、列表、字符串、数字、布尔值和 null。要理解 yaml和json的区别,最直观的方式就是看同一份配置的两种写法:

# Service settings
name: api
port: 8080
debug: false
tags: [web, public]
database:
  host: db.internal
  pool: 10
{
  "name": "api",
  "port": 8080,
  "debug": false,
  "tags": ["web", "public"],
  "database": { "host": "db.internal", "pool": 10 }
}

主要区别

YAML JSON
结构 靠缩进(只能用空格,不能用 Tab) 靠花括号 {} 和方括号 []
注释 支持,用 # 不支持
字符串 大多可以不加引号 必须用双引号
类型 根据不加引号的值猜测 明确写出:"8080" 是字符串,8080 是数字
复用 锚点和别名(&base、*base) 没有
一个文件多份文档 支持,用 --- 分隔 不支持
规范 YAML 1.2.2(2021 年) RFC 8259

JSON 是为程序设计的:严格、精简,在哪里解析结果都一样。YAML 是为人设计的:符号少、能写注释,适合手工编辑的长文件。这道 yaml和json的区别,归根结底就是“给机器看还是给人看”。

各自用在哪里

  • JSON:Web API、package.json、浏览器存储、日志,以及程序之间交换的大部分数据。每种语言都自带 JSON 解析器。
  • YAML:Kubernetes 配置清单、GitHub Actions 和 GitLab CI 的工作流、Docker Compose、Ansible playbook,以及很多需要人手工编辑的配置文件。

YAML 的陷阱

YAML 会猜测类型,所以有些值的含义和看上去不一样。很多解析器仍然遵循旧的 YAML 1.1 规则:no、off 会变成 false,01234 会变成八进制数 668,12:30 会变成 750。就算在 YAML 1.2 里,1.10 也会变成数字 1.1。凡是必须保持文本的值,都加上引号,比如 version: "1.10"。YAML 转 JSON 工具列出了这些情况,生成 YAML 时还能自动加上引号。

另一个常见问题是缩进:少一个空格,某个键就会挂到别的父节点下面,而且不会报任何错。把文件转成 JSON 看一眼,就能知道解析器实际理解的结构是什么样的。

安全性

JSON 解析器只会生成普通数据。有些 YAML 库可以根据 !!python/object 这样的标签创建程序对象,处理不可信输入时很危险,用 PyYAML 时要用安全的加载函数(yaml.safe_load)。别名也可能被滥用,让一个很小的文件展开成几个 GB(“billion laughs”攻击),所以好的解析器都会限制别名展开。

该选哪一个

  • 程序之间交换的数据(API、消息、存储的记录)选 JSON,没有歧义,解析也快。
  • 需要人来编辑和评审的配置选 YAML,尤其是需要用注释说明“为什么这样配置”的时候。
  • 如果工具两种都支持,也可以用 YAML 编写,构建时再转换成 JSON。

任何 JSON 本身也是合法的 YAML 1.2,可以直接粘贴到 YAML 工具里。两种格式互转可以用 YAML 转 JSON 工具,整理 JSON 可以用 JSON 格式化工具。