YAML语法简记

本文最后更新于:2020年11月19日 上午

YAML Ain’t Markup Language

基本语法规则

  • 大小写敏感
  • 使用缩进表示层级关系
  • 缩进时不允许使用Tab键,只允许使用空格
  • 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
  • #表示注释,从这个字符一直到行尾,都会被解析器忽略

基本语法

YAML uses three dashes (“—”) to separate directives from document content. This also serves to signal the start of a document. if no directives are present. Three dots ( “…”) indicate the end of a document without starting a new one, for use in communication channels.

YAML以(“—”)表示文章的开始,以(“…”)表示结束(不代表新的文章的开始)。

Structure通过空格来展示。Sequence里的项用”-“来代表,Map里的键值对用”:”分隔。

一般YAML文件扩展名为.yaml。比如:John.yaml

name: John Smith
age: 37
spouse:
  name: Jane Smith
  age: 25
children:
  - name: Jimmy Smith
    age: 15
  - name: Jenny Smith
    age: 12

John Smith今年37岁,有一个幸福的四口之家。两个孩子Jimmy 和Jenny活泼可爱。妻子Jane年轻美貌。

可见YAML的可读性是不错。

列表中的所有成员都开始于相同的缩进级别, 并且使用一个 "- " 作为开头(一个横杠和一个空格):

---
# 一个美味水果的列表
- Apple
- Orange
- Strawberry
- Mango

一个字典是由一个简单的 键: 值 的形式组成(这个冒号后面必须是一个空格):

---
# 一位职工的记录
name: Example Developer
job: Developer
skill: Elite

字典也可以使用缩进形式来表示, 如果你喜欢这样的话:

---
# 一位职工的记录
{name: Example Developer, job: Developer, skill: Elite}

可以通过以下格式来指定一个布尔值(true/fase):

---
create_key: yes
needs_agent: no
knows_oop: True
likes_emacs: TRUE
uses_cvs: false

综合以上信息:

---
# 一位职工记录
name: Example Developer
job: Developer
skill: Elite
employed: True
foods:
    - Apple    #缩进只能用空格不能用Tab
    - Orange
    - Strawberry
    - Mango
languages:
    ruby: Elite
    python: Elite
    dotnet: Lame

尽管 YAML 通常是友好的, 但是下面将会导致一个 YAML 语法错误:

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

你需要使用引号来包裹任何包含冒号的哈希值, 像这样:

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

然后这个冒号将会被结尾.

此外, Ansible 使用 “” 来引用变量. 如果一个值以 “{” 开头, YAML 将认为它是一个字典, 所以我们必须引用它, 像这样:

foo: "{{ variable }}"

三种数据结构

  1. 对象:键值对的集合,又称为映射(mapping)/ 哈希(hashes) / 字典(dictionary)
  2. 数组:一组按次序排列的值,又称为序列(sequence) / 列表(list)
  3. 纯量(scalars):单个的、不可再分的值

1. 对象

对象的一组键值对,使用冒号结构表示

animal: pets

Yaml 也允许另一种写法,将所有键值对写成一个行内对象

hash: { name: Steve, foo: bar }

2.数组

一组连词线开头的行,构成一个数组

- Cat
- Dog
- Goldfish

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

- 
 - Cat
 - Dog
 - Goldfish

数组也可以采用行内表示法。

animal: [Cat, Dog]

3. 复合结构

对象和数组可以结合使用,形成复合结构。

languages:   #数组
   - Ruby
   - Perl
   - Python
 websites:   #对象
   YAML: yaml.org
   Ruby: ruby-lang.org
   Python: python.org
   Perl: use.perl.org

4. 纯量

纯量是最基本的、不可再分的值。

  • 字符串
  • 布尔值
  • 整数
  • 浮点数
  • Null
  • 时间
  • 日期

数值直接以字面量的形式表示。

number: 12.30

{ number: 12.30 }
布尔值用true和false表示。

isSet: true

null用~表示。

parent: ~

时间采用 ISO8601 格式。

iso8601: 2001-12-14t21:59:43.10-05:00

日期采用复合 iso8601 格式的年、月、日表示。

date: 1976-07-31

YAML 允许使用两个感叹号,强制转换数据类型。

e: !!str 123
f: !!str true

5. 字符串

字符串是最常见,也是最复杂的一种数据类型。

字符串默认不使用引号表示。

str: 这是一行字符串

如果字符串之中包含空格或特殊字符,需要放在引号之中。

str: '内容:字符串'

单引号和双引号都可以使用,双引号不会对特殊字符转义。

s1: '内容\n字符串'
s2: "内容\n字符串"

单引号之中如果还有单引号,必须连续使用两个单引号转义。

str: 'labor''s day'

字符串可以写成多行,从第二行开始,必须有一个单空格缩进。换行符会被转为空格。

str: 这是一段
多行
字符串

多行字符串可以使用|保留换行符,也可以使用>折叠换行。

this: |
  Foo
  Bar
that: >
  Foo
  Bar

+表示保留文字块末尾的换行,-表示删除字符串末尾的换行。

s1: |
  Foo
s2: |+
  Foo
s3: |-
  Foo

字符串之中可以插入 HTML 标记。

message: |
<p style="color: red">
段落
</p>

6. 引用

锚点&和别名*,可以用来引用。

&用来建立锚点(defaults),<<表示合并到当前数据,*用来引用锚点。

defaults: &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

下面是另一个例子。

&showell Steve  #建立showell锚点
Clark
Brian
Oren
*showell   #引用锚点showell,即Steve

本博客所有文章除特别声明外,均采用 CC BY-SA 4.0 协议 ,转载请注明出处!