YAML 的意思實際上是:"Yet Another Markup Language"(還是一種置標語言)的縮寫。javascript
YAML的語法和其餘高階語言相似,而且能夠簡單表達清單、散列表,標量等資料形態、。php
它使用 空白符號縮排 和 大量依賴外觀的特點,特別適合用來表達或編輯數據結構、各類設定檔、傾印除錯內容、文件大綱(例如:許多電子郵件標題格式和YAML很是接近)。html
儘管它比較適合用來表達階層式(hierarchical model)的數據結構,不過也有精緻的語法能夠表示關聯性(relational model)的資料。java
因爲YAML使用空白字符和分行來分隔資料,使的他特別適合用 grep、Python、Perl、Ruby 操做。node
其讓人最容易上手的特點是巧妙避開各類封閉符號,如:引號、各類括號等,這些符號在嵌套結構中會變得複雜而難以辨認。python
數據結構能夠用相似大綱的縮排方式呈現,結構經過 縮進 來表示,連續的項目經過 減號「-」來表示,map 結構裏面的 key/value 對用冒號「:」來分隔。樣例以下:git
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
house:
family:
name: Doe
parents:
- John
- Jane
children:
- Paul
- Mark
- Simone
address:
number: 34
street: Main Street
city: Nowheretown
zipcode: 12345
|
注意:github
字串不必定要用雙引號標識;web
在縮排中空白字符的數目並非很是重要,只要相同階層的元素左側對齊就能夠了(不過 不能使用TAB字符);正則表達式
容許在文件中加入選擇性的空行,以增長可讀性;
在一個檔案中,可同時包含多個文件,並用「——」分隔;
選擇性的符號「...」能夠用來表示檔案結尾(在利用串流的通信中,這很是有用,能夠在不關閉串流的狀況下,發送結束訊號)。
YAML也有用來描述好幾行相同結構的數據的縮寫語法,數組用'[]'包括起來,hash用'{}'來包括。所以,上面的這個YAML可以縮寫成這樣:
1
2
3
|
house:
family: { name: Doe, parents: [John, Jane], children: [Paul, Mark, Simone] }
address: { number: 34, street: Main Street, city: Nowheretown, zipcode: 12345 }
|
john.yaml 文件:
1
2
3
4
5
6
7
8
9
10
|
name: John Smith
age: 37
spouse:
name: Jane Smith
age: 25
children:
- name: Jimmy Smith
age: 15
- name: Jenny Smith
age 12
|
數組表示:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
<?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); }
(完)