YAML的常用语法

字数统计: 1.8k字   |   阅读时长≈ 7分

摘要：主要介绍YAML的常用语法

前言：上一篇文章我们已经学会了一些基本美化博客的技巧，接下来我们将学习YAML的常用语法。

YAML

YAML介绍

诞生

YAML参考了其他多种语言，包括：XML、C语言、Python、Perl以及电子邮件格式RFC2822。Clark Evans在2001年5月在首次发表了这种语言，另外Ingy döt Net与Oren Ben-Kiki也是这语言的共同设计者。

命名

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

功能

YAML的语法和其他高阶语言类似，并且可以简单表达清单、散列表，标量等资料形态、。它使用空白符号缩排和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种设定档、倾印除错内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。尽管它比较适合用来表达阶层式（hierarchical model）的数据结构，不过也有精致的语法可以表示关联性（relational model）的资料。由于YAML使用空白字符和分行来分隔资料，使得它他特别适合用grep、Python、Perl、Ruby操作。其让人最容易上手的特色是巧妙避开各种封闭符号，如：引号、各种括号等，这些符号在嵌套结构中会变得复杂而难以辨认。

它的基本语法规则如下：

1
2
3
4
- 大小写敏感。
- 使用缩进表示层级关系。
- 缩进时不允许使用Tab键，只允许使用空格。
- 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可。

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

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

1
2
3
- 对象：键值对的集合，又称为映射（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
- Cat
- Dog
- Goldfish

转为 JavaScript 如下：

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

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

1
2
3
4
-
 - Cat
 - Dog
 - Goldfish

转为 JavaScript 如下：

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

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

1
animal: [Cat, Dog]

转为 JavaScript 如下：

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

复合结构

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

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 的纯量:

1
2
3
4
5
6
7
字符串
布尔值
整数
浮点数
Null
时间
日期

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

1
number: 12.30

转为 JavaScript 如下：

1
{ number: 12.30 }

布尔值用true和false表示：

1
isSet: true

转为 JavaScript 如下：

1
{ isSet: true }

null用~表示：

1
parent: ~

转为 JavaScript 如下：

1
{ parent: null }

时间采用 ISO8601 格式：

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

转为 JavaScript 如下：

1
{ iso8601: new Date('2001-12-14t21:59:43.10-05:00') }

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

1
date: 1976-07-31

转为 JavaScript 如下：

1
{ date: new Date('1976-07-31') }

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

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

转为 JavaScript 如下：

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

字符串

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

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

1
str: 这是一行字符串

转为 JavaScript 如下：

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

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

1
str: '内容： 字符串'

转为 JavaScript 如下：

1
{ str: '内容: 字符串' }

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

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

转为 JavaScript 如下：

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

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

1
str: 'labor''s day'

转为 JavaScript 如下：

1
{ str: 'labor\'s day' }

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

1
2
3
str: 这是一段
  多行
  字符串

转为 JavaScript 如下：

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

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

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
9
s1: |
  Foo

s2: |+
  Foo


s3: |-
  Foo

转为 JavaScript 如下：

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

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

1
2
3
4
5
message: |

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

转为 JavaScript 代码如下：

1
{ 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

等同于下面的代码：

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' ]

函数和正则表达式的转换

这是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);
}

扫一扫，分享到微信

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia-plus根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

教练，我想学技术！
我主要是以后端技术为主，偶尔看看网络安全相关的内容，或者编写一些有趣的脚本！