Yaml语法介绍

简介

YAML 是 “YAML Ain’t a Markup Language”（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）。

YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。

YAML 有一个小的怪癖。所有的 YAML 文件开始行都应该是 —。这是 YAML 格式的一部分, 表明一个文件的开始。

它的基本语法规则如下。

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

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

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

以下分别介绍这三种数据结构。

对象

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

1

animal: pets

转为 JavaScript 如下。

1

{ animal: 'pets' }

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

1

hash: { name: Steve, foo: bar }

转为 JavaScript 如下。

1

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

还可以使用缩进表示层级关系；

1
2
3


key:
    child-key: value
    child-key2: value2

较为复杂的对象格式，可以使用问号加一个空格代表一个复杂的 key，配合一个冒号加一个空格代表一个 value：

1
2
3
4
5
6


?
    - complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2

意思即对象的属性是一个数组 [complexkey1,complexkey2]，对应的值也是一个数组 [complexvalue1,complexvalue2]

数组

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

1
2
3


- Cat
- Dog
- Goldfish

转为 JavaScript 如下。

1

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

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

1
2
3
4


-
  - Cat
  - Dog
  - Goldfish

转为 JavaScript 如下。

1

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

数组也可以采用行内(或者流式)表示法。

1
2


services: [FTP, SSH]
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]

转为 JavaScript 如下:

1
2
3
4


{ services: [ 'FTP', 'SSH' ] }
{ companies:
   [ { id: 1, name: 'company1', price: '200W' },
     { id: 2, name: 'company2', price: '500W' } ] }

一个相对复杂的例子：

1
2
3
4
5
6
7
8
9


companies:
    -
        id: 1
        name: company1
        price: 200W
    -
        id: 2
        name: company2
        price: 500W

意思是 companies 属性是一个数组，每一个数组元素又是由 id、name、price 三个属性构成。

数组也可以使用流式(flow)的方式表示：

1

companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]

复合结构

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

1
2
3
4
5
6
7
8
9


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

转为 JavaScript 如下。

1
2
3
4
5
6


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

纯量

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

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

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27


boolean:
    - TRUE  #true,True都可以
    - FALSE  #false，False都可以
float:
    - 3.14
    - 6.8523015e+5  #可以使用科学计数法
int:
    - 123
    - 0b1010_0111_0100_1010_1110    #二进制表示
    - 014 #八进制整数
    - 0xC #十六进制整数
    - 1.2e+34 #指数
null:
    nodeName: 'node'
    parent: ~  #null或~表示
string:
    - 哈哈 # 字符串默认不使用引号表示。如果不加引号将会转义特殊字符，当成字符串处理
      # 可以使用双引号或者单引号包裹特殊字符,如果字符串之中包含空格或特殊字符，需要放在引号之中。
    - '内容\n字符串'  # 单引号会将字符串里面的特殊字符转义为字符串处理
    - "内容\n字符串" # 双引号不会对特殊字符转义。
    - 'labor''s day' # 单引号之中如果还有单引号，必须连续使用两个单引号转义。
    - newline
      newline2    #字符串可以写成多行，从第二行开始，必须有一个缩进。换行符会被转为空格。
date:
    - 2018-02-17    #日期必须使用ISO 8601格式，即yyyy-MM-dd
datetime:
    -  2018-02-17T15:02:31+08:00    #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区

转为 JavaScript 如下:

1
2
3
4
5
6
7


{ boolean: [ true, false ],
  float: [ 3.14, 685230.15 ],
  int: [ 123, 685230 ],
  null: { nodeName: 'node', parent: null },
  string: [ '哈哈', '内容\\n字符串', '内容\n字符串','labor\'s day','newline newline2' ],
  date: [ Sat Feb 17 2018 08:00:00 GMT+0800 (中国标准时间) ],
  datetime: [ Sat Feb 17 2018 15:02:31 GMT+0800 (中国标准时间) ] }

特殊符号

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

1
2


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

转为 JavaScript 如下:

1

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


!!int # 整数类型
!!float # 浮点类型
!!bool # 布尔类型
!!str # 字符串类型
!!binary # 也是字符串类型
!!timestamp # 日期时间类型
!!null # 空值
!!set # 集合
!!omap,!!pairs # 键值列表或对象列表
!!seq # 序列，也是列表 !!map # 键值表

2、 … 和—配合使用，在一个配置文件中代表一个文件的结束：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


---
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
---

time: 20:03:47
player: Sammy Sosa
action: grand slam
...

3、>在字符串中折叠换行，| 保留换行符，这两个符号是YAML中字符串经常使用的符号，比如：

使用|标注的文本内容缩进表示的块，可以保留块中已有的回车换行

使用 > 标注的文本内容缩进表示的块，将块中回车替换为空格，最终连接成一行

1
2
3
4
5
6


this: |
  Foo
  Bar  
that: >
  Foo
  Bar  

转为 JavaScript 如下:

1

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

注意 “|” 与文本之间须另起一行

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

1
2
3
4
5
6
7
8


s1: |
    Foo

s2: |+
    Foo

s3: |-
    Foo

转为 JavaScript 代码如下。

1

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

4、引用。重复的内容在YAML中可以使用&来完成锚点定义，使用*来完成锚点引用，例如：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


defaults: &defaults
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  <<: *defaults

test:
  database: myapp_test
  <<: *defaults

等同于下面的代码。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


defaults:
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  adapter:  postgres
  host:     localhost

test:
  database: myapp_test
  adapter:  postgres
  host:     localhost

&用来建立锚点（defaults），«表示合并到当前数据，*用来引用锚点。

下面是另一个例子。

1
2
3
4
5


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

转为 JavaScript 代码如下。

1

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

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

1
2
3
4
5


message: |

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

转为 JavaScript 如下。

1

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

函数和正则表达式的转换

这是 JS-YAML 库特有的功能，可以把函数和正则表达式转为字符串。

1
2
3


# example.yml
fn: function () { return 1 }
reg: /test/

解析上面的 yml 文件的代码如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


var yaml = require('js-yaml');
var fs   = require('fs');

try {
  var doc = yaml.load(
    fs.readFileSync('./example.yml', 'utf8')
  );
  console.log(doc);
} catch (e) {
  console.log(e);
}

从 JavaScript 对象还原到 yaml 文件的代码如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


var yaml = require('js-yaml');
var fs   = require('fs');

var obj = {
  fn: function () { return 1 },
  reg: /test/
};

try {
  fs.writeFileSync(
    './example.yml',
    yaml.dump(obj),
    'utf8'
  );
} catch (e) {
  console.log(e);
}

参考

YAML 语言教程 YAML 入门教程 YAML语法介绍

文章目录

简介

对象

数组

复合结构

纯量

特殊符号

函数和正则表达式的转换

参考