概述
目前github有开源的C# Yaml项目:YamlDotNet和SharpYaml 。SharpYaml Fork自YamlDotNet，但做了不少改进并支持Yaml1.2，不过需要netstandard1.6+。YamlDotNet支持Yaml1.1，需要netstandard1.3+。
Yaml可表示三种类型的数据：Scalar（标量，如字符串、布尔值、整数等)、Sequence（序列，如数组）和Mapping（映射，如字典，键值对等）。
关于Yaml可以参考阮一峰老师的《YAML 语言教程》。
YAML
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: '这是一行字符串' }复制
如果字符串之中包含空格或特殊字符，需要放在引号之中。
单引号和双引号都可以使用，双引号不会对特殊字符转义。
单引号之中如果还有单引号，必须连续使用两个单引号转义。
字符串可以写成多行，从第二行开始，必须有一个单空格缩进。换行符会被转为空格。
多行字符串可以使用|保留换行符，也可以使用>折叠换行.
+表示保留文字块末尾的换行，-表示删除字符串末尾的换行。
引用
锚点&和别名*，可以用来引用。
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' ]复制
基于.NET实例
安装
PM> Install-Package YamlDotNet复制
序列化
首先定义一个Person实体类
public class Person
{
public string Name { get; set; }
public int Age { get; set; }
public float HeightInInches { get; set; }
public Dictionary<string, Address> Addresses { get; set; }
public Person()
{
Addresses = new Dictionary<string, Address>();
}
}
public class Address
{
public string Street { get; set; }
public string City { get; set; }
public string State { get; set; }
public string Zip { get; set; }
}复制
object序列化成yaml
using YamlDotNet.Serialization;
using YamlDotNet.Serialization.NamingConventions;
var person = new Person
{
Name = "Abe Lincoln",
Age = 25,
HeightInInches = 6f + 4f 12f,
Addresses = new Dictionary<string, Address>{
{ "home", new Address() {
Street = "2720 Sundown Lane",
City = "Kentucketsville",
State = "Calousiyorkida"
}},
{ "work", new Address() {
Street = "1600 Pennsylvania Avenue NW",
City = "Washington",
State = "District of Columbia",
Zip = "20500"
}}
}
};
var serializer = new SerializerBuilder()
.WithNamingConvention(CamelCaseNamingConvention.Instance)
.Build();
string yaml = serializer.Serialize(person);
Console.WriteLine(yaml);复制
反序列化
var deserializer = new DeserializerBuilder()
.WithNamingConvention(CamelCaseNamingConvention.Instance) // see height_in_inches in sample yml
.Build();
//yml contains a string containing your YAML
var p = deserializer.Deserialize<Person>(yaml);复制
yaml转成json格式
var deserializer = new DeserializerBuilder().Build();
var yamlObject = deserializer.Deserialize(new StringReader(yaml));
var serializer1 = new SerializerBuilder()
.JsonCompatible()
.Build();
var json = serializer1.Serialize(yamlObject);
Console.WriteLine(json);复制
