YAML 語言教程

作者: 阮一峰

日期: 2016年7月 4日

編程免不了要寫配置文件,怎么寫配置也是一門學問。

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 }

布爾值用truefalse表示。


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

九、參考鏈接

(完)

留言(67條)

學symfony的時候一直沒去學yaml的語法, 看了這篇文章,感覺清晰不少

六條 最后一例的解析結果 message: '\n<p style="color: red">\n 段落\n</p>\n' }

我明白了 是網頁顯示不出來 需要轉義...

Hexo 就是用 yaml 組織配置文件。

內容是 YAML 語言,圖片確是 YAML CSS framework 的。

@weet:

謝謝指出,已經換過圖片了。

@mrsu:

謝謝指出,已經對 HTML 標簽轉義了。

YAML有辦法進行字符串拼接嗎?比如先定義了一個基本的配置 host: xxxx,然后下面有幾個配置要跟這個host接接在一起。總不能還在要程序里拼接一次吧?

引用skip的發言:

YAML有辦法進行字符串拼接嗎?比如先定義了一個基本的配置 host: xxxx,然后下面有幾個配置要跟這個host接接在一起。總不能還在要程序里拼接一次吧?

好像可以使用 %{parameter} 進行拼接

最煩縮進表示語法了

引用Alex的發言:

最煩縮進表示語法了

非常同意!

引用Cheng的發言:

好像可以使用 %{parameter} 進行拼接

能否舉個例子,感謝!

阮老師,希望能寫一篇關于RxJs,可擴展式的編程開發理念,用法和實際的應用場景。
github上面也有1W個星,演示的demo也很強大,而且還是家族系列。
可是為什么就是感覺不溫不火的。

不應該是Yet Another Markup Language嗎?

第八節函數轉換的例子,應該使用


fn: !!js/function function () { return 1 }

但是貌似只能使用js內置函數,畢竟有作用域的問題。

S-表達式是最好的數據格式!

引用Joe的發言:

不應該是Yet Another Markup Language嗎?

Yaml Ain't a Markup Language, 跟json是一類的.

一直以來,從阮老師的博文學習了不少知識。剛無意中翻看了很多阮老師的文章,看到了你小額支付的試驗結果,看到了你與百姓網ceo關于為什么要寫博文的討論,看到你說希望通過博文與大家交流......終于靜默不住,所以翻到最新的一頁博文下,來給你留言。我是一個菜鳥,看博文的過程中,能力有限,無法留言技術相關的東西,因而一直沉默著。但是,內心一直對于你給予的貢獻和幫助,非常感謝!我相信由于同樣原因沉默的肯定不止我一人,其實我想說的是,很多人都在這里。

引用cherish的發言:

一直以來,從阮老師的博文學習了不少知識。剛無意中翻看了很多阮老師的文章,看到了你小額支付的試驗結果,看到了你與百姓網ceo關于為什么要寫博文的討論,看到你說希望通過博文與大家交流......終于靜默不住,所以翻到最新的一頁博文下,來給你留言。我是一個菜鳥,看博文的過程中,能力有限,無法留言技術相關的東西,因而一直沉默著。但是,內心一直對于你給予的貢獻和幫助,非常感謝!我相信由于同樣原因沉默的肯定不止我一人,其實我想說的是,很多人都在這里。

是的 比如我也是 哈哈 阮老師 加油

規則竟然如此sb
大小寫敏感
使用縮進表示層級關系
縮進時不允許使用Tab鍵,只允許使用空格。
縮進的空格數目不重要,只要相同層級的元素左側對齊即可

一如既往的簡潔明了

計算機語言實在是太多了,學不完啊,YAML第一次聽說。

通俗易懂,點滴間展現了老師的深厚功底,佩服~

瞬間感覺知識不夠用呀,太厲害了

很好的教程,正好用到這yml配置文件,支持一下

首先,讓我先表達一下對您的敬佩,您是我學習的榜樣。
除了用Yaml和Json和ini文件做配置,好象還要以使用Toml,這個可能更適合一些。
Yaml規范太復雜,Json相對簡單,但不能寫注釋。
Toml很好,可以參考一下。

阮老師,第一次在您博客留言,但是已經看了您很多文章。很清晰,也幫助了我很多,特此留言表示感謝之情。嘿嘿

Hexo的配置文件就是YAML格式的,第一次改配置就感覺簡單明了。
用空格縮進不能使用Tab,哈哈哈,這點做得好,阻礙Python初學者的一個原因就是混用空格Tab引起的問題

一直想學習yaml,阮大師寫的清晰明了

我怎么覺得還不如json簡單易懂呢

阮大師,我是個做JAVA開發的工作兩年了,最近一份工作是做PAAS,關注服務器端比較多,慢慢的代碼也開始生疏了,但我還想繼續JAVA學習,覺得迷茫。能給寫建議嗎。

很不錯的教學

目前寫的最多的配置文件是webpack配置,其他的還沒接觸過,暫時用不上yaml,以后項目大了之后,再來看吧

系列文章都是這么的深入淺出,厲害,佩服!!!

hexo的_config.yml文件似乎不支持嵌入HTML標記呢。

引用張三的發言:

規則竟然如此sb
大小寫敏感
使用縮進表示層級關系
縮進時不允許使用Tab鍵,只允許使用空格。
縮進的空格數目不重要,只要相同層級的元素左側對齊即可

我也覺得是個sb的格式...
感覺不如ini,或者readline...

不過,什么東西都會有工具的

阮老師,我剛剛照著您的例子跑了一下,我用的js-yaml版本是3.6.1。

