编程免不了要写配置文件,怎么写配置也是一门学问。
YAML 是专门用来写配置文件的语言,非常简洁和强大,远比 JSON 格式方便。
本文介绍 YAML 的语法,以 JS-YAML 的实现为例。你可以去在线 Demo 验证下面的例子。
YAML简介
YAML(英语发音:/ˈjæməl/,尾音类似camel骆驼)是一个可读性高,用来表达资料序列的格式。YAML参考了其他多种语言,包括:C语言、Python、Perl,并从XML、电子邮件的数据格式(RFC 2822)中获得灵感。Clark Evans在2001年首次发表了这种语言[1],另外Ingy döt Net与Oren >Ben-Kiki也是这语言的共同设计者[2]。目前已经有数种编程语言或脚本语言支援(或者说解析)这种语言。 ——维基百科
YAML 仍然是一门标记性语言,但为了强调这门语言以数据为中心,而不是以标记语言为中心。采用反向缩略语重新命名。
基本语法规则:
1、大小写敏感 2、使用缩进表示层级关系 3、不允许使用TAB键来缩进,只允许使用空格键来缩进 4、缩进的空格数量不重要 5、使用"#"来表示注释
支持的数据格式:
1.对象:键值对的集合,又称映射(mapping) / 哈希(hashes)/ 字典(dictionary) 2.数组: 一组按次序排列的值,又称序列(sequence) / 列表(list) 3.纯量(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: user.perl.org
转为JavaScript
{
languages: [ 'Ruby', 'Perl', 'Python'],
websites:
{
YAML: 'yaml.org',
Ruby: 'ruby-lang.org',
Python: 'python.org',
Perl: 'user.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-12-20
转为JavaScript
{ date: new Date('1976-12-20') }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' ]
参考链接
未经允许请勿转载:程序喵 » 快速学习 YAML 语言教程
程序喵