SpringBoot中如何優雅的讀取yml配置文件？

YAML是一種簡潔的非標記語言,以數據為中心，使用空白、縮進、分行組織數據，從而使得表示更加簡潔易讀。本文介紹下YAML的語法和SpringBoot讀取該類型配置文件的過程。

本文目錄

一、YAML基本語法

1. 以縮進代表層級關係
2. 縮進不能使用tab，只能用空格
3. 空格個數不重要，但是同一層級必須左對齊
4. 大小寫敏感
5. 數據格式為，名稱:(空格)值
6. 註釋單行用#，只能註釋單行

二、YAML支持的數據格式

1. 字面量：數字、字符串、布爾等不可再分的值

字符串默認不需要加單引號或者雙引號，如果加雙引號，它不會轉義字符串裡面的特殊字符，而加單引號，則會轉義字符串裡面的特殊字符，意思就是將特殊字符直接變為字符串輸出。

例子：

key1: 1
key2: true

1. 對象：即為鍵值對，key= value

用冒號分隔鍵值對(Key: Value), Key需要頂格寫，前面不能有空格，冒號後面需要有一個空格然後再跟值, 相同的縮進屬於同一個map。

例子：

server:
 port: 8888
 servlet:
 context-path: /

1. 數組：一組按順序排列的值

用-來表示數組中的一個元素。

例子：

wechat:
 mp:
 configs:
 - appid: appid1
 secret: arr1_secret
 token: arr1_token
 aesKey: arr1_key
 msgDataFormat: JSON
 - appid: appid2
 secret: arr2_secret
 token: arr2_token 

 aesKey: arr2_key
 msgDataFormat: JSON

三、讀取yml配置文件

新建一個spring boot項目spring-boot-encry，按照下面步驟操作。

1. 新建配置文件

application.yml內容如下：

wechat:
 mp:
 configs:
 - appid: appid1
 secret: arr1_secret
 token: arr1_token
 aesKey: arr1_key
 msgDataFormat: JSON
 - appid: appid2
 secret: arr2_secret
 token: arr2_token
 aesKey: arr2_key
 msgDataFormat: JSON
server:
 port: 8888
 servlet:
 context-path: /

1. 添加配置文件對應的實體類

實體類添加註解，@ConfigurationProperties，@ConfigurationProperties註解可以自定義實體類，映射yml或者properties文件，自動為對象bean屬性捆綁數據。

WxMpProperties代碼如下：

@Data
@ConfigurationProperties(prefix = "wechat.mp")
public class WxMpProperties {
 private List<mpconfig> configs;
 @Data
 public static class MpConfig {
 /**
 * 設置微信公眾號的appid
 */
 private String appId;
 /**
 * 設置微信公眾號的app secret
 */
 private String secret;
 /**
 * 設置微信公眾號的token
 */
 private String token;
 /**
 * 設置微信公眾號的EncodingAESKey
 */
 private String aesKey;
 }
}
/<mpconfig>

1. 添加controller

添加讀取yml文件的controller，打印yml配置信息，代碼如下：

/**
 * 讀取yml文件的controller
 *
 * @Authro Java碎碎念
 */
@Slf4j
@RestController
public class TestReadYmlController {
 @Value("${server.port}")
 private Integer port;
 @Autowired 

 private WxMpProperties wxMpProperties;
 @RequestMapping("/readYml")
 public void readYml() {
 log.info("server.port=" + port);
 log.info("wxMpProperties=" + JSON.toJSONString(wxMpProperties));
 }
}

四、測試

打開瀏覽器訪問：http://localhost:8888/readYml，可看到後臺已經打印了yml配置文件裡的信息，說明讀取成功。