發現那個導入函數和正則的例子,需要寫成下面的形式,才能導入成函數和正則對象吧,如果在值的前面不通過

!!
聲明類型,那么直接導入成字符串了。

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

引用張三的發言:

規則竟然如此sb
大小寫敏感
使用縮進表示層級關系
縮進時不允許使用Tab鍵,只允許使用空格。
縮進的空格數目不重要,只要相同層級的元素左側對齊即可

yaml用于展現或編輯具有層級關系的數據非常非常好

“大小寫敏感” 是為了大小寫敏感的語言進行序列化和反序列化

“使用縮進表示層級關系” 是為了在編輯器里能把層級關系看得清清楚楚

“縮進時不允許使用Tab鍵,只允許使用空格” 一是為了保證在解析數據時層級關系的準確,二是為了在不同的編輯器里不會因 tab 的占居空格不同而顯示為不同的層級關系

“縮進的空格數目不重要,只要相同層級的元素左側對齊即可” 計算機解析時只需要計算縮進空格數的相等與否,而因人視力的不同,有人能清楚的看出2格縮進,有人卻需要8格

舉例說明:
項目的菜單以配置文件的方式保存,隨著項目功能代碼的變化,需要頻繁同步做菜單名稱的修改,子菜單項的添加、刪除、移動(調整順序或變換父級菜單)。

這種場景無論是用xml、json、ini或其他格式,都是會一件非常痛苦的事情,使用 yaml 后,一切變得 easy,編輯的時候看得清清楚楚,修改的時候方便又明晰,程序讀取的時候,直接反序化為對象輸出。


非常受用,總能在阮老師的網頁找到有用的文章,望再接再厲!

引用大頭的發言:

我怎么覺得還不如json簡單易懂呢

我也覺得

引用Joe的發言:

不應該是Yet Another Markup Language嗎?

這樣的話就不遞歸了呀......

這篇文章寫的很好,簡單明了,非常喜歡。最近在試用YAML時遇到一個小問題,找到原因后來分享下,就是錨點&名稱里不能有下劃線,否則引用失敗。

你好請問下yaml如何定義變量 并且引用變量

看了很多英文的材料都沒有你寫的好

如果返回值只有字符串“true”,而不是json格式的字符串,應該怎么寫校驗?

@zhouzm:

我也覺得這種簡潔規整的語法好,很清晰,而且和他人合作時也不會混亂。懶得打這么多字去解釋,正好看到您的回復,頂一下表示支持。

大多數.yml文件開頭都是三個橫線, 像這樣:


---
YAML: YAML Ain't Markup Language

請問其中有什么含義?

竟然和python風格如此相似,很容易理解,不錯

串行化應該是序列化吧,感覺翻譯的不準確

描述中寫道“雙引號不會對特殊字符轉義”,這個是否應該是單引號?

yaml 我在spring boot 看到了,特來學習。

最近在寫ansible學習筆記,用到yaml,一搜索,果然前排就是阮大文章,看完收益良多

引用8023的發言:

大多數.yml文件開頭都是三個橫線, 像這樣:

---
YAML: YAML Ain't Markup Language

請問其中有什么含義?

在單一文件中,可用連續三個連字號(---)區分多個文件。
另外,還有選擇性的連續三個點號( ... )用來表示文件結尾。
摘選自 https://zh.wikipedia.org/wiki/YAML

有點繁瑣。簡單的還行,點有點多,復雜點就很容易誤解了

yaml層級關系和Python類似,都是用縮進表示,而不是像別的語言用括號或者標簽來表示。

引用張三的發言:

規則竟然如此sb
大小寫敏感
使用縮進表示層級關系
縮進時不允許使用Tab鍵,只允許使用空格。
縮進的空格數目不重要,只要相同層級的元素左側對齊即可

怕是被 windows 毒害的開發者

@zhouzm:

同意。感覺yaml的賣點就是對人類友好,盡可能符合人類書寫和閱讀的習慣。

2個文件怎么根據不同merge成一個文件

同意。感覺yaml的賣點就是對人類友好,盡可能符合人類書寫和閱讀的習慣。

yaml 的語法真的是個性,和其他的都不怎么一樣!

確實不如json易懂。 json更合適

真的 在google搜大部分技術資料都可以搜到阮老師的。佩服

我配置的這個,filterMap1: { "/login": anon, /toLogin: anon} 注入結果卻是 filterMap1: {login=anon, toLogin=anon}

阮老師,為什么key中的/和* 全部被過濾掉了

引用Jacob的發言:

Yaml Ain't a Markup Language, 跟json是一類的.

維基百科是這么說的,YAML是"YAML Ain't a Markup Language"(YAML不是一種標記語言)的遞歸縮寫。在開發的這種語言時,YAML 的意思其實是:"Yet Another Markup Language"(仍是一種標記語言)[3],但為了強調這種語言以數據做為中心,而不是以標記語言為重點,而用反向縮略語重命名。

引用千發的發言:

確實不如json易懂。 json更合適

YAML is a superset of JSON!

引用Cheng的發言:

好像可以使用 %{parameter} 進行拼接


試了,并不行!

大師,想請教一下如何是用代碼來設置錨點和引用

單引號會解析字符串中的\
雙引號不會解析字符串中的\
s1: '內容\n字符串'
s2: "內容\n字符串"
轉換為Javascript得應該時這樣:
{
s1:'內容\n字符串',
s2: '內容\\n字符串'
}
Javascript中\代表不解析后面的斜杠

我要發表看法

«-必填

«-必填,不公開

«-我信任你,不會填寫廣告鏈接

极速助手