YAML 语法

本页提供有关正确 YAML 语法的基本概述，这是 Ansible 剧本（我们的配置管理语言）的表达方式。

我们使用 YAML，因为它比其他常见数据格式（如 XML 或 JSON）更易于人类阅读和编写。此外，大多数编程语言中都提供了用于处理 YAML 的库。

您可能还想同时阅读使用剧本，以了解如何在实践中使用它。

YAML 基础

对于 Ansible，几乎每个 YAML 文件都从一个列表开始。列表中的每个项目都是键值对的列表，通常称为“哈希”或“字典”。因此，我们需要了解如何在 YAML 中编写列表和字典。

YAML 还有一个小的怪癖。所有 YAML 文件（无论是否与 Ansible 相关联）都可以选择以 --- 开头，并以 ... 结尾。这是 YAML 格式的一部分，表示文档的开始和结束。

列表的所有成员都是以相同缩进级别开始的以 "- "（破折号和空格）开头的行

---
# A list of tasty fruits
- Apple
- Orange
- Strawberry
- Mango
...

字典以简单的 key: value 形式表示（冒号后面必须跟着空格）

# An employee record
martin:
  name: Martin D'vloper
  job: Developer
  skill: Elite

更复杂的数据结构是可能的，例如字典列表、值为列表的字典或两者的混合

# Employee records
- martin:
    name: Martin D'vloper
    job: Developer
    skills:
      - python
      - perl
      - pascal
- tabitha:
    name: Tabitha Bitumen
    job: Developer
    skills:
      - lisp
      - fortran
      - erlang

如果您确实想要，字典和列表也可以用简写形式表示

---
martin: {name: Martin D'vloper, job: Developer, skill: Elite}
fruits: ['Apple', 'Orange', 'Strawberry', 'Mango']

这些被称为“流集合”。

Ansible 并不经常使用这些，但您也可以指定一个布尔值（true/false）以多种形式

create_key: true
needs_agent: false
knows_oop: True
likes_emacs: TRUE
uses_cvs: false

如果您想与默认的 yamllint 选项兼容，请在字典中使用小写“true”或“false”作为布尔值。

可以使用 | 或 > 将值跨越多行。使用“文字块标量” | 跨越多行将包括换行符和任何尾随空格。使用“折叠块标量” > 将换行符折叠为空格；它用于使原本很长的行更容易阅读和编辑。在这两种情况下，缩进都将被忽略。示例如下

include_newlines: |
            exactly as you see
            will appear these three
            lines of poetry

fold_newlines: >
            this is really a
            single line of text
            despite appearances

虽然在上面的 > 示例中所有换行符都被折叠为空格，但有两种方法可以强制保留换行符

fold_some_newlines: >
    a
    b

    c
    d
      e
    f

或者，可以通过包含换行符 \n 字符来强制执行

fold_same_newlines: "a b\nc d\n  e\nf\n"

让我们将到目前为止学到的知识结合起来，在一个任意的 YAML 示例中。这与 Ansible 没什么关系，但会让你对格式有所了解

---
# An employee record
name: Martin D'vloper
job: Developer
skill: Elite
employed: True
foods:
  - Apple
  - Orange
  - Strawberry
  - Mango
languages:
  perl: Elite
  python: Elite
  pascal: Lame
education: |
  4 GCSEs
  3 A-Levels
  BSc in the Internet of Things

这就是您真正需要了解的 YAML 知识，才能开始编写 Ansible 剧本。

注意事项

虽然您几乎可以在任何非引号标量中放置任何东西，但也有一些例外。冒号后跟空格（或换行符）": " 是映射的指示符。空格后跟井号 " #" 开始注释。

因此，以下内容会导致 YAML 语法错误

foo: somebody said I should put a colon here: so I did

windows_drive: c:

… 但这会起作用

windows_path: c:\windows

您需要使用引号将哈希值括起来，使用冒号后跟空格或行尾

foo: 'somebody said I should put a colon here: so I did'

windows_drive: 'c:'

… 然后冒号将被保留。

或者，您可以使用双引号

foo: "somebody said I should put a colon here: so I did"

windows_drive: "c:"

单引号和双引号之间的区别在于，在双引号中您可以使用转义符

foo: "a \t TAB and a \n NEWLINE"

允许的转义符列表可以在 YAML 规范的“转义序列”（YAML 1.1）或“转义字符”（YAML 1.2）部分中找到。

以下 YAML 无效

foo: "an escaped \' single quote"

此外，Ansible 使用“{{ var }}”表示变量。如果冒号后的值以“{”开头，YAML 将认为它是字典，因此您必须用引号将其括起来，如下所示

foo: "{{ variable }}"

如果您的值以引号开头，则整个值必须用引号括起来，而不仅仅是部分。以下是一些有关如何正确引用内容的附加示例

foo: "{{ variable }}/additional/string/literal"
foo2: "{{ variable }}\\backslashes\\are\\also\\special\\characters"
foo3: "even if it is just a string literal it must all be quoted"

无效

foo: "E:\\path\\"rest\\of\\path

除了 ' 和 " 之外，还有许多字符是特殊的（或保留的），不能用作非引号标量的第一个字符：[] {} > | * & ! % # ` @ ,。

您还应该注意 ? : -。在 YAML 中，如果后面跟着非空格字符，则它们允许出现在字符串的开头，但 YAML 处理器实现有所不同，因此最好使用引号。

在流集合中，规则更加严格

a scalar in block mapping: this } is [ all , valid

flow mapping: { key: "you { should [ use , quotes here" }

布尔值转换很有用，但当您需要将文字 yes 或其他布尔值作为字符串时，这可能会成为问题。在这种情况下，只需使用引号即可

non_boolean: "yes"
other_string: "False"

YAML 会将某些字符串转换为浮点数，例如字符串 1.0。如果您需要指定版本号（例如，在 requirements.yml 文件中），则如果该值看起来像浮点数，则需要用引号将其括起来

version: "1.0"

另请参阅

使用剧本: 了解剧本可以做什么以及如何编写/运行它们。
YAMLLint: YAML Lint（在线）可以帮助您调试 YAML 语法，如果您遇到问题
维基百科 YAML 语法参考: 一个有关 YAML 语法的优秀指南
YAML 1.1 规范: PyYAML 和 libyaml 当前正在实现的 YAML 1.1 规范
YAML 1.2 规范: 为了完整性，YAML 1.2 是 1.1 的后继版本
沟通: 有问题？需要帮助？想分享您的想法？请访问 Ansible 沟通指南