yaml教程笔记

2026-05-18 17:56 技术

YAML 的意思其实是:"Yet Another Markup Language"(仍是一种标记语言)。 YAML 的语法和其他高级语言类似,并且可以简单表达清单、散列表,标量等数据形态。 它使用空白符号缩进和大量依赖外观的特色,特别适合用来表达或编辑数据结构、 各种配置文件、倾印调试内容、文件大纲。 YAML 的配置文件后缀为 .yml。


基本语法

YAML 的设计初衷是去繁就简,去掉了 JSON 中繁琐的引号、大括号以及 XML 中的冗余标签。在编写 YAML 时

  • 大小写敏感
  • 使用缩进表示层级关系
  • 缩进不允许使用 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

复合结构 数组和对象可以构成复合结构,例:

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),<< 表示合并到当前数据,* 用来引用锚点。


兼容性

YAML 是 JSON 的超集,这意味着所有合法的 JSON 文件都是有效的 YAML 文件。 YAML 在完全兼容 JSON 的基础上, 提供了更丰富的语法糖(如锚点引用 & 和 * 来复用重复数据),这是 JSON 无法实现的。

主流应用场景

凭借其清晰的层级结构和声明式特性,YAML 已成为现代软件工程,尤其是云原生领域的事实标准:

  • DevOps 与云原生编排: Kubernetes 使用 YAML 文件作为资源清单(如 Deployment、Service), 用于声明容器化应用的期望状态;Docker Compose 通过 docker-compose.yml 定义和运行多容器应用。
  • CI/CD 流水线配置: GitHub Actions、GitLab CI 等持续集成/持续交付工具, 均使用 YAML 文件来定义自动化工作流的步骤与触发条件。
  • 后端应用配置: Spring Boot 等主流框架默认支持 application.yml 作为配置文件。 相比传统的 .properties 文件,YAML 能通过缩进清晰展现配置的父子层级, 避免了大量重复的前缀,极大提升了配置的可维护性。
  • 自动化运维: Ansible 使用被称为 Playbook 的 YAML 文件来定义自动化任务和部署流程, 让非开发人员也能轻松理解并编写自动化脚本。