YAML – 简介

什么是 YAML？

YAML 全称为 “YAML Ain’t Markup Language”（YAML 不是标记语言）。它是一种轻量级数据交换格式，旨在成为一种易读且容易被人类理解的数据格式。YAML 格式是面向文本的，并且在很多编程语言中都有相应的解析器和生成器。

YAML 的基本语法

YAML 主要使用空白符、缩进和一些简单的符号来表示数据的结构。在 YAML 中，缩进（空格键）是非常重要的，因为它决定了数据结构的层级。

通过下面这个例子，让我们了解一下 YAML 的基本语法：

# 这是一段 YAML 文档
# 以井号开头表示注释

# 基本数据类型
string: "Hello World"               # 字符串类型
integer: 123                        # 整数类型
float: 3.14                         # 浮点数类型
boolean: true                       # 布尔类型
null: null                          # 空值类型

# 数组类型
array:
  - item1                           # 数组元素1
  - item2                           # 数组元素2
  - item3                           # 数组元素3

# 映射类型 
mapping:
  key1: value1                      # 映射类型的键值对1
  key2: value2                      # 映射类型的键值对2
  key3: value3                      # 映射类型的键值对3

注意：YAML 中的字符串既可以使用双引号 "，也可以使用单引号 ' 来表示。

YAML 的常见应用场景

配置文件

YAML 作为一种易读且容易被人类理解的数据格式，被广泛应用于配置文件中。例如 Kubernetes 集群的配置文件就是使用 YAML 格式定义的，下面这个例子展示了一个 Kubernetes 中的 Pod 的配置文件：

apiVersion: v1
kind: Pod
metadata:
  name: nginx-pod
  labels:
    app: nginx
spec:
  containers:
    - name: nginx
      image: nginx
      ports:
        - containerPort: 80

在这个配置文件中，我们可以清晰地看到 Pod 的名称、标签、容器镜像、端口等信息。

数据交换

YAML 作为一种轻量级数据交换格式，也被广泛应用于数据交换场景。例如，我们可以使用 YAML 格式来表示 API 的请求和响应：

请求：

method: GET
path: /users
params:
  limit: 10
  offset: 0

响应：

status: 200
body:
  - id: 1
    name: Alice
    age: 20
  - id: 2
    name: Bob
    age: 25

其他场景

除了以上两个场景外，YAML 还可以被用于其他场景，例如：

• 作为一种通用的配置文件格式，被广泛应用于自动化工具中，例如 Ansible、SaltStack 等。
• 作为一种编排语言，被广泛应用于容器编排工具中，例如 Kubernetes、Docker Compose 等。

YAML 的解析与生成

在大多数编程语言中，已经有一些现成的 YAML 解析器和生成器，例如：

• Python：pyyaml 库
• Ruby：psych 库
• Java：snakeyaml 库
• JavaScript：js-yaml 库

下面这个例子展示了使用 Python 的 pyyaml 库来解析和生成 YAML 的使用方式。

解析 YAML

import yaml

# 简单的 YAML 字符串
yaml_str = """
string: "Hello World"
integer: 123
array:
  - item1
  - item2
  - item3
mapping:
  key1: value1
  key2: value2
  key3: value3
"""

# 将 YAML 字符串解析为 Python 对象
yaml_obj = yaml.load(yaml_str, Loader=yaml.Loader)

# 打印解析后的 Python 对象
print(yaml_obj)

输出结果：

{'string': 'Hello World', 'integer': 123, 'array': ['item1', 'item2', 'item3'], 'mapping': {'key1': 'value1', 'key2': 'value2', 'key3': 'value3'}}

生成 YAML

import yaml

# 将 Python 对象生成为 YAML 字符串
yaml_str = yaml.dump({
    "string": "Hello World",
    "integer": 123,
    "array": ["item1", "item2", "item3"],
    "mapping": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
    }
}, Dumper=yaml.Dumper)

# 打印生成的 YAML 字符串
print(yaml_str)

输出结果：

string: Hello World
integer: 123
array:
- item1
- item2
- item3
mapping:
  key1: value1
  key2: value2
  key3: value3

结论

YAML 作为一种易读且容易被人类理解的数据格式，被广泛应用于配置文件和数据交换场景。在大多数编程语言中，已经有一些现成的 YAML 解析器和生成器，使得我们可以轻松地在代码中处理 YAML 格式的数据。