欢迎光临
我们一直在努力

YAML 入门教程

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

YAML 是 “YAML Ain’t a Markup Language”(YAML不是一种标记语言)的递归缩写。在开发的这种语言时,YAML 的意思其实是:”Yet Another Markup Language”(仍是一种标记语言),但为了强调这种语言以数据做为中心,而不是以标记语言为重点,而用反向缩略语重命名。

YAML 配置文件的常见后缀为 .yml ,如 Jekyll 的配置文件: _config.yml

一、简介

YAML 的基本语法规则如下:

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

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

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

二、对象

对象的一组键值对,使用冒号结构表示,冒号后面要加一个空格

animal: pets

与之对应的 JavaScript 对象如下:

{ animal: 'pets' }

YAML 也支持将所有键值对写成一个行内对象。

hash: { name: Steve, foo: bar }

与之对应的 JavaScript 对象如下:

{ hash: { name: 'Steve', foo: 'bar' } }

三、数组

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

- Cat
- Dog
- Goldfish

与之对应的 JavaScript 对象如下:

[ 'Cat', 'Dog', 'Goldfish' ]

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

animal: [Cat, Dog]

与之对应的 JavaScript 对象如下:

{ animal: [ 'Cat', 'Dog' ] }

四、纯量

纯量是最基本的、不可再分的值。以下数据类型都属于纯量。

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

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

number: 12.30

布尔值用 truefalse 表示。

isSet: true

null~ 表示。

parent: ~ 

时间采用 ISO8601 格式。

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

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

date: 1976-07-31

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

五、字符串

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

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

str: 这是一行字符串

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

str: '内容: 字符串'

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

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

与之对应的 JavaScript 对象如下:

{ s1: '内容\\n字符串', s2: '内容\n字符串' }

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

str: 'labor''s day' 

与之对应的 JavaScript 对象如下:

{ str: 'labor\'s day' }

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

str: 这是一段
  多行
  字符串

与之对应的 JavaScript 对象如下:

{ str: '这是一段 多行 字符串' }

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

this: |
  Foo
  Bar
that: >
  Foo
  Bar

与之对应的 JavaScript 对象如下:

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

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

s1: |
  Foo

s2: |+
  Foo


s3: |-
  Foo

与之对应的 JavaScript 对象如下:

{ s1: 'Foo\n', s2: 'Foo\n\n\n', s3: 'Foo' }

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

message: |

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

与之对应的 JavaScript 对象如下:

{ message: '\n<p style="color: red">\n  段落\n</p>\n' }

六、复合结构

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

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

与之对应的 JavaScript 对象如下:

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

七、强制转换

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

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

与之对应的 JavaScript 对象如下:

{ e: '123', f: 'true' }

八、引用

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

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

下面是另一个例子:

- &showell Steve 
- Clark 
- Brian 
- Oren 
- *showell 

与之对应的 JavaScript 对象如下:

[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]

赞(0) 打赏
未经允许不得转载:码农很忙 » YAML 入门教程

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

微信扫一扫打赏