Java作為高級(jí)編譯程序的元老,以一處編譯到處運(yùn)行的特點(diǎn)奠旺,廣受開(kāi)發(fā)者喜愛(ài)
我們學(xué)習(xí)Java宦棺,都是先介紹properties文件,使用properties文件配合Properties對(duì)象能夠很方便的適用于應(yīng)用配置上箕戳。然后在引入XML的時(shí)候某残,我們介紹properties格式在表現(xiàn)層級(jí)關(guān)系和結(jié)構(gòu)關(guān)系的時(shí)候,十分欠缺陵吸,而XML在數(shù)據(jù)格式描述和較復(fù)雜數(shù)據(jù)內(nèi)容展示方面玻墅,更加優(yōu)秀。到后面介紹JSON格式的時(shí)候壮虫,我們發(fā)現(xiàn)JSON格式比較XML格式澳厢,更加方便(除去數(shù)據(jù)格式限制之外),所以現(xiàn)在很多配置文件(比如Nginx和大部分腳本語(yǔ)言的配置文件)都習(xí)慣使用JSON的方式來(lái)完成囚似,包括Springboot的出現(xiàn)目的也是在一定程度上去掉XML的繁瑣配置剩拢。
在Springboot中,推薦使用properties或者YAML文件來(lái)完成配置饶唤,但是對(duì)于較復(fù)雜的數(shù)據(jù)結(jié)構(gòu)來(lái)說(shuō)徐伐,YAML又遠(yuǎn)遠(yuǎn)優(yōu)于properties。本文就快速介紹YAML的常見(jiàn)語(yǔ)法格式募狂。
先來(lái)看一個(gè)Springboot中的properties文件和對(duì)應(yīng)YAML文件的對(duì)比:
properties(示例來(lái)源于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
可以明顯的看到办素,在處理層級(jí)關(guān)系的時(shí)候,properties需要使用大量的路徑來(lái)描述層級(jí)(或者屬性)祸穷,比如environments.dev.url和environments.dev.name性穿。其次,對(duì)于較為復(fù)雜的結(jié)構(gòu)粱哼,比如數(shù)組(my.servers)季二,寫(xiě)起來(lái)更為復(fù)雜。而對(duì)應(yīng)的YAML格式文件就簡(jiǎn)單很多:
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使用冒號(hào)加縮進(jìn)的方式代表層級(jí)(屬性)關(guān)系胯舷,使用短橫杠(-)代表數(shù)組元素刻蚯。經(jīng)過(guò)這個(gè)示例的演示,可以很明顯的看到Y(jié)AML針對(duì)properties文件的優(yōu)異之處桑嘶。
快速入門(mén)
下面立刻展示YAML最基本炊汹,最常用的一些使用格式:首先YAML中允許表示三種格式,分別是常量值逃顶,對(duì)象和數(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 #定義一個(gè)數(shù)值3.14
hasChild: true #定義一個(gè)boolean值
name: '你好YAML' #定義一個(gè)字符串
注釋
和properties相同霸褒,使用#作為注釋?zhuān)琘AML中只有行注釋。
基本格式要求
1盈蛮,YAML大小寫(xiě)敏感废菱;2,使用縮進(jìn)代表層級(jí)關(guān)系抖誉;3殊轴,縮進(jìn)只能使用空格,不能使用TAB袒炉,不要求空格個(gè)數(shù)旁理,只需要相同層級(jí)左對(duì)齊(一般2個(gè)或4個(gè)空格)
對(duì)象
使用冒號(hào)代表,格式為key: value我磁。冒號(hào)后面要加一個(gè)空格:
key: value
可以使用縮進(jìn)表示層級(jí)關(guān)系孽文;
key:
child-key: value
child-key2: value2
YAML中還支持流式(flow)語(yǔ)法表示對(duì)象,比如上面例子可以寫(xiě)為:
key: {child-key: value, child-key2: value2}
較為復(fù)雜的對(duì)象格式十性,可以使用問(wèn)號(hào)加一個(gè)空格代表一個(gè)復(fù)雜的key叛溢,配合一個(gè)冒號(hào)加一個(gè)空格代表一個(gè)value:
?
- complexkey1
- complexkey2
:
- complexvalue1
- complexvalue2
意思即對(duì)象的屬性是一個(gè)數(shù)組[complexkey1,complexkey2],對(duì)應(yīng)的值也是一個(gè)數(shù)組[complexvalue1,complexvalue2]
數(shù)組
使用一個(gè)短橫線(xiàn)加一個(gè)空格代表一個(gè)數(shù)組項(xiàng):
hobby:
- Java
- LOL
當(dāng)然也可以有這樣的寫(xiě)法:
- Java
- LOL
可以簡(jiǎn)單理解為:[[Java,LOL]]一個(gè)相對(duì)復(fù)雜的例子:
companies: - id: 1
name: company1
price: 200W - id: 2
name: company2
price: 500W
意思是companies屬性是一個(gè)數(shù)組劲适,每一個(gè)數(shù)組元素又是由id,name,price三個(gè)屬性構(gòu)成;數(shù)組也可以使用流式(flow)的方式表示:
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]
常量
YAML中提供了多種常量結(jié)構(gòu)厢蒜,包括:整數(shù)霞势,浮點(diǎn)數(shù),字符串斑鸦,NULL愕贡,日期,布爾巷屿,時(shí)間固以。下面使用一個(gè)例子來(lái)快速了解常量的基本使用:
boolean: - TRUE #true,True都可以
- FALSE #false,F(xiàn)alse都可以
float: - 3.14
- 6.8523015e+5 #可以使用科學(xué)計(jì)數(shù)法
int: - 123
- 0b1010_0111_0100_1010_1110 #二進(jìn)制表示
null:
nodeName: 'node'
parent: ~ #使用~表示null
string: - 哈哈
- 'Hello world' #可以使用雙引號(hào)或者單引號(hào)包裹特殊字符
- newline
newline2 #字符串可以拆成多行,每一行會(huì)被轉(zhuǎn)化成一個(gè)空格
date: - 2018-02-17 #日期必須使用ISO 8601格式憨琳,即yyyy-MM-dd
datetime: - 2018-02-17T15:02:31+08:00 #時(shí)間使用ISO 8601格式诫钓,時(shí)間和日期之間使用T連接,最后使用+代表時(shí)區(qū)
一些特殊符號(hào)
YAML中提供了很多特殊符號(hào)篙螟,在這里簡(jiǎn)單介紹常用的一些:1菌湃,--- YAML可以在同一個(gè)文件中,使用---表示一個(gè)文檔的開(kāi)始遍略;比如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
代表定義了兩個(gè)profile惧所,一個(gè)是development,一個(gè)production绪杏;也常常使用---來(lái)分割不同的內(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,... 和---配合使用蕾久,在一個(gè)配置文件中代表一個(gè)文件的結(jié)束:
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
time: 20:03:47
player: Sammy Sosa
action: grand slam
...
相當(dāng)于在一個(gè)yaml文件中連續(xù)寫(xiě)了兩個(gè)yaml配置項(xiàng)势似。
3,!! YAML中使用!!做類(lèi)型強(qiáng)行轉(zhuǎn)換:
string:
- !!str 54321
- !!str true
相當(dāng)于把數(shù)字和布爾類(lèi)型強(qiáng)轉(zhuǎn)為字符串腔彰。當(dāng)然允許轉(zhuǎn)型的類(lèi)型很多叫编,比如:
--- !!set
- Mark McGwire: 65
- Sammy Sosa: 63
- Sammy Sosa: 63
- Ken Griffy: 58
將數(shù)組解析為set,簡(jiǎn)單理解霹抛,轉(zhuǎn)化的內(nèi)容就是:[{Ken Griffy=58}, {Mark McGwire=65}, {Sammy Sosa=63}]搓逾,重復(fù)的Sammy Sosa去掉;
4杯拐,>在字符串中折疊換行霞篡,| 保留換行符,這兩個(gè)符號(hào)是YAML中字符串經(jīng)常使用的符號(hào)端逼,比如:
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,
即| 符號(hào)保留了換行符朗兵,而accomplishment的結(jié)果為:
accomplishment=Mark set a major league home run record in 1998.
即將換行符轉(zhuǎn)化成了空格;要注意一點(diǎn)的是顶滩,每行的文本前一定要有一個(gè)空格余掖。|符號(hào)常見(jiàn)用于在YAML中配置HTML片段:
phraseTemplate: |
<p style="color: red">
some template ${msg}
</p>
5,引用礁鲁。重復(fù)的內(nèi)容在YAML中可以使用&來(lái)完成錨點(diǎn)定義盐欺,使用*來(lái)完成錨點(diǎn)引用,例如:
hr: - Mark McGwire
- &SS Sammy Sosa
rbi: - *SS
- Ken Griffey
可以看到仅醇,在hr中冗美,使用&SS為Sammy Sosa設(shè)置了一個(gè)錨點(diǎn)(引用),名稱(chēng)為SS析二,在rbi中粉洼,使用*SS完成了錨點(diǎn)使用节预,那么結(jié)果為:
{rbi=[Sammy Sosa, Ken Griffey], hr=[Mark McGwire, Sammy Sosa]}
我們也可以這樣定義:
SS: &SS Sammy Sosa
hr: - Mark McGwire
- *SS
rbi: - *SS
- Ken Griffey
注意,不能獨(dú)立的定義錨點(diǎn)属韧,比如不能直接這樣寫(xiě): &SS Sammy Sosa安拟;另外,錨點(diǎn)能夠定義更復(fù)雜的內(nèi)容挫剑,比如:
default: &default- Mark McGwire
- Sammy Sosa
hr: *default
那么hr相當(dāng)于引用了default的數(shù)組去扣,注意,hr: *default要寫(xiě)在同一行樊破。
6愉棱,合并內(nèi)容。主要和錨點(diǎn)配合使用哲戚,可以將一個(gè)錨點(diǎn)內(nèi)容直接合并到一個(gè)對(duì)象中奔滑。來(lái)看一個(gè)示例:
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中,定義了四個(gè)錨點(diǎn)顺少,分別在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ǔ)配置抽取出來(lái)颖低,在不同的子配置中合并引用即可。
以上示例均通過(guò)Snakeyaml測(cè)試通過(guò)
好啦弧烤,今天的Java學(xué)習(xí)就到這里了忱屑,想要了解更多資訊,等待下期喲