# 编程免不了要写配置文件,怎么写配置也是一门学问。
#
# YAML 是专门用来写配置文件的语言,非常简洁和强大,远比 JSON 格式方便。
#
# YAML在python语言中有PyYAML安装包,下载地址:https://pypi.python.org/pypi/PyYAML
#
# 一、简介
# YAML 语言(发音 /ˈjæməl/ )的设计目标,就是方便人类读写。它实质上是一种通用的数据串行化格式。
#
# 它的基本语法规则如下:
#
# 1、大小写敏感
#
# 2、使用缩进表示层级关系
#
# 3、缩进时不允许使用Tab键,只允许使用空格。
#
# 4、缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
#
# 5、# 表示注释,从这个字符一直到行尾,都会被解析器忽略,这个和python的注释一样
#
#
#
# YAML 支持的数据结构有三种:
#
# 1、对象:键值对的集合,又称为映射(mapping)/ 哈希(hashes) / 字典(dictionary)
#
# 2、数组:一组按次序排列的值,又称为序列(sequence) / 列表(list)
#
# 3、纯量(scalars):单个的、不可再分的值。字符串、布尔值、整数、浮点数、Null、时间、日期
#YAML格式
environments:
dev:
url: http://dev.bar.com
name: Developer Setup
prod:
url: http://foobar.com
name: cool
my:
servers:
- dev.bar.com
- foo.bar.com
# 可以直观的看到,YAML使用冒号加缩进的方式代表层级(属性)关系,使用短横杠(-)代表数组元素。
# 经过这个示例的演示,可以很明显的看到YAML针对properties文件的优异之处。
# 下面立刻展示YAML最基本,最常用的一些使用格式:
# 首先YAML中允许表示三种格式,分别是常量值,对象和数组
# 例如:
# 表示URL属性值
url: http://www.code.com
# 表示server.host属性的值
server:
- 120.168.117.21
- 120.168.117.22
#常量
pi: 3.14#定义一个数值3.14
hasChild: true#定义一个boolean值
name: '你好YAML' #定义一个字符串
# 注释
# 和properties 相同,使用#作为注释,YAML中只有行注释
# 基本格式要求
#1 YAML大小写敏感
#2 使用缩进代表层级关系
#3,缩进只能使用空格,不能使用TAB,不要求空格个数,只需要相同层级左对齐(一般2个或4个空格)
#使用冒号代表,格式为key: value。冒号后面要加一个空格:
#key: value
# 可以使用缩进表示层级关系;
#key:
# child-key: value
# child-key2: value2
# YAML 中还支持流式(flow)语法表示对象
# key: {child-key: value, child-key2: value2}
# 较为复杂的对象格式,可以使用问号加一个空格代表一个复杂的key,配合一个冒号加 一个空格代表一个value:
?
- complexkey1
- complexkey2
:
- complexvalue1
- complexvalue2
# 意思即对象的属性是一个数组[complexkey1,complexkey2],对应的值也是一个数组[complexvalue1,complexvalue2]
# 数组 使用一个横线加一个空格代表一个数组项:
hobby:
-Java
-LOL
# 当然也可以有这样的写法
-
- Java
- LOL
# 可以简单理解为:[[Java,LOL]]
# 一个相对复杂的例子:
companies:
-
id: 1
name: company1
price: 200W
-
id: 2
name: company2
price: 500W
# 意思是companies属性是一个数组,每一个数组元素又是由id,name,price三个属性构成;
# 数组也可以使用流式flow 的方式表示
# companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]
# 常量
# YAML 中提供了多种常量结构, 包括: 整数,浮点数,字符串,NULL,日期,布尔,时间,例子如下
boolean:
- TRUE#true,True
- FALSE#false False 都可以
floar:
- 3.14
- 6.8523015e+5#可以使用科学计数法
int:
- 123
- 0b1010_0111#二进制表示
null:
nodeName: 'node'
parent: ~#使用~表示null
string:
- 哈哈
-'Hello world' #可以使用双引号或者单引号包裹特殊字符
- newline
newline2#字符串可以拆成多行,每一行都会转化成一个空格
date:
- 2018-02-17T15:02:31+08:00#日期必须使用ISO 8601 格式,时间和日期之间使用T连接,最后使用+代表时区
#一些特殊符号
# YAML 中提供了很多特殊符号, 例如 --- YAML可以在同一个文件中,使用--表示一个文档的开始;比如springboot中profile的定义
# profile 的定义:
server:
address: 192.168.1.100
---
spring:
profiles: development
server:
address: 172.0.0.
---
spring:
profiles: production
server:
address: 192.168.1.120
#代表定义了两个profile,一个是development, 一个production;也常常使用 --- 来分割不同的内容,比如记录日志
---
Time: 2018-02-17T15:02:31+08:00
User: ed
Warning:
This is an error message for the log file
---
Time: 2018-02-17T15:02:31+08:00
User: ed
Warning:
This is an error message for the log file
#2,... 和---配合使用,在一个配置文件中代表一个文件的结束:
---
time: 20:03:20
player: Sammy
action: strike
...
---
time: 20:03:20
player: Sammy
action: strike
...
# 相当于在一个yaml 文件中连续写了两个yaml配置项
# 3 !! YAML 中使用!!做类型强行转换
string:
- !!str 54321
- !!str 54321
# 相当于把数字和布尔类型转换成字符串,当然允许转型的类型很多 ,比如
--- !!set
-Mark McGwire: 65
-Sammy Sosa: 63
-Sammy Sosa: 63
-Ken Griffy: 58
# 将数组解析为set,简单理解 转换的内容就是 [{Ken Griffy=58}, {Mark McGwire=65}, {Sammy Sosa=63}],重复的Sammy Sosa去掉;
# >在字符串中折叠换行,| 保留换行符,这两个符号是YAML中字符串经常使用的符号,比如:
accomplishment: >
Mark set a major league
home run record in 1998.
stats: |
65 Home Runs
0.278 Batting Average
# 那么结果是:
stats=65 Home Runs
0.278 Batting Average,
# 即| 符号保留了换行符,而accomplishment的结果为:
# accomplishment=Mark set a major league home run record in 1998.
# 即将换行符转化成了空格;要注意一点的是,每行的文本前一定要有一个空格。
# |符号常见用于在YAML中配置HTML片段:
phraseTemplate: |
<p style="color: red">
some template ${msg}
#5,引用。重复的内容在YAML中可以使用&来完成锚点定义,使用*来完成锚点引用,
#例如:
# hr:
# - Mark McGwire
# - &SS Sammy Sosa
# rbi:
# - *SS
# - Ken Griffey
# 可以看到,在hr中,使用&SS为Sammy Sosa设置了一个锚点(引用),名称为SS,在rbi中,使用*SS完成了锚点使用,那么结果为:
# {rbi=[Sammy Sosa, Ken Griffey], hr=[Mark McGwire, Sammy Sosa]}
# 我们也可以这样定义:
#SS: &SS Sammy Sosa
#hr:
#- Mark McGwire
#- *SS
#rbi:
#- *SS
#- Ken Griffey
#注意,不能独立的定义锚点,比如不能直接这样写: &SS Sammy Sosa;另外,锚点能够定义更复杂的内容,比如:
#default: &default
#- Mark McGwire
#- Sammy Sosa
#hr: *default
#6,合并内容。主要和锚点配合使用,可以将一个锚点内容直接合并到一个对象中。来看一个示例:
#merge:
#- &CENTER { x: 1, y: 2 }
#- &LEFT { x: 0, y: 2 }
#- &BIG { r: 10 }
#- &SMALL { r: 1 }
#
#sample1:
# <<: *CENTER
# r: 10
#
#sample2:
# << : [ *CENTER, *BIG ]
# other: haha
#
#sample3:
# << : [ *CENTER, *BIG ]
# r: 100
# 在merge中,定义了四个锚点,分别在sample中使用。
#sample1中,<<: *CENTER意思是引用{x: 1,y: 2},并且合并到sample1中,那么合并的
# 结果为:sample1={r=10, y=2, x=1}
#sample2中,<<: [*CENTER, *BIG] 意思是联合引用{x: 1,y: 2}和{r: 10},并且合并到sample2中,那么合并的结果为:sample2={other=haha, x=1, y=2, r=10}
#sample3中,引入了*CENTER, *BIG,还使用了r: 100覆盖了引入的r: 10,所以sample3值为:sample3={r=100, y=2, x=1}
#数组
####################################数组###################
# 1、数组可以采用行内表示法。
animal: [Cat, Dog]
#{'animal': ['Cat', 'Dog']}
#2、一组连词线开头的行,构成一个数组。
animal1:
- Cat
- Dog
- Goldfish
# {'animal1': ['Cat', 'Dog', 'Goldfish']}
# 对象
###################################对象####################
#1、对象的一组键值对,使用冒号结构表示。
#animal: pets #{'animal': 'pets'}
#
##2、Yaml 也允许另一种写法,将所有键值对写成一个行内对象
#dict1: { name: Steve, foo: bar } #{'dict1': {'foo': 'bar', 'name': 'Steve'}}
#复合结构
############################复合结构##########################
#对象和数组可以结合使用,形成复合结构
languages:
- Ruby
- Perl
- Python
websites:
YAML: yaml.org
Ruby: ruby-lang.org
Python: python.org
Perl: use.perl.org
#{'languages': ['Ruby', 'Perl', 'Python'], 'websites': {'Python': 'python.org', 'YAML': 'yaml.org', 'Ruby': 'ruby-lang.org', 'Perl': 'use.perl.org'}}
db:
host: xxx
port: 3306
user: weibospider
password: xxx
db_name: weibo
db_type: mysql
#{'db': {'host': 'xxx', 'db_name': 'weibo', 'user': 'weibospider', 'db_type': 'mysql', 'password': 'xxx', 'port': 3306}}
# 纯量
##########################纯量#############################
#1、数值直接以字面量的形式表示
number: 12.30#{'number': 12.3}
#2、布尔值用true和false表示
isSet: true#{'isSet': True}
isSet1: false#{'isSet1': False}
3、null用~表示
parent: ~#{'parent': None}
#4、时间采用 ISO8601 格式。
time1: 2001-12-14t21:59:43.10-05:00#{'time1': datetime.datetime(2001, 12, 15, 2, 59, 43, 100000)}
##5、日期采用复合 iso8601 格式的年、月、日表示。
date: 2017-07-31#{'date': datetime.date(2017, 7, 31)}
#6、YAML 允许使用两个感叹号,强制转换数据类型。
int_to_str: !!str 123#{'bool_to_str': 'true'}
# YAML应用
# 这里主要是记录一下YAML在Python语言中的应用。类比于json库,yaml库与其有惊人的相似之处。一个load方法,一个dump方法。顾名知义,也比较的好理解。
# coding:utf-8
# import os
#
# import sys
# reload(sys)
# sys.setdefaultencoding('utf8')
#
# from yaml import load
# config_path = os.path.join(os.path.dirname(__file__), 'tt.yaml')
#
#
#with open(config_path,'rb') as f:
# cont = f.read()
#
# cf = load(cont)
#
# print cf.get('db')
# # 输出:{'host': 'xxx', 'db_name': 'weibo', 'user': 'weibospider', 'db_type': 'mysql', 'password': 'xxx', 'port': 3306}
# print '------------------'
#
# print cf
#
## 输出:
# '''
#{'
#dict1': {'foo': 'bar', 'name': 'Steve'},
#'animal1': ['Cat', 'Dog', 'Goldfish'],
#'parent': None,
#'bool_to_str': 'true',
#'db': {'host': 'xxx', 'db_name': 'weibo', 'user': 'weibospider', 'db_type': 'mysql', 'password': 'xxx', 'port': 3306},
#'number': 12.3,
#'websites': {'Python': 'python.org', 'YAML': 'yaml.org', 'Ruby': 'ruby-lang.org', 'Perl': 'use.perl.org'},
#'time1': datetime.datetime(2001, 12, 15, 2, 59, 43, 100000),
#'languages': ['Ruby', 'Perl', 'Python'],
#'animal': ['Cat', 'Dog'],
#'date': datetime.date(2017, 7, 31),
#'int_to_str': '123',
#'isSet': True,
#'isSet1': False}
# '''
####################################数组###################
# 1、数组可以采用行内表示法。
#animal: [Cat, Dog]
#{'animal': ['Cat', 'Dog']}
#2、一组连词线开头的行,构成一个数组。
#animal1:
#- Cat
#- Dog
#- Goldfish
# {'animal1': ['Cat', 'Dog', 'Goldfish']}
# 1,YAML1.2规范:http://yaml.org/spec/1.2/spec.pdf
# 2,JS-YAML在线示例:http://nodeca.github.io/js-yaml/