FreezeJ' Blog

YAML语法

2019-05-09

YAML语法

很多地方都会使用YAML作为配置文件,如filebeat配置、Ansible、Salt等,本文整理了YAML的部分语法,作为参考,方便查阅。

转自http://www.ruanyifeng.com/blog/2016/07/yaml.html,略有补充和修改。

YAML 语言(发音 /ˈjæməl/ )的设计目标,就是方便人类读写。它实质上是一种通用的数据串行化格式。

YAML 还有一个小的怪癖. 所有的 YAML 文件(无论和 Ansible 有没有关系)开始行都应该是 . 这是 YAML 格式的一部分, 表明一个文件的开始.

基本语法

  • 大小写敏感

  • 使用缩进表示层级关系

  • 缩进时不允许使用Tab键,只允许使用空格

  • 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可

  • # 表示注释,从这个字符一直到行尾,都会被解析器忽略。

数据结构

YAML 支持的数据结构有三种:

对象:键值对的集合,又称为映射(mapping)/ 哈希(hashes) / 字典(dictionary)

数组:一组按次序排列的值,又称为序列(sequence) / 列表(list)

纯量(scalars):单个的、不可再分的值

对象

注意对象后面没有引号,有引号为字符串

animal : pets

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

hash: { name: Steve, foo: bar }

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

# 一位职工的记录

{name: Example Developer, job: Developer, skill: Elite}

数组

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

- Cat

- Dog

- Goldfish

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

animal: [Cat, Dog]

复合结构

languages:
  - Ruby
  - Perl
  - Python 

websites:
  YAML: yaml.org 
  Ruby: ruby-lang.org 
  Python: python.org 
  Perl: use.perl.org 

对应:

{ 
  languages: [ 'Ruby', 'Perl', 'Python' ],
  websites: {
     YAML: 'yaml.org',
     Ruby: 'ruby-lang.org',
     Python: 'python.org',
     Perl: 'use.perl.org' 
     }
}

注意:左对齐的都是同一层级的,不是单独的。

纯量

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

纯量包括:

  • 字符串

  • 布尔值 isSet: true

  • 整数 number: 12

  • 浮点数 number: 12.30

  • Null null用~表示:parent: ~

  • 时间 时间采用 ISO8601 格式:iso8601: 2001-12-14t21:59:43.10-05:00

  • 日期 日期采用复合 iso8601 格式的年、月、日表示:date: 1976-07-31

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

e: !!str 123

f: !!str true

字符串

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

str: ‘labor’’s day’

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

this: |
  Foo
  Bar

that: >
  Foo
  Bar

结果:

{ this: 'Foo\nBar\n', that: 'Foo Bar\n' }

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

s1: |
  Foo

s2: |+
  Foo

s3: |-
  Foo

结果:

{ s1: ‘Foo\n’, s2: ‘Foo\n\n\n’, s3: ‘Foo’ }

&用来建立锚点(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  # 这里使用default替换并插入
  host:     localhost

test:
  database: myapp_test
  adapter:  postgres     # 这里使用default替换并插入
  host:     localhost
Tags: Other
使用支付宝打赏
使用微信打赏

若你觉得我的文章对你有帮助,欢迎点击上方按钮对我打赏