我們學(xué)習(xí)Java汰规,都是先介紹properties文件波附,使用properties文件配合Properties對象能夠很方便的適用于應(yīng)用配置上杂曲。然后在引入XML的時候,我們介紹properties格式在表現(xiàn)層級關(guān)系和結(jié)構(gòu)關(guān)系的時候兽赁,十分欠缺状答,而XML在數(shù)據(jù)格式描述和較復(fù)雜數(shù)據(jù)內(nèi)容展示方面,更加優(yōu)秀刀崖。到后面介紹JSON格式的時候惊科,我們發(fā)現(xiàn)JSON格式比較XML格式,更加方便(除去數(shù)據(jù)格式限制之外)亮钦,所以現(xiàn)在很多配置文件(比如Nginx和大部分腳本語言的配置文件)都習(xí)慣使用JSON的方式來完成馆截,包括Springboot的出現(xiàn)目的也是在一定程度上去掉XML的繁瑣配置。
在Springboot中蜂莉,推薦使用properties或者YAML文件來完成配置蜡娶,但是對于較復(fù)雜的數(shù)據(jù)結(jié)構(gòu)來說,YAML又遠(yuǎn)遠(yuǎn)優(yōu)于properties巡语。本文就快速介紹YAML的常見語法格式翎蹈。
先來看一個Springboot中的properties文件和對應(yīng)YAML文件的對比:
properties(示例來源于Springboot User guide):
environments.dev.url=http://dev.bar.com
environments.dev.name=Developer Setup
environments.prod.url=http://foo.bar.com
environments.prod.name=My Cool App
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com
可以明顯的看到,在處理層級關(guān)系的時候男公,properties需要使用大量的路徑來描述層級(或者屬性),比如environments.dev.url和environments.dev.name合陵。其次枢赔,對于較為復(fù)雜的結(jié)構(gòu),比如數(shù)組(my.servers)拥知,寫起來更為復(fù)雜踏拜。而對應(yīng)的YAML格式文件就簡單很多:
YAML格式
environments:
dev:
url: http://dev.bar.com
name: Developer Setup
prod:
url: http://foo.bar.com
name: My Cool App
my:
servers:
- dev.bar.com
- foo.bar.com
可以直觀的看到,YAML使用冒號加縮進(jìn)的方式代表層級(屬性)關(guān)系低剔,使用短橫杠(-)代表數(shù)組元素速梗。經(jīng)過這個示例的演示,可以很明顯的看到Y(jié)AML針對properties文件的優(yōu)異之處襟齿。
快速入門
下面立刻展示YAML最基本姻锁,最常用的一些使用格式:首先YAML中允許表示三種格式,分別是常量值猜欺,對象和數(shù)組例如:
即表示url屬性值位隶;
即表示server.host屬性的值;
server:
host: http://www.wolfcode.cn
數(shù)組开皿,即表示server為[a,b,c]
server:
- 120.168.117.21
- 120.168.117.22
- 120.168.117.23
常量
pi: 3.14 #定義一個數(shù)值3.14
hasChild: true #定義一個boolean值
name: '你好YAML' #定義一個字符串
注釋
和properties相同涧黄,使用#作為注釋篮昧,YAML中只有行注釋。
基本格式要求
1笋妥,YAML大小寫敏感懊昨;2,使用縮進(jìn)代表層級關(guān)系春宣;3酵颁,縮進(jìn)只能使用空格,不能使用TAB信认,不要求空格個數(shù)材义,只需要相同層級左對齊(一般2個或4個空格)
對象
使用冒號代表,格式為key: value嫁赏。冒號后面要加一個空格:
key: value
可以使用縮進(jìn)表示層級關(guān)系其掂;
key:
child-key: value
child-key2: value2
YAML中還支持流式(flow)語法表示對象,比如上面例子可以寫為:
key: {child-key: value, child-key2: value2}
較為復(fù)雜的對象格式潦蝇,可以使用問號加一個空格代表一個復(fù)雜的key款熬,配合一個冒號加一個空格代表一個value:
?
- complexkey1
- complexkey2
:
- complexvalue1
- complexvalue2
意思即對象的屬性是一個數(shù)組[complexkey1,complexkey2],對應(yīng)的值也是一個數(shù)組[complexvalue1,complexvalue2]
數(shù)組
使用一個短橫線加一個空格代表一個數(shù)組項:
hobby:
- Java
- LOL
當(dāng)然也可以有這樣的寫法:
- Java
- LOL
可以簡單理解為:[[Java,LOL]]一個相對復(fù)雜的例子:
companies: - id: 1
name: company1
price: 200W - id: 2
name: company2
price: 500W
意思是companies屬性是一個數(shù)組攘乒,每一個數(shù)組元素又是由id,name,price三個屬性構(gòu)成贤牛;數(shù)組也可以使用流式(flow)的方式表示:
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]
常量
YAML中提供了多種常量結(jié)構(gòu),包括:整數(shù)则酝,浮點數(shù)殉簸,字符串,NULL沽讹,日期般卑,布爾,時間爽雄。下面使用一個例子來快速了解常量的基本使用:
boolean: - TRUE #true,True都可以
- FALSE #false蝠检,F(xiàn)alse都可以
float: - 3.14
- 6.8523015e+5 #可以使用科學(xué)計數(shù)法
int: - 123
- 0b1010_0111_0100_1010_1110 #二進(jìn)制表示
null:
nodeName: 'node'
parent: ~ #使用~表示null
string: - 哈哈
- 'Hello world' #可以使用雙引號或者單引號包裹特殊字符
- newline
newline2 #字符串可以拆成多行,每一行會被轉(zhuǎn)化成一個空格
date: - 2018-02-17 #日期必須使用ISO 8601格式挚瘟,即yyyy-MM-dd
datetime: - 2018-02-17T15:02:31+08:00 #時間使用ISO 8601格式叹谁,時間和日期之間使用T連接,最后使用+代表時區(qū)
一些特殊符號
YAML中提供了很多特殊符號乘盖,在這里簡單介紹常用的一些:1焰檩,--- YAML可以在同一個文件中,使用---表示一個文檔的開始侧漓;比如Springboot中profile的定義:
server:
address: 192.168.1.100
spring:
profiles: development
server:
address: 127.0.0.1
spring:
profiles: production
server:
address: 192.168.1.120
代表定義了兩個profile锅尘,一個是development,一個production;也常常使用---來分割不同的內(nèi)容藤违,比如記錄日志:
Time: 2018-02-17T15:02:31+08:00
User: ed
Warning:
This is an error message for the log file
Time: 2018-02-17T15:05:21+08:00
User: ed
Warning:
A slightly different error message.
2浪腐,... 和---配合使用,在一個配置文件中代表一個文件的結(jié)束:
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
time: 20:03:47
player: Sammy Sosa
action: grand slam
...
相當(dāng)于在一個yaml文件中連續(xù)寫了兩個yaml配置項顿乒。
3议街,!! YAML中使用!!做類型強(qiáng)行轉(zhuǎn)換:
string:
- !!str 54321
- !!str true
相當(dāng)于把數(shù)字和布爾類型強(qiáng)轉(zhuǎn)為字符串。當(dāng)然允許轉(zhuǎn)型的類型很多璧榄,比如:
--- !!set
- Mark McGwire: 65
- Sammy Sosa: 63
- Sammy Sosa: 63
- Ken Griffy: 58
將數(shù)組解析為set特漩,簡單理解,轉(zhuǎn)化的內(nèi)容就是:[{Ken Griffy=58}, {Mark McGwire=65}, {Sammy Sosa=63}]骨杂,重復(fù)的Sammy Sosa去掉涂身;
4,>在字符串中折疊換行搓蚪,| 保留換行符蛤售,這兩個符號是YAML中字符串經(jīng)常使用的符號,比如:
accomplishment: >
Mark set a major league
home run record in 1998.
stats: |
65 Home Runs
0.278 Batting Average
那么結(jié)果是:
stats=65 Home Runs
0.278 Batting Average,
即| 符號保留了換行符妒潭,而accomplishment的結(jié)果為:
accomplishment=Mark set a major league home run record in 1998.
即將換行符轉(zhuǎn)化成了空格悴能;要注意一點的是,每行的文本前一定要有一個空格雳灾。|符號常見用于在YAML中配置HTML片段:
phraseTemplate: |
<p style="color: red">
some template ${msg}
</p>
5漠酿,引用。重復(fù)的內(nèi)容在YAML中可以使用&來完成錨點定義谎亩,使用*來完成錨點引用炒嘲,例如:
hr: - Mark McGwire
- &SS Sammy Sosa
rbi: - *SS
- Ken Griffey
可以看到,在hr中匈庭,使用&SS為Sammy Sosa設(shè)置了一個錨點(引用)摸吠,名稱為SS,在rbi中嚎花,使用*SS完成了錨點使用,那么結(jié)果為:
{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;另外道逗,錨點能夠定義更復(fù)雜的內(nèi)容兵罢,比如:
default: &default- Mark McGwire
- Sammy Sosa
hr: *default
那么hr相當(dāng)于引用了default的數(shù)組,注意滓窍,hr: *default要寫在同一行卖词。
6,合并內(nèi)容。主要和錨點配合使用此蜈,可以將一個錨點內(nèi)容直接合并到一個對象中即横。來看一個示例:
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中页藻,那么合并的結(jié)果為:sample1={r=10, y=2, x=1}
sample2中,<<: [CENTER, BIG] 意思是聯(lián)合引用{x: 1,y: 2}和{r: 10}植兰,并且合并到sample2中份帐,那么合并的結(jié)果為:sample2={other=haha, x=1, y=2, r=10}
sample3中,引入了CENTER, *BIG楣导,還使用了r: 100覆蓋了引入的r: 10废境,所以sample3值為:sample3={r=100, y=2, x=1}
有了合并,我們就可以在配置中爷辙,把相同的基礎(chǔ)配置抽取出來彬坏,在不同的子配置中合并引用即可。
以上示例均通過Snakeyaml測試通過
好啦膝晾,今天的Java學(xué)習(xí)就到這里了栓始,想要了解更多資訊,等待下期喲