YMAL 语言学习

参考:阮一峰的网络日志 - YAML 语言教程

YAML 是专门用来写配置文件的语言,非常简洁和强大,远比 JSON 格式方便,也类似于标准通用标记语言的子集XML的数据描述语言,语法比XML简单很多。

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

基本语法

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

数据结构

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

比对 YAML 和 Javascript

YAML 转换 Javascript

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

    1
    2
    3
    4
    5
    animal: pets
    out~ { animal: 'pets' }
    # 行内对象
    hash: { name: Steve, foo: bar }
    out~ { hash: { name: 'Steve', foo: 'bar' } }
  2. 一组连词线开头的行,构成一个数组

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    - Cat
    - Dog
    - Goldfish
    out~ [ 'Cat', 'Dog', 'Goldfish' ]
    # 数据结构的子成员是一个数组,则可以在该项下面缩进一个空格。
    -
    - Cat
    - Dog
    - Goldfish
    out~ [ [ 'Cat', 'Dog', 'Goldfish' ] ]
    # 行内表示法
    animal: [Cat, Dog]
    out~ { animal: [ 'Cat', 'Dog' ] }
  3. 对象和数组可以结合使用,形成复合结构

    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
    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' } }
  4. 纯量是最基本的、不可再分的值。以下数据类型都属于 JavaScript 的纯量。

    • 字符串 - 字符串默认不使用引号表示。
    • 布尔值 - 布尔值用true和false表示
    • 整数 - 数值直接以字面量的形式表示
    • 浮点数
    • Null - # null用~表示
    • 时间 - 时间采用 ISO8601 格式
    • 日期 - 日期采用复合 iso8601 格式的年、月、日表示。

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

    1
    2
    e: !!str 123
    f: !!str true

字符串

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

1
2
3
# 字符串默认不使用引号表示。
str: 这是一行字符串
out~ { str: '这是一行字符串' }
1
2
3
# 如果字符串之中包含空格或特殊字符,需要放在引号之中。
str: '内容: 字符串'
out~ { str: '内容: 字符串' }
1
2
3
4
# 单引号和双引号都可以使用,双引号不会对特殊字符转义。
s1: '内容\n字符串'
s2: "内容\n字符串"
out~ { s1: '内容\\n字符串', s2: '内容\n字符串' }
1
2
3
# 单引号之中如果还有单引号,必须连续使用两个单引号转义。
str: 'labor''s day'
out~ { str: 'labor\'s day' }
1
2
3
4
5
# 字符串可以写成多行,从第二行开始,必须有一个单空格缩进。换行符会被转为空格。
str: 这是一段
多行
字符串
out~ { str: '这是一段 多行 字符串' }
1
2
3
4
5
6
7
8
# 多行字符串可以使用|保留换行符,也可以使用>折叠换行。
this: |
Foo
Bar
that: >
Foo
Bar
out~ { this: 'Foo\nBar\n', that: 'Foo Bar\n' }
1
2
3
4
5
6
7
8
9
10
11
# +表示保留文字块末尾的换行,-表示删除字符串末尾的换行。
s1: |
Foo
s2: |+
Foo
s3: |-
Foo
out~ { s1: 'Foo\n', s2: 'Foo\n\n\n', s3: 'Foo' }
1
2
3
4
5
6
7
# 字符串之中可以插入 HTML 标记。
message: |
<p style="color: red">
段落
</p>
out~ { message: '\n<p style="color: red">\n 段落\n</p>\n' }

引用

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

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

&用来建立锚点(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

另一种写法:

1
2
3
4
5
- &showell Steve
- Clark
- Brian
- Oren
- *showell

等同于

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