手把手帶你YAML快速入門

    我們學(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屬性值位隶;

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,使用縮進(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í)就到這里了栓始,想要了解更多資訊,等待下期喲

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末血当,一起剝皮案震驚了整個濱河市幻赚,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌臊旭,老刑警劉巖落恼,帶你破解...
    沈念sama閱讀 206,839評論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異离熏,居然都是意外死亡佳谦,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,543評論 2 382
  • 文/潘曉璐 我一進(jìn)店門滋戳,熙熙樓的掌柜王于貴愁眉苦臉地迎上來钻蔑,“玉大人,你說我怎么就攤上這事奸鸯∵湫Γ” “怎么了?”我有些...
    開封第一講書人閱讀 153,116評論 0 344
  • 文/不壞的土叔 我叫張陵娄涩,是天一觀的道長窗怒。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么扬虚? 我笑而不...
    開封第一講書人閱讀 55,371評論 1 279
  • 正文 為了忘掉前任努隙,我火速辦了婚禮,結(jié)果婚禮上孔轴,老公的妹妹穿的比我還像新娘剃法。我一直安慰自己,他們只是感情好路鹰,可當(dāng)我...
    茶點故事閱讀 64,384評論 5 374
  • 文/花漫 我一把揭開白布贷洲。 她就那樣靜靜地躺著,像睡著了一般晋柱。 火紅的嫁衣襯著肌膚如雪优构。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,111評論 1 285
  • 那天雁竞,我揣著相機(jī)與錄音钦椭,去河邊找鬼。 笑死碑诉,一個胖子當(dāng)著我的面吹牛彪腔,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播进栽,決...
    沈念sama閱讀 38,416評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼德挣,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了快毛?” 一聲冷哼從身側(cè)響起格嗅,我...
    開封第一講書人閱讀 37,053評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎唠帝,沒想到半個月后屯掖,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,558評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡襟衰,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,007評論 2 325
  • 正文 我和宋清朗相戀三年贴铜,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片瀑晒。...
    茶點故事閱讀 38,117評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡阀湿,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出瑰妄,到底是詐尸還是另有隱情,我是刑警寧澤映砖,帶...
    沈念sama閱讀 33,756評論 4 324
  • 正文 年R本政府宣布间坐,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏竹宋。R本人自食惡果不足惜劳澄,卻給世界環(huán)境...
    茶點故事閱讀 39,324評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望蜈七。 院中可真熱鬧秒拔,春花似錦、人聲如沸飒硅。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,315評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽三娩。三九已至庵芭,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間雀监,已是汗流浹背双吆。 一陣腳步聲響...
    開封第一講書人閱讀 31,539評論 1 262
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留会前,地道東北人好乐。 一個月前我還...
    沈念sama閱讀 45,578評論 2 355
  • 正文 我出身青樓,卻偏偏與公主長得像瓦宜,于是被迫代替她去往敵國和親蔚万。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,877評論 2 345

推薦閱讀更多精彩內(nèi)容

  • 01 小城的繁華地段歉提,有一個小小的服裝店笛坦,店名舒窈閣,店里的女主人就是我苔巨。 這幾天...
    如煙似舞閱讀 823評論 9 8
  • 木劍:第十七章:盟主的秘密 連載作品版扩,同步更新,歡迎訂閱和加入書架~ 灰子作于二零一九年四月十八日侄泽。
    灰常出色閱讀 865評論 4 18
  • “萬物皆有裂痕礁芦,那是光照進(jìn)來的地方!”主人公奈娜把這句話演繹者淋漓盡致悼尾。她的裂痕是她與生俱來的妥瑞氏癥柿扣,不能控制自...
    初見四葉草閱讀 594評論 0 0
  • 分析 該控件由兩個部分組成,水果圖片ImageView和底部沿著Path繪制的文字闺魏,ImageView從最高點一邊...
    coder_sunzhan閱讀 675評論 0 3
  • 相遇在人海未状,相識與網(wǎng)絡(luò)。 曾記得一個叫慢時光的地方析桥,她在sz一個角落司草,她有幾家咖啡館艰垂,很多人莫名而來,是因為她的慢...
    羅卜Rob閱讀 174評論 0 1