yaml语言教程
在docker的世界中，有很多地方都会采用yaml文件来作为配置文件。
YAML Ain’t Markup Language” (abbreviated YAML)
上面说明YAML并不是一个标记语言，其经常用来写配置文件，非常简洁和强大，远比Json格式方便。本文介绍的YAML语法，以JS-YAML的实现为例。你可以到在线Demo验证下面的例子。
1. 简介
YAML语言的设计目标，就是方便人类读写。它实质上是一种通用的数据串行化格式。它的基本语法规则如下：
-
大小写敏感
-
使用缩进表示层级关系
-
缩进时不允许使用tab键，只允许使用空格
-
缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
#表示注释，从这个字符一直到行尾，都会被解析器忽略。
YAML支持的数据结构有三种：
-
对象: 键值对的集合，又称为映射(mapping)/哈希(hashes)/字典(dictionary)
-
数组: 一组按次序排列的值，又称为序列(sequence)/列表(list)
-
纯量(scalars): 单个的、不可再分的值
以下分别介绍这三种数据结构。
2. 对象
对象是一组键值对，使用冒号结构表示：
animal: pets
转换为JavaScript如下：
{animal: 'pets'}
YAML也允许另一种写法，将所有键值对写成一个行内对象：
hash: { name: Steve, foo: bar }
转换为JavaScript如下：
{hash: {name: 'Steve', foo: 'bar'}}
说明，上面写法冒号:后壁必须要跟一个空格
3. 数组
一组以-开头的行，构成一个数组：
- Cat - Dog - Goldfish
转换成JavaScript如下：
[ 'Cat', 'Dog', 'Goldfish' ]
如果数据结构的子成员是一个数组，则可以在该项下缩进一个空格(缩进多个空格也可以，只不过子项要对齐）：
- - Cat - Dog - Goldfish
转换成JavaScript如下：
[ [ 'Cat', 'Dog', 'Goldfish' ] ]
数组也可以采用行内表示法：
animal: [ 'Cat', 'Dog' ]
转换成JavaScript如下：
{ animal: [ 'Cat', 'Dog' ] }
4. 复合结构
对象和数组可以结合使用，形成复合结构。例如：
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' } }
5. 纯量
纯量是最基本的、不可再分的值。以下数据类型都属于JavaScript纯量。
-
字符串
-
布尔值
-
整数
-
浮点数
-
Null
-
时间
-
日期
1) 数值直接以字面量的形式表示
例如：
number: 12.30
转换成JavaScript如下：
{ number: 12.30 }
2) 布尔值用true和false表示
例如：
isSet: true
转换成JavaScript如下：
{ isSet: true }
3) null用~来表示
例如：
parent: ~
转换成JavaScript如下：
{ parent: null }
4) 时间采用 ISO8601 格式
例如：
iso8601: 2001-12-14t21:59:43.10-05:00
转换为JavaScript如下：
{ ios8601: new Date('2001-12-14t21:59:43.10-05:00') }
5) 日期采用复合ISO8601格式的年、月、日表示
例如：
date: 1976-07-31
转换为JavaScript如下：
{ date: new Date('1976-07-31') }
6) YAML强制转换数据类型
YAML允许使用两个感叹号(!)，强制转换数据类型。例如：
e: !!str 123 f: !!str true
转换为JavaScript如下：
{ e: '123', f: 'true' }
6. 字符串
字符串是最常见，也是最复杂的一种数据类型。字符串默认不使用引号(''表示）。例如：
str: 这是一行字符串
转换为JavaScript如下：
{ str: '这是一行字符串' }
1) 如果字符串之中包含空格或特殊字符，需要放在引号之中
例如：
str: '内容： 字符串'
转换成JavaScript如下：
{ str: '内容: 字符串' }
2) 单引号和双引号都可以使用，双引号不会对特殊字符转义
例如：
s1: '内容\n字符串' s2: "内容\n字符串"
转换为JavaScript如下：
{ s1: '内容\\n字符串', s2: '内容\n字符串' }
3) 单引号之中如果还有单引号，必须连续使用两个单引号转义
例如：
str: 'labor''s day'
转换为JavaScript如下：
{ str: 'labor\'s day' }
4) 多行字符串
字符串可以写成多行，从第二行开始，必须有一个单空格缩进(也可以是多个空格)。换行符会被转为空格。例如：
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如下(注意上面s2 Foo下有两个换行）：
{ s1: 'Foo\n', S2: 'Foo\n\n\n', s3: 'Foo' }
5) 字符串之中可以插入HTML标记
例如：
message: |
<p style="color=red">
段落
</p>转换成JavaScript如下：
{ message: '\n<p style="color=red">\n 段落\n</p>\n' }7. 引用
锚点&和别名*，可以用来引用。例如：
defaults: &defaults
adapter: postgres
host: localhost
development:
dababase: myapp_development
<<: *defaults
test:
database: myapp_test
<<: *defaults等同于下面代码：
defaults:
adapter: postgres
host: localhost
develoment:
database: myapp_development
adapter: postgres
host: localhost
test:
database: myapp_test
adapter: postgres
host: localhost上面&用来建立锚点(defaults)，<<表示合并到当前数据，*用来引用锚点。
下面是另一个例子：
- &showell Steve
- Clark
- Brain
- Oren
- *showell转换为JavaScript代码如下：
[ 'Steve', 'Clark', 'Brain', 'Oren', 'Steve' ]9 函数和正则表达式的转换
这是JS-YAML库特有功能，可以把函数和正则表达式转换为字符串。
例如：
# example.yml
fn: function () { return 1 }
reg: /test/解析上面yaml文件的代码如下：
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);
}10. gopkg.in/yaml.v2调用示例
package main
import (
"fmt"
"log"
"gopkg.in/yaml.v2"
)
var data = `
a: Easy!
b:
c: 2
d: [3, 4]
`
type T struct {
A string
B struct {
RenamedC int `yaml:"c"` //mapping yaml field c
D []int `yaml:",flow"` //mapping yaml filed c's next field
}
}
func main() {
t := T{}
err := yaml.Unmarshal([]byte(data), &t)
if err != nil {
log.Fatalf("error: %v", err)
}
fmt.Printf("--- t:\n%v\n\n", t)
d, err := yaml.Marshal(&t)
if err != nil {
log.Fatalf("error: %v", err)
}
fmt.Printf("--- t dump:\n%s\n\n", string(d))
m := make(map[interface{}]interface{})
err = yaml.Unmarshal([]byte(data), &m)
if err != nil {
log.Fatalf("error: %v", err)
}
fmt.Printf("--- m:\n%v\n\n", m)
d, err = yaml.Marshal(&m)
if err != nil {
log.Fatalf("error: %v", err)
}
fmt.Printf("--- m dump:\n%s\n\n", string(d))
}编译运行：
--- t:
{Easy! {2 [3 4]}}
--- t dump:
a: Easy!
b:
c: 2
d: [3, 4]
--- m:
map[a:Easy! b:map[c:2 d:[3 4]]]
--- m dump:
a: Easy!
b:
c: 2
d:
- 3
- 4
[参考]
