在Spring Boot項目中配置文件格式可以是.properties格式，也可以是yml格式，但是一般使用yml格式的比較多，yml格式都有什么語法？yml格式怎么配置？本文將詳細的講解yml的具體使用。
簡介
YAML 是一種簡潔的非標記語言(YAML Ain’t Markup Language),YAML以數據為中心，使用空白，縮進，分行組織數據，從而使得表示更加簡潔易讀， 常用于作為配置文件, 比json更加簡潔。
- YAML 1.2 (3rd Edition): http://yaml.org/spec/1.2/spec.html
- js-yaml: https://github.com/nodeca/js-yaml
- YAML轉化JSON: http://nodeca.github.io/js-yaml/
YAML 的設計目標：
- 人類容易閱讀
- 可用于不同程序間的數據交換
- 適合描述程序所使用的數據結構，特別是腳本語言
- 豐富的表達能力與可擴展性
- 易于使用
YAML與XML、JSON比較
- YAML 與 XML：具有 XML 同樣的優點，但比 XML 更加簡單、敏捷等
- YAML 與 JSON
- JSON 可以看作是 YAML 的子集，也就是說 JSON 能夠做的事情，YAML 也能夠做
- YAML 能表示得比 JSON 更加簡單和閱讀，例如“字符串不需要引號”。所以 YAML 容易可以寫成 JSON 的格式，但并不建議這種做
- YAML 能夠描述比 JSON 更加復雜的結構，例如“關系錨點”可以表示數據引用（如重復數據的引用）
YAML的適用范圍
- 由于實現簡單，解析成本很低，YAML特別適合在腳本語言中使用。列一下現有的語言實現：Ruby，JAVA，Perl，Python，php，OCaml，JavaScript。除了Java，其他都是腳本語言.
- YAML比較適合做序列化。因為它是宿主語言數據類型直轉的，由于兼容性問題，不同語言間的數據流轉建議現在不要用YAML.
- YAML做配置文件也不錯。比如Ruby on Rails的配置就選用的YAML。對ROR而言，這很自然，也很省事.
語法：
- 大小寫敏感
- 使用縮進表示層級關系
- 禁止使用tab縮進，只能使用空格鍵 , 建議使用兩個空格
- 縮進的空格數目不重要，只要相同層級的元素左側對齊即可
- # 表示注釋，從這個字符一直到行尾，都會被解析器忽略。
- 字符串可以不用引號，也可以使用單引號或者雙引號
數據結構
- 對象(鍵值表): 鍵值對的集合，又稱為映射（mApping）/ 哈希（hashes） / 字典（dictionary）冒號分隔鍵值對(Key: Value), Key需要頂格寫，前面不能有空格，冒號后面需要有一個空格然后再跟值, 相同的縮進屬于同一個map 例如age: 12
- 數組(列表): 一組按次序排列的值，又稱為序列（sequence） / 列表（list）
- 純量scalar: 數據最小的單位，不可以再分割。
對象和數組可以任意嵌套組合成負責的數據結構。
數據類型: 支持字符串、整數、浮點數、布爾、日期、null、對象、數組
示例
在一個文件中，可同時包含多個文件，并用 ---分隔。選擇性的符號"..."可以用來表示文件結尾（在利用流的通信中，這非常有用，可以在不關閉流的情況下，發送結束信號）
---
# 使用冒號：表示鍵值對, 冒號后面需要有一個空格， key需要頂格寫，前面不能有空格 同一縮進的所有鍵值對屬于一個map
str: 這是一行字符串 # 字符串默認不使用引號表示
str2: '內容： 字符串' # 如果字符串之中包含空格或特殊字符，需要放在引號之中
str3: '內容n字符串' # 單引號和雙引號都可以使用，雙引號不會對特殊字符轉義
str4: "內容n字符串" # 雙引號對特殊字符不轉義
str5: 'labor''s day' # 單引號之中如果還有單引號，需要使用單引號轉義
# 字符串可以寫成多行，從第二行開始，必須有一個單空格縮進。換行符會被轉為空格
str6: 這是一段
多行
字符串
str7: | # "|"表示每行末尾都跟一個換行符
Foo
Bar
str8: > # “>” 最后一行跟一個換行符
Foo
Bar
str9: |
Foo
str10: |+ # +表示保留文字塊末尾的換行
Foo
str11: |- # -表示刪除字符串末尾的換行
Foo
str12: | # 字符串之中可以插入 HTML 標記
<p style="color: red">
段落
</p>
int: 10
float: 9.99
bool: true # true、false
# 時間采用 ISO8601 格式 1點被轉成9點
date: 2015-08-23 # 日期
datetime: 2015-08-23T02:02:00.1z # 日期時間
iso8601: 2015-08-23t21:59:43.10-05:00 # iso8601 日期格式
spaced: 2015-08-23 21:59:43.10 -5 #
# 對象：縮進方式
obj:
field1: x
field2:
field21: xx
field22: xxx
# 對象：行內方式(和json格式差不多)
obj2: { field1: 'x', field2: { field21: 'xx', field22: 'xxx' } }
# 數組：連字符方式，如果元素也是數組就再使用一層縮進
array:
- ele1
- ele2
-
- ele31
- ele32
# 行內方式
array2: [ 'ele1', 'ele2', [ 'ele31', 'ele32' ] ]
# 數組中的原始是對象
array3:
- field1: x
field2: xx
field3: xxx
- field1: x
field2: xx
field3: xxx
set:
? ele
? ele2
# 嵌套方式
nested:
field1: x
arr:
- {field1: x, field2: x, field3: [1, 2, 3]}
- {field1: x, field2: x, field3: [2, 3, 4]}
arr2:
-
- a
- b
-
- c
- c
# 類型轉換: 使用兩個感嘆號跟要轉換的基本數據類型，單引號：用于轉換自定義對象
#下面是內置類型
#!!int # 整數類型
#!!float # 浮點類型
#!!bool # 布爾類型
#!!str # 字符串類型
#!!binary # 也是字符串類型
#!!timestamp # 日期時間類型
#!!null # 空值
#!!set # 集合
#!!omap, !!pairs # 鍵值列表或對象列表
#!!seq # 序列，也是列表
#!!map # 鍵值表
test: !!str 123
# 當鍵是數組或者對象時需要使用問號來標記
?[blue, reg, green]: xxx
?{a:xx, b:xx}: xx
# 錨點和引用
ref:
- &index1 a
- b
- *index1
...
yaml轉成json的結果對比
{ str: '這是一行字符串',
str2: '內容： 字符串',
str3: '內容\n字符串',
str4: '內容n字符串',
str5: 'labor's day',
str6: '這是一段 多行 字符串',
str7: 'FoonBarn',
str8: 'Foo Barn',
str9: 'Foon',
str10: 'Foonn',
str11: 'Foo',
str12: '<p style="color: red">n 段落n</p>n',
int: 10,
float: 9.99,
bool: true,
date: Sun Aug 23 2015 08:00:00 GMT+0800 (CST),
datetime: '2015-08-23T02:02:00.1z',
iso8601: Mon Aug 24 2015 10:59:43 GMT+0800 (CST),
spaced: Mon Aug 24 2015 10:59:43 GMT+0800 (CST),
obj: { field1: 'x', field2: { field21: 'xx', field22: 'xxx' } },
obj2: { field1: 'x', field2: { field21: 'xx', field22: 'xxx' } },
array: [ 'ele1', 'ele2', [ 'ele31', 'ele32' ] ],
array2: [ 'ele1', 'ele2', [ 'ele31', 'ele32' ] ],
array3:
[ { field1: 'x', field2: 'xx', field3: 'xxx' },
{ field1: 'x', field2: 'xx', field3: 'xxx' } ],
set: { ele: null, ele2: null },
nested:
{ field1: 'x',
arr:
[ { field1: 'x', field2: 'x', field3: [ 1, 2, 3 ] },
{ field1: 'x', field2: 'x', field3: [ 2, 3, 4 ] } ],
arr2: [ [ 'a', 'b' ], [ 'c', 'c' ] ] },
test: '123',
'?[blue, reg, green]': 'xxx',
'?{a:xx, b:xx}': 'xx',
ref: [ 'a', 'b', 'a' ] }
Java解析
引入依賴
<!-- https://mvnrepository.com/artifact/org.yaml/snakeyaml --> <dependency> <groupId>org.yaml</groupId> <artifactId>snakeyaml</artifactId> <version>1.20</version> </dependency>
實體類
public class Address {
private Long id;
private String address;
}
public class UserInfo {
private Long userId;
private String username;
}
public class User {
private Long id;
private String name;
private Integer age;
private Date birthday;
private float height;
private double score;
private boolean isVip;
private String[] hobbies;
private List<Address> addresses;
private UserInfo userInfo;
}
測試
public static void main(String[] args) throws Exception {
UserInfo userInfo = new UserInfo(1L, "xiaoming");
Address address = new Address(1L, "上海市浦東新區");
Address address2 = new Address(2L, "北京市朝陽區");
List<Address> addresses = new ArrayList<Address>();
addresses.add(address);
addresses.add(address2);
User user = new User(1L, "小明", 20, new Date(), 178.88f, 99999.99,
true, new String[]{"eat", "drink", "play", "happy"}, addresses, userInfo);
Yaml yaml = new Yaml();
// 寫入文件
yaml.dump(user, new FileWriter("/Users/mengday/Desktop/user.yml"));
// 從文件中讀
User user1 = yaml.loadAs(new FileInputStream(new File("/Users/mengday/Desktop/user.yml")), User.class);
System.out.println(user1.toString());
}
結果
!!com.example.demo.User
addresses:
- {address: 上海市浦東新區, id: 1}
- {address: 北京市朝陽區, id: 2}
age: 20
birthday: 2018-03-13T09:30:38.586Z
height: 178.88
hobbies: [eat, drink, play, happy]
id: 1
name: 小明
score: 99999.99
userInfo: {userId: 1, username: xiaoming}
vip: true
User{id=1, name=’小明’, age=20, birthday=Tue Mar 13 17:30:38 CST 2018, height=178.88, score=99999.99, isVip=true, hobbies=[eat, drink, play, happy], addresses=[Address{id=1, address=’上海市浦東新區’}, Address{id=2, address=’北京市朝陽區’}], userInfo=UserInfo{userId=1, username=’xiaoming’}}
