SpringBoot中如何優雅的讀取yml配置檔案？
YAML是一種簡潔的非標記語言,以資料為中心，使用空白、縮排、分行組織資料，從而使得表示更加簡潔易讀。本文介紹下YAML的語法和SpringBoot讀取該型別配置檔案的過程。
本文目錄
一、YAML基本語法二、YAML支援的資料格式三、讀取yml配置檔案四、測試
一、YAML基本語法
- 以縮排代表層級關係
- 縮排不能使用tab，只能用空格
- 空格個數不重要，但是同一層級必須左對齊
- 大小寫敏感
- 資料格式為，名稱:(空格)值
- 註釋單行用#，只能註釋單行
二、YAML支援的資料格式
- 字面量：數字、字串、布林等不可再分的值
字串預設不需要加單引號或者雙引號，如果加雙引號，它不會轉義字串裡面的特殊字元，而加單引號，則會轉義字串裡面的特殊字元，意思就是將特殊字元直接變為字串輸出。
例子：
key1: 1
key2: true
- 物件：即為鍵值對，key= value
用冒號分隔鍵值對(Key: Value), Key需要頂格寫，前面不能有空格，冒號後面需要有一個空格然後再跟值, 相同的縮排屬於同一個map。
例子：
server:
port: 8888
servlet:
context-path: /
- 陣列：一組按順序排列的值
用-來表示陣列中的一個元素。
例子：
wechat:
mp:
configs:
secret: arr1_secret
token: arr1_token
aesKey: arr1_key
msgDataFormat: JSON
- appid: appid2
token: arr2_token
aesKey: arr2_key
msgDataFormat: JSON
三、讀取yml配置檔案
新建一個spring boot專案spring-boot-encry，按照下面步驟操作。
- 新建配置檔案
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: /
- 新增配置檔案對應的實體類
實體類添加註解，@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;
}
}
- 新增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配置檔案裡的資訊，說明讀取成功。
日誌內容如下：
server.port=8888
wxMpProperties={"configs":[{"aesKey":"arr1_key","appId":"appid1","secret":"arr1_secret","token":"arr1_token"},{"aesKey":"arr2_key","appId":"appid2","secret":"arr2_secret","token":"arr2_token"}]}
到此SpringBoot讀取yml配置檔案功能已經全部實現，有問題歡迎留言溝通哦！
完整原始碼地址： https://github.com/suisui2019/springboot-study
點選文章底部”閱讀原文“可以直達原始碼地址。
推薦閱讀
1.SpringBoot中如何靈活的實現介面資料的加解密功能？
2.SpringBoot中神奇的@Enable*註解？
3.Java中Integer.parseInt和Integer.valueOf，你還傻傻分不清嗎？
4.SpringCloud系列-整合Hystrix的兩種方式
5.SpringCloud系列-利用Feign實現宣告式服務呼叫
限時領取免費Java相關資料，涵蓋了Java、Redis、MongoDB、MySQL、Zookeeper、Spring Cloud、Dubbo/Kafka、Hadoop、Hbase、Flink等高併發分散式、大資料、機器學習等技術。
關注下方公眾號即可免費領取：
Java碎碎念公眾號