.yaml 文件格式简介

YAML 的意思其实是："Yet Another Markup Language"（仍是一种置标语言）的缩写。

功能

YAML的语法和其他高阶语言类似，并且可以简单表达清单、散列表，标量等资料形态、。

它使用空白符号缩排和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种设定档、倾印除错内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。

尽管它比较适合用来表达阶层式（hierarchical model）的数据结构，不过也有精致的语法可以表示关联性（relational model）的资料。

由于YAML使用空白字符和分行来分隔资料，使的他特别适合用 grep、Python、Perl、Ruby 操作。

其让人最容易上手的特色是巧妙避开各种封闭符号，如：引号、各种括号等，这些符号在嵌套结构中会变得复杂而难以辨认。

格式

多行缩进

数据结构可以用类似大纲的缩排方式呈现，结构通过缩进来表示，连续的项目通过减号“-”来表示，map 结构里面的 key/value 对用冒号“:”来分隔。样例如下：

house:

family:

name: Doe

parents:

- John

- Jane

children:

- Paul

- Mark

- Simone

address:

number: 34

street: Main Street

city: Nowheretown

zipcode: 12345

注意：

字串不一定要用双引号标识；
在缩排中空白字符的数目并不是非常重要，只要相同阶层的元素左侧对齐就可以了（不过不能使用TAB字符）；
允许在文件中加入选择性的空行，以增加可读性；
在一个档案中，可同时包含多个文件，并用“——”分隔；
选择性的符号“...”可以用来表示档案结尾（在利用串流的通讯中，这非常有用，可以在不关闭串流的情况下，发送结束讯号）。

单行缩写

YAML也有用来描述好几行相同结构的数据的缩写语法，数组用\'[]\'包括起来，hash用\'{}\'来包括。因此，上面的这个YAML能够缩写成这样:

house:

family: { name: Doe, parents: [John, Jane], children: [Paul, Mark, Simone] }

address: { number: 34, street: Main Street, city: Nowheretown, zipcode: 12345 }

举例：

john.yaml 文件:

name: John Smith

age: 37

spouse:

name: Jane Smith

age: 25

children:

- name: Jimmy Smith

age: 15

- name: Jenny Smith

age 12

数组表示：

<?php

$john = array(

\'name\' => \'John Smith\',

\'age\' => 37,

\'spouse\' => array(

\'name\' => \'Jane Smith\',

\'age\' => 25

),

\'children\' => array(

0 => array(

\'name\' => \'Jimmy Smith\',

\'age\' => 5

),

1 => array(

\'name\' => \'Jenny Smith\',

\'age\' => 3

)

转载来的，原文地址：http://www.ruanyifeng.com/blog/2016/07/yaml.html

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

YAML 是专门用来写配置文件的语言，非常简洁和强大，远比 JSON 格式方便。

本文介绍 YAML 的语法，以 JS-YAML 的实现为例。你可以去在线 Demo 验证下面的例子。

一、简介

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

它的基本语法规则如下。

大小写敏感

使用缩进表示层级关系

缩进时不允许使用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\' ]

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


-
 - Cat
 - Dog
 - Goldfish

转为 JavaScript 如下。


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

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


animal: [Cat, Dog]

转为 JavaScript 如下。


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

四、复合结构

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


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\' } }

五、纯量

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

字符串

布尔值

整数

浮点数

Null

时间

日期

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


number: 12.30

转为 JavaScript 如下。


{ number: 12.30 }

布尔值用true和false表示。


isSet: true

转为 JavaScript 如下。


{ isSet: true }

null用~表示。


parent: ~

转为 JavaScript 如下。


{ parent: null }

时间采用 ISO8601 格式。


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

转为 JavaScript 如下。


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

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


date: 1976-07-31

转为 JavaScript 如下。


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

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 style="color: red">
    段落
  </p>

转为 JavaScript 如下。


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

七、引用

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


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

八、函数和正则表达式的转换

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


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

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


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 文件的代码如下。


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

九、参考链接

（完）