当前位置： 移动技术网 > IT编程>开发语言>Java > SpringBoot中如何优雅的读取yml配置文件？

SpringBoot中如何优雅的读取yml配置文件？

2019年10月30日  | 移动技术网IT编程  | 我要评论

yaml是一种简洁的非标记语言,以数据为中心，使用空白、缩进、分行组织数据，从而使得表示更加简洁易读。本文介绍下yaml的语法和springboot读取该类型配置文件的过程。

本文目录

一、yaml基本语法二、yaml支持的数据格式

一、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;
    }
}
  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配置文件里的信息，说明读取成功。

日志内容如下：

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碎碎念公众号java碎碎念公众号

 

您可能感兴趣的文章:

如对本文有疑问， 点击进行留言回复！！

相关文章:

验证码：
最近更新的文章
大家感兴趣的文章
移动技术网