阅读 102

YAML

本文转自 阮一峰:YAML 语言教程

编程免不了要写配置文件,怎么写配置也是一门学问。

YAML 是专门用来写配置文件的语言,非常简洁和强大,远比 JSON 格式方便。本文以 JS-YAML 的实现为例。文中示例可用 在线演示 来验证。

简介

YAML 语言(发音 /ˈjæməl/ )的设计目标,就是方便人类读写。它实质上是一种通用的数据串行化格式,如果不你喜欢缩进形式的编写,那怕是要忍受一段时间了,或者可以继续不使用 YAML。

基本语法规则如下

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

数据结构

  • 对象:键值对的集合,又称为映射(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' ]
复制代码

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

-
 - Cat
 - Dog
 - Goldfish
复制代码

转为 JavaScript :

[ [ 'Cat', 'Dog', 'Goldfish' ] ]
复制代码

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

animal: [Cat, Dog]
复制代码

转为 JavaScript :

{ animal: [ 'Cat', 'Dog' ] }
复制代码

复合结构

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

languages:
 - React
 - Vue
 - Angular
websites:
 YAML: yaml.org
 React: reactjs.org
 Vue: cn.vuejs.org
 Angular: angular.cn
复制代码

转为 JavaScript :

{ languages: [ 'React', 'Vue', 'Angular' ],
  websites: 
   { YAML: 'yaml.org',
     React: 'reactjs.org',
     Vue: 'cn.vuejs.org',
     Angular: 'angular.cn' } }
复制代码

纯量

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

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

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

number: 10.01
复制代码

转为 JavaScript :

{ number: 10.01 }
复制代码

布尔值用 truefalse 表示。

isSet: true
复制代码

转为 JavaScript :

{ isSet: true }
复制代码

null~ 表示。

parent: ~ 
复制代码

转为 JavaScript :

{ parent: null }
复制代码

时间采用 ISO8601 格式。

iso8601: 2020-03-21t08:08:08.10-05:00 
复制代码

转为 JavaScript :

{ iso8601: new Date('2020-03-21t08:08:08.10-05:00') }
复制代码

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

date: 2020-03-21
复制代码

转为 JavaScript :

{ date: new Date('2020-03-21') }
复制代码

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

e: !!str 123
f: !!str true
复制代码

转为 JavaScript :

{ e: '123', f: 'true' }
复制代码

字符串

字符串是最常见也是最复杂的一种数据类型。字符串默认不使用引号表示。

str: 这是一行字符串
复制代码

转为 JavaScript :

{ str: '这是一行字符串' }
复制代码

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

str: '内容: 字符串'
复制代码

转为 JavaScript :

{ 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>
    段落
  </p>
复制代码

转为 JavaScript :

{ message: '\n<p>\n  段落\n</p>\n' }
复制代码

引用

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

defaults: &defaults
  adapter:  adapter
  host:     localhost

development:
  database: myapp_development
  <<: *defaults

test:
  database: myapp_test
  <<: *defaults
复制代码

等同于下面的代码。

{ defaults: { adapter: 'adapter', host: 'localhost' },
  development: 
   { database: 'myapp_development',
     adapter: 'adapter',
     host: 'localhost' },
  test: { database: 'myapp_test', adapter: 'adapter', host: 'localhost' } }
复制代码
  • & 用来建立锚点(defaults
  • << 表示合并到当前数据
  • * 用来引用锚点

下面是另一个例子。

- &show React
- Vue
- Angular
- *show
复制代码

转为 JavaScript 代码如下。

[ 'React', 'Vue', 'Angular', 'React' ]
复制代码

函数和正则表达式的转换

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

# demo.yml
fn: function () { return 1 }
reg: /test/
复制代码

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

// demo.js
const fs   = require('fs');
const yaml = require('js-yaml');

try {
  var doc = yaml.load(
    fs.readFileSync('./demo.yml', 'utf8')
  );
  console.log(doc);
} catch (e) {
  console.log(e);
}
复制代码

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

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

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

try {
  fs.writeFileSync('./demo.yml', yaml.dump(obj), 'utf8');
} catch (e) {
  console.log(e);
}
复制代码

阅读文章或评论

参考链接

文末

加我引进群

编程之上