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

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

本文目錄

一、YAML基本語法二、YAML支持的數據格式三、讀取yml配置文件四、測試

一、YAML基本語法

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

二、YAML支持的數據格式

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

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

例子：

key1: 1
key2: true

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

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

例子：

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

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

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

例子：

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: /

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

實體類添加注解，@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;
    }
}

3. 添加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碎碎念公眾號