轉載自阮一峯的YAML 語言教程
編程免不了要寫配置文件,怎麼寫配置也是一門學問。
YAML 是專門用來寫配置文件的語言,非常簡潔和強大,遠比 JSON 格式方便。
本文介紹 YAML 的語法,以 JS-YAML 的實現爲例。你可以去在線 Demo 驗證下面的例子。
一、簡介
YAML 語言(發音 /ˈjæməl/ )的設計目標,就是方便人類讀寫。它實質上是一種通用的數據串行化格式。
它的基本語法規則如下。
- 大小寫敏感
- 使用縮進表示層級關係
- 縮進時不允許使用Tab鍵,只允許使用空格。
- 縮進的空格數目不重要,只要相同層級的元素左側對齊即可
- # 表示註釋,從這個字符一直到行尾,都會被解析器忽略。
YAML 支持的數據結構有三種。
- 對象:鍵值對的集合,又稱爲映射(mapping)/ 哈希(hashes) / 字典(dictionary)
- 數組:一組按次序排列的值,又稱爲序列(sequence) / 列表(list)
- 純量(scalars):單個的、不可再分的值
以下分別介紹這三種數據結構。
二、對象
- 對象的一組鍵值對,使用冒號結構表示。
animal: pets
轉爲 json如下。
{ animal: 'pets' }
- Yaml 也允許另一種寫法,將所有鍵值對寫成一個行內對象。
hash: { name: Steve, foo: bar }
轉爲 json 如下。
{ hash: { name: 'Steve', foo: 'bar' } }
三、數組
- 一組連詞線開頭的行,構成一個數組。
- Cat
- Dog
- Goldfish
轉爲 json 如下。
[ 'Cat', 'Dog', 'Goldfish' ]
- 數據結構的子成員是一個數組,則可以在該項下面縮進一個空格。
-
- Cat
- Dog
- Goldfish
轉爲 JavaScript 如下。
[ [ 'Cat', 'Dog', 'Goldfish' ] ]
- 數組也可以採用行內表示法。
animal: [Cat, Dog]
轉爲 json 如下。
{ animal: [ 'Cat', 'Dog' ] }
四、複合結構
- 對象和數組可以結合使用,形成複合結構。
languages:
- Ruby
- Perl
- Python
websites:
YAML: yaml.org
Ruby: ruby-lang.org
Python: python.org
Perl: use.perl.org
轉爲 json 如下。
{ languages: [ 'Ruby', 'Perl', 'Python' ],
websites:
{ YAML: 'yaml.org',
Ruby: 'ruby-lang.org',
Python: 'python.org',
Perl: 'use.perl.org' } }
五、純量
純量是最基本的、不可再分的值。以下數據類型都屬於 JavaScript 的純量。
-
字符串
-
布爾值
-
整數
-
浮點數
-
Null
-
時間
-
日期
-
數值直接以字面量的形式表示。
number: 12.30
轉爲 json 如下。
{ number: 12.30 }
- 布爾值用true和false表示。
isSet: true
轉爲 json 如下。
{ isSet: true }
- null用
~
表示。
parent: ~
轉爲 json 如下。
{ parent: null }
- 時間採用 ISO8601 格式。
iso8601: 2001-12-14t21:59:43.10-05:00
轉爲 json 如下。
{ 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
轉爲 json 如下。
{ e: '123', f: 'true' }
六、字符串
字符串是最常見,也是最複雜的一種數據類型。
- 字符串默認
不使用引號
表示
str: 這是一行字符串
轉爲 json 如下。
{ str: '這是一行字符串' }
- 如果字符串之中包含空格或特殊字符,需要放在引號之中。
str: '內容: 字符串'
轉爲 json 如下。
{ str: '內容: 字符串' }
- 單引號和雙引號都可以使用,
雙引號不會對特殊字符轉義
s1: '內容\n字符串'
s2: "內容\n字符串"
轉爲 json 如下。
{ s1: '內容\\n字符串', s2: '內容\n字符串' }
- 單引號之中如果還有單引號,
必須連續使用兩個單引號轉義
str: 'labor''s day'
轉爲 json 如下。
{ str: 'labor\'s day' }
- 字符串可以寫成多行,從第二行開始,必須有一個單空格縮進。換行符會被轉爲空格。
str: 這是一段
多行
字符串
轉爲 json 如下。
{ str: '這是一段 多行 字符串' }
- 多行字符串可以使用|保留換行符,也可以使用>摺疊換行。
this: |
Foo
Bar
that: >
Foo
Bar
轉爲 JavaScript 代碼如下。
{ this: 'Foo\nBar\n', that: 'Foo Bar\n' }
- +表示保留文字塊末尾的換行,-表示刪除字符串末尾的換行。
s1: |
Foo
s2: |+
Foo
s3: |-
Foo
轉爲 json 代碼如下。
{ s1: 'Foo\n', s2: 'Foo\n\n\n', s3: 'Foo' }
- 字符串之中可以插入 HTML 標記。
message: |
<p style="color: red">
段落
</p>
轉爲 json 如下。
{ 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
轉爲 json 代碼如下。
[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]