YAML學習筆記

 

YAML主要用作配置文件,相對操作複雜的XML,YAML顯得格外簡潔;

對比properties,YAML在層級表示方面同樣顯得優秀;

YAML大致語法如下:

YAML中允許表示三種值:常量、數組、對象

#常量
url: bokerr
pie: 3.1415

#數組
-array:
       - bokerr
       - jack
       - tom

#對象
key: {child-key: value, child-key2: value2}

語法要求

YAML對大小寫敏感

YAML使用縮進表示層級

YAML不能使用tab縮進,只能使用空格縮進,不限制空格數量,但要求同級左對齊

對象

使用冒號代表,格式爲key: value。冒號後面要加一個空格

key: 
    child-key: value
    child-key2: value2

較爲複雜的對象格式,可以使用問號加一個空格代表一個複雜的key,配合一個冒號加一個空格代表一個value:

?  
    - complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2

數組

該數組的每個元素由三個屬性組成:

companies:
    -
        id: 1
        name: company1
        price: 200W
    -
        id: 2
        name: company2
        price: 500W

#流式書寫
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]

較簡單的數組實例:

hobby:
    - Java
    - LOL

#簡化書寫
-
    - Java
    - LOL

常量

YAML中提供了多種常量結構,包括:整數,浮點數,字符串,NULL,日期,布爾,時間。下面使用一個例子來快速瞭解常量的基本使用:

boolean: 
    - TRUE  #true,True都可以
    - FALSE  #false,False都可以
float:
    - 3.14
    - 6.8523015e+5  #可以使用科學計數法
int:
    - 123
    - 0b1010_0111_0100_1010_1110    #二進制表示
null:
    nodeName: 'node'
    parent: ~  #使用~表示null
string:
    - 哈哈
    - 'Hello world'  #可以使用雙引號或者單引號包裹特殊字符
    - newline
      newline2    #字符串可以拆成多行,每一行會被轉化成一個空格
date:
    - 2018-02-17    #日期必須使用ISO 8601格式,即yyyy-MM-dd
datetime: 
    -  2018-02-17T15:02:31+08:00    #時間使用ISO 8601格式,時間和日期之間使用T連接,最後使用+代表時區

特殊符號

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

上述代碼表示了兩個profiles:1個development、1個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:05:21+08:00
User: ed
Warning:
    A slightly different error message.

2,... 和---配合使用,在一個配置文件中代表一個文件的結束:

---
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
---
time: 20:03:47
player: Sammy Sosa
action: grand slam
...

---
strss: kdjfk
num: 1332423
strss: !!str 323
...

相當於在一個yaml文件中連續寫了兩個yaml配置項。

3,!! YAML中使用!!做類型強行轉換:

string:
    - !!str 54321
    - !!str true

#--------------------------

string: 
    - !!str true
    - !!str false
    - !!str true

相當於把數字和布爾類型強轉爲字符串。當然允許轉型的類型很多,比如:

--- !!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去掉;

4,>在字符串中摺疊換行,| 保留換行符,這兩個符號是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}
  </p>

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

那麼hr相當於引用了default的數組,注意,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}

有了合併,我們就可以在配置中,把相同的基礎配置抽取出來,在不同的子配置中合併引用即可。

以上示例均通過Snakeyaml測試通過



作者:叩丁狼教育
鏈接:https://www.jianshu.com/p/97222440cd08
來源:簡書
簡書著作權歸作者所有,任何形式的轉載都請聯繫作者獲得授權並註明出處。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章