YAML 是專門用來寫配置文件的語言，很是簡潔和強大，遠比 JSON 格式方便。html
本文介紹 YAML 的語法，以 JS-YAML 的實現爲例。你能夠去在線 Demo 驗證下面的例子。java
1、簡介
YAML 語言（發音 /ˈjæməl/ ）的設計目標，就是方便人類讀寫。它實質上是一種通用的數據串行化格式。node
它的基本語法規則以下。python
- 大小寫敏感
- 使用縮進表示層級關係
- 縮進時不容許使用Tab鍵，只容許使用空格。
- 縮進的空格數目不重要，只要相同層級的元素左側對齊便可
# 表示註釋，從這個字符一直到行尾，都會被解析器忽略。mysql
YAML 支持的數據結構有三種。git
- 對象：鍵值對的集合，又稱爲映射（mapping）/ 哈希（hashes） / 字典（dictionary）
- 數組：一組按次序排列的值，又稱爲序列（sequence） / 列表（list）
- 純量（scalars）：單個的、不可再分的值
如下分別介紹這三種數據結構。github
2、對象
對象的一組鍵值對，使用冒號結構表示。web
animal: pets
轉爲 JavaScript 以下。正則表達式
{ animal: 'pets' }
Yaml 也容許另外一種寫法，將全部鍵值對寫成一個行內對象。
hash: { name: Steve, foo: bar }
轉爲 JavaScript 以下。
{ hash: { name: 'Steve', foo: 'bar' } }
3、數組
一組連詞線開頭的行，構成一個數組。
- Cat - Dog - Goldfish
轉爲 JavaScript 以下。
[ 'Cat', 'Dog', 'Goldfish' ]
數據結構的子成員是一個數組，則能夠在該項下面縮進一個空格。
- - Cat - Dog - Goldfish
轉爲 JavaScript 以下。
[ [ 'Cat', 'Dog', 'Goldfish' ] ]
數組也能夠採用行內表示法。
animal: [Cat, Dog]
轉爲 JavaScript 以下。
{ animal: [ 'Cat', 'Dog' ] }
4、複合結構
對象和數組能夠結合使用，造成複合結構。
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、純量
純量是最基本的、不可再分的值。如下數據類型都屬於 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' }
6、字符串
字符串是最多見，也是最複雜的一種數據類型。
字符串默認不使用引號表示。
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' }
7、引用
錨點&和別名*，能夠用來引用。
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' ]
8、函數和正則表達式的轉換
這是 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); }
9、參考連接
（完）
YAML Ain't Markup Language
和GNU同樣，YAML是一個遞歸着說「不」的名字。不一樣的是，GNU對UNIX說不，YAML說不的對象是XML。
YAML不是XML。
爲何不是XML呢？由於：
- YAML的可讀性好。
- YAML和腳本語言的交互性好。
- YAML使用實現語言的數據類型。
- YAML有一個一致的信息模型。
- YAML易於實現。
上面5條也就是XML不足的地方。同時，YAML也有XML的下列優勢：
- YAML能夠基於流來處理；
- YAML表達能力強，擴展性好。
總之，YAML試圖用一種比XML更敏捷的方式，來完成XML所完成的任務。
更多的內容及規範參見http://www.yaml.org。
語法
Structure經過空格來展現。Sequence裏的項用"-"來表明，Map裏的鍵值對用":"分隔.
這幾乎就是全部的語法了.
好比……
通常YAML文件擴展名爲.yaml。好比：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
|
John今年37歲，有一個幸福的四口之家。兩個孩子Jimmy 和Jenny活潑可愛。妻子Jane年輕美貌。
若是深刻研究的話還可能發現一些社會問題。
可見YAML的可讀性是不錯。
JYaml——YAML的Java實現
YAML已經有了很多實現,詳細的實現列表參見http://www.yaml.org/download.html。
其中JYaml（http://jyaml.sourceforge.net）是YAML的Java實現。
JYaml簡介
YAML使用實現語言的數據類型。咱們看一下一些JYaml支持的Java數據類型：
- 原始數據和封裝類（好比int，java.lang.Integer）
- JavaBean兼容對象（Structure支持）
- Collection （sequence支持）
- Map （map支持）
- Arrays （sequence支持）
- BigInteger 和BigDecimal
- Date
咱們給出John.yaml的java描述：
|
1
2
3
4
5
6
7
|
public class Person {
private String name;
private int age;
private Person sponse;
private Person[] children;
// setXXX, getXXX方法略.
}
|
如今讓咱們裝配一個Jone：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
Person john = new Person();
john.setAge(37);
john.setName("John Smith");
Person sponse = new Person();
sponse.setName("Jane Smith");
sponse.setAge(25);
john.setSponse(sponse);
Person[] children = {new Person(), new Person()};
children[0].setName("Jimmy Smith");
children[0].setAge(15);
children[1].setName("Jenny Smith");
children[1].setAge(12);
john.setChildren(children);
|
使用JYaml把Jone「Dump」出來：
|
1
2
|
File dumpfile = new File("John_dump.yaml");
Yaml.dump(john, dumpfile);
|
下面咱們看看John_dump.yaml是什麼樣子：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
--- !yaml.test.internal.Person
age: 37
children: !yaml.test.internal.Person[]
- !yaml.test.internal.Person
age: 15
name: Jimmy Smith
- !yaml.test.internal.Person
age: 12
name: Jenny Smith
name: John Smith
sponse: !yaml.test.internal.Person
age: 25
name: Jane Smith
|
其中!yaml.test.internal.Person是一些類型的信息。load的時候須要用。
如今用JYaml把Jone_dump.yaml load進來：
|
1
|
Person john2 = (Person) Yaml.loadType(dumpfile, Person.class);
|
還能夠用下面的代碼dump出沒有類型信息的John.yaml：
|
1
|
Yaml.dump(john,dumpfile, true);
|
咱們再來看看JYaml對流處理的支持。
爲簡便起見，咱們只是把同一個john寫10次：
|
1
2
3
4
5
6
7
|
YamlEncoder enc = new YamlEncoder(new FileOutputStream(dumpfile));
for(int i=0; i<10; i++){
john.setAge(37+i);
enc.writeObject(john);
enc.flush();
}
enc.close();
|
下面再把這十個對象一個一個讀出來（注意while循環退出的方式）：
|
1
2
3
4
5
6
7
8
9
10
11
|
YamlDecoder dec = new YamlDecoder(new FileInputStream(dumpfile));
int age = 37;
while(true){
try{
john = (Person) dec.readObject();
assertEquals(age, john.getAge());
age++;
}catch(EOFException eofe){
break;
}
}
|
JYaml對JDK14的支持
JYaml的源碼是基於JVM5的。也提供對JVM5功能的一些支持，好比對枚舉類型的支持。
JYaml的JVM14的支持是經過retrotranslator(http://retrotranslator.sourceforge.net）. retrotranslator使用ASM（http://asm.objectweb.org ）動態修改JVM5字節碼成JVM14，使JYaml在JVM14下可用。會犧牲一些效率。Debug時也會失真。
我修改了JYaml做者Toby Ho的一些源碼（基於Beta2.2），使之與JVM14兼容。固然，爲此也去掉了對JVM5纔有的類型的支持（好比枚舉類型）. 這個犧牲應該是值得的。須要的人能夠來信索取。
YAML和SDO（只討論雙方的java實現）
若是讀者想了解更多SDO的概念， 請參見http://www.ibm.com/developerworks/library/specification/j-commonj-sdowmt/index.html 。這裏咱們只討論SDO的java實現。
SDO裏有一個很重要的概念，DataObject。從DataObject的接口裏，能夠看出有兩類的數據類型，一類是JYaml支持的，諸如String, List之類，一類是DataObject。所以咱們只須要增長一種支持DataObject的類型，就能夠完成對SDO DataObject的支持。
不妨叫YamlDataObject。下面是它的數據結構。
|
1
2
3
4
5
|
public class YamlDataObject {
private String uRI;
private String name;
private Map attributes;
}
|
YamlDataObject裏用到的類型，都是JYaml可以支持的。其中，uRI和name用來描述DataObject自身。attributes來描述DataObject裏的值。這些值可能爲DataObject，也多是JYaml所支持的其餘類型。咱們但願用YamlDataObject來擔當DataObject的角色，所以YamlDataObject和DataObject要能互相轉化。增長兩個API：
|
1
2
|
private static YamlDataObject newInstance(DataObject dataobject){...
private DataObject toDataObject() {...
|
上面兩個之因此是private的，是由於咱們打算遵守JYaml的習慣，增長兩個接口，dump和load，這樣newInstance和toDataObject只在內部使用了。下面是dump和load的定義：
|
1
2
3
4
|
public static void dump(DataObject dataobject, File dumpfile)
throws FileNotFoundException{...
public static Object load(File file)
throws FileNotFoundException{...
|
下面是一小段測試代碼：
|
1
2
3
4
5
6
7
8
9
10
|
// ... create dataobject ...
File bodump=new File("bodump.yaml");
YamlDataObject.dump(dataobject,bodump);
assertTrue(bodump.exists());
DataObject dataobject2 = (DataObject) YamlDataObject.load(bodump);
// check result
assertNotNull(dataobject2);
for(int i=0; i<5; i++){
assertEquals(dataobject.get(i),dataobject2.get(i));
}
|
具體的實現細節就不談了。讀者能夠做爲練習題，熟悉一下這兩個數據整合方案。
YAML和Ruby
Ruby和YAML的聯繫，甚至比Java與XML的聯繫還要緊密。Ruby把YAML用到了和數據相關的方方面面。配置文件的約定格式是YAML。同時YAML仍是Ruby的文本序列化格式，就像XML是SDO的文本序列化格式同樣。
不誇張的說，YAML是Ruby中流動的血液。
那，Ruby爲何不選XML呢?
其一，XML對Ruby這樣的腳本語言而言，解析起來比較困難。效率確定是會有問題。Ruby的XML解析沒有徹底實現，走的是實用主義的路線，可能也緣於此。而YAML要輕快不少。
另外，XML使用自定義類型。就算解析出來，也不能直接用，還要再轉一次。而YAML不定義本身的類型，直接使用宿主語言自己類型，直截了當。
下面給一個Ruby YAML的簡介。
咱們使用Ruby寫一個Person類：
|
1
2
3
4
5
6
7
8
9
|
class Person
attr_accessor :name, :age, :sponse, :children
def initialize(name, age, sponse=nil, children=nil)
@name = name
@age = age
@sponse = sponse
@children = children
end
end
|
把John裝配起來：
|
1
2
3
|
jane = Person.new("Jane Smith", 25)
children = [Person.new("Jimmy Smith", 15), Person.new("Jenny Smith", 12)]
john = Person.new("John Smith", 37, jane, children)
|
Dump出John到John.yaml：
|
1
2
3
|
File.open('John_ruby.yaml', 'w') do |os|
YAML::dump(john, os)
end
|
咱們看看Dump的結果：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
--- !ruby/object:Person
age: 37
children:
- !ruby/object:Person
age: 15
children:
name: Jimmy Smith
sponse:
- !ruby/object:Person
age: 12
children:
name: Jenny Smith
sponse:
name: John Smith
sponse: !ruby/object:Person
age: 25
children:
name: Jane Smith
sponse:
|
仔細觀察會發現和JYaml Dump出來的仍是有些區別的。
首先類型信息不同。這還好說，雖然Ruby load Java的不太可能，但Java加載Ruby的應該沒問題。
還有就是一些實現上細微的區別。好比Ruby::Yaml的"spone:"，JYaml認爲是不合法的。還有children的不縮行。儘管Ruby::Yaml很流行，但JYaml認爲這是Ruby的Bug。網上有相應的爭論。
不過在一個語言裏使用仍是沒問題的。下面是load John的代碼：
|
1
|
john2 = File.open('John.yaml') { |is| YAML::load(is) }
|
YAML的Ruby實現出現的很早。但因爲某些緣由，YAML的Ruby實現是不嚴格的。隨着其餘語言的YAML實現慢慢出現，這個問題日益明顯了。
畢竟每一個實現語言的類型不同的，不一樣語言文化也不一樣。所以不一樣實現的YAML的交互是個問題。兼容性須要YAML規範來保證。而具體的實施還有很長的道路要走。
但YAML在單一語言中，YAML的應用是沒有問題的。
YAML在Ruby On Rails中常常用做配置文件。好比數據庫信息的配置：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
test:
adapter: mysql
database: weblog_test
username: root
password:
host: localhost
production:
adapter: mysql
database: weblog_production
username: root
password:
host: localhost
|
熟悉ROR的讀者應該能看出這是`config/database.yml'文件。
YAML的適用範圍
因爲實現簡單，解析成本很低，YAML特別適合在腳本語言中使用。列一下現有的語言實現：Ruby，Java，Perl，Python，PHP，OCaml，JavaScript。除了Java，其餘都是腳本語言.
YAML比較適合作序列化。由於它是宿主語言數據類型直轉的。
YAML作配置文件也不錯。好比Ruby on Rails的配置就選用的YAML。對ROR而言，這很天然，也很省事.
因爲兼容性問題，不一樣語言間的數據流轉建議如今不要用YAML.
YAML存在的意義
不管多麼完美的事物，都須要有對立面，有說「NO」的聲音。XML也不例外。固然，站在主流的對立面，須要勇氣和智慧。
YAML和XML不一樣，沒有本身的數據類型的定義，而是使用實現語言的數據類型。這一點，有多是出奇制勝的地方，也多是一個敗筆。若是兼容性保證的很差的話，YAML數據在不一樣語言間流轉會有問題。若是兼容性好的話，YAML就會成爲不一樣語言間數據流通的橋樑。建議yaml.org設立兼容認證機制，每一個語言的實現必須經過認證。
假如兼容性沒問題的話，YAML就太完美了。輕巧，敏捷，高效，簡便，通用。這纔是理想中的數據模型。固然就如今而言，這還只是個理想。