您好,登錄后才能下訂單哦!
這篇文章給大家分享的是YAML的常見語法格式。小編覺得挺實用的,因此分享給大家學(xué)習(xí)。如下資料是關(guān)于YAML的常見語法格式的內(nèi)容。
先來看一個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使用冒號加縮進的方式代表層級(屬性)關(guān)系,使用短橫杠(-)代表數(shù)組元素。?經(jīng)過這個示例的演示,可以很明顯的看到Y(jié)AML針對properties文件的優(yōu)異之處。
快速入門
下面立刻展示YAML最基本,最常用的一些使用格式:?首先YAML中允許表示三種格式,分別是常量值,對象和數(shù)組?例如:
#即表示url屬性值;
url: http://www.wolfcode.cn
#即表示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,使用縮進代表層級關(guān)系;?3,縮進只能使用空格,不能使用TAB,不要求空格個數(shù),只需要相同層級左對齊(一般2個或4個空格)
對象
使用冒號代表,格式為key: value。冒號后面要加一個空格:
key: value
可以使用縮進表示層級關(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 #二進制表示
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中使用!!做類型強行轉(zhuǎn)換:
string:
!!str 54321
!!str true
相當(dāng)于把數(shù)字和布爾類型強轉(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測試通過
?
?關(guān)于YAML的常見語法格式就分享到這里了,希望以上內(nèi)容可以對大家有一定的幫助,可以學(xué)到更多知識。如果覺得文章不錯,可以把它分享出去讓更多的人看到。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。