1. 程式人生 > 實用技巧 >YAML語言的介紹和語法規則

YAML語言的介紹和語法規則

內容轉載自我的部落格

目錄

1. YAML語言概述

YAML 語言的基本語法規則如下

  • 大小寫敏感
  • 使用縮排表示層級關係
  • 縮排時不允許使用Tab鍵,只允許使用空格。
  • 縮排的空格數目不重要,只要相同層級的元素左側對齊即可
  • # 表示註釋,從這個字元一直到行尾,都會被解析器忽略

YAML 支援的資料結構有三種

  • 物件:鍵值對的集合,又稱為對映(mapping)/ 雜湊(hashes) / 字典(dictionary)
  • 陣列:一組按次序排列的值,又稱為序列(sequence) / 列表(list)
  • 純量(scalars):單個的、不可再分的值

2. YAML語言的物件

物件的一組鍵值對,使用冒號結構表示

animal: pets

相當於 JavaScript 的物件

{ animal: 'pets' }

也允許另一種寫法,將所有鍵值對寫成一個行內物件

hash: { name: Steve, foo: bar } 

相當於 JavaScript 的物件

{   
    hash: { name: 'Steve', foo: 'bar' } 
}

3. YAML語言的陣列

一組連詞線開頭的行,構成一個數組

- Cat
- Dog
- Goldfish

轉為 JavaScript 表示如下

[ 'Cat', 'Dog', 'Goldfish' ]

資料結構的子成員是一個數組,則可以在該項下面縮排一個空格

-
 - Cat
 - Dog
 - Goldfish

轉為 JavaScript 表示如下

[ 
    [ 'Cat', 'Dog', 'Goldfish' ] 
]

陣列也可以採用行內表示法

animal: [Cat, Dog]

轉為 JavaScript 表示如下

{ animal: [ 'Cat', 'Dog' ] }

4. YAML語言的複合結構

物件和陣列可以結合使用,形成複合結構

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. YAML語言的純量

純量是最基本的、不可再分的值。以下資料型別都屬於 JavaScript 的純量:字串、布林值、整數、浮點數、Null、時間、日期、數值直接以字面量的形式表示

number: 12.30
isSet: true
parent: ~
iso8601: 2001-12-14t21:59:43.10-05:00 
date: 1976-07-31
# 使用兩個感嘆號,強制轉換資料型別
e: !!str 123
f: !!str true

轉為 JavaScript 如下

{    
    number: 12.30,
    isSet: true,
    parent: null,
    iso8601: new Date('2001-12-14t21:59:43.10-05:00'),
    date: new Date('1976-07-31'),
    e: '123', 
    f: 'true',
}

6. YAML語言的字串

字串是最常見,也是最複雜的一種資料型別,字串預設不使用引號表示

str1: 這是一行字串
# 字串之中包含空格、冒號或特殊字元,需要放在引號之中
str2: '內容: 字串'
# 單引號和雙引號都可以使用,雙引號不會對特殊字元轉義
s1: '內容\n字串'
s2: "內容\n字串"
# 單引號之中如果還有單引號,必須連續使用兩個單引號轉義
str3: 'labor''s day' 
# 字串可以寫成多行,從第二行開始,必須有一個單空格縮排,換行符會被轉為空格
st4: 這是一段
  多行
  字串
# 多行字串可以使用|保留換行符,也可以使用>摺疊換行
this: |
  Foo
  Bar
that: >
  Foo
  Bar
# +表示保留文字塊末尾的換行,-表示刪除字串末尾的換行
s3: |
  Foo

s4: |+
  Foo


s5: |-
  Foo
# 字串之中可以插入 HTML 標記
message: |

  <p style="color: red">
    段落
  </p>

轉為 JavaScript 如下

{    
    str1: '這是一行字串',
    str2: '內容: 字串',
    s1: '內容\\n字串', 
    s2: '內容\n字串',
    str3: 'labor\'s day',
    str4: '這是一段 多行 字串',
    this: 'Foo\nBar\n', 
    that: 'Foo Bar\n',
    s3: 'Foo\n', 
    s4: 'Foo\n\n\n', 
    s5: 'Foo',
    message: '\n<p style="color: red">\n  段落\n</p>\n'
}

7. YAML語言的引用

錨點&和別名*可以用來引用

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' ]

引用變數和陣列變數示例

country: 中國
city:
    - 北京
    - 上海
    - 深圳
    - 南京
    - 重慶
websites:
    YAML: yaml.org 
    Ruby: ruby-lang.org 
    Python: python.org 
    Perl: use.perl.org 
myCountry: ${country}
myCity: ${city[0]}
myweb: ${websites.YAML} by zfb