![b48adad0fe44de748756336d8cb1db48.png](https://i-blog.csdnimg.cn/blog_migrate/a89054d26829c06049ab5c516cbc5ce1.jpeg)
作者:编程新说李新杰
出自:微信公众号“编程新说”
原文:【玩转SpringBoot】配置文件yml的正确打开姿势
序言
在很久以前,Spring的配置文件是基于XML的。它的名字就是applicationContext.xml,没错,就只有这一个xml文件。
它里面配置了所有的东西。但是数据库信息通常会单独拿出来,放入一个properties文件,通常叫db.properties。
后来觉着一个xml里的东西实在太多了,就按功能拆分成几个独立的xml。
spring-dao.xml是dao层,spring-service.xml是service层,spring-tx.xml是事务相关,dispatcher-servlet.xml是web相关。
这么多的xml怎么办呢?很简单,就是在applicationContext.xml里都引用它们即可。
随着JDK在1.5加入了对注解的支持,Spring也慢慢的向注解转化。直至后来一个xml都不剩,全部变为注解,连web.xml都没有了。
是xml不行了,还是注解太牛X了,其实它们是等价的,连官网上都说它们一摸一样,故而不做推荐,让用户根据实际情况自己选择。
不过,最终历史还是抛弃了XML,肯定是多方面的原因,可能如下:
1)人们厌倦了XML,出现审美疲劳
2)试用了注解很爽,一发不可收拾
3)注解代表着先进的生产力,极大提升了效率
4)XML拖沓累赘,注解清爽干脆
5)大家都觉得使用注解比使用XML更牛B。
于是乎,一个辉煌的新时代碾压了一个曾经辉煌的曾经的新时代。
呵呵,历史是什么,就是个车轮。一切皆可碾压。
总之,既有实际实践问题,又有思想意识问题,说不清,道不明。
随着SpringBoot的横空出世,配置文件的概念又发了变化。
SpringBoot强调自动配置(也叫自动装配),所以配置对它来说很重要。
配置文件属于配置的一部分,自然也变得非常重要,于是yml就应势站了起来。
yml从未像现在这样流行,成了新时代的网红。yml配置文件的格式
每种新事物的流行,总会有它比旧事物更好的地方。
作为Java界配置文件鼻祖,非properties文件莫属,它里面的格式就不用再举例了吧。
它是一维非结构化的,一行一个,写多了容易乱。
而yml文件是二维结构化的,有严格的缩进,结果就是层次分明,非常清晰。
而且,常用的配置都能得到支持,这就是它的优势,所以就流行起来了。
一、List配置格式,如下图01:
![25e76f8e5bebf00b0d1ae0aa98f9f8f2.png](https://i-blog.csdnimg.cn/blog_migrate/6013af7b6c0e4d86a119820f0c43b4d5.png)
二、Map配置格式,如下图02:
![c49c7cc976663d27ad6de71fd5a2eda6.png](https://i-blog.csdnimg.cn/blog_migrate/5646ce1effbff62f44e717cca799bb61.png)
三、List套List格式,如下图03:
![ecdd4404403711104864a03b05d7a192.png](https://i-blog.csdnimg.cn/blog_migrate/07d2e3fe1f4fd748b0f79d574a80ebd7.jpeg)
四、List套Map格式,如下图04:
![c996fd8636ddf97f776e085f5c07a63b.png](https://i-blog.csdnimg.cn/blog_migrate/ec7134b8ce6f89a28a881de01d54e867.jpeg)
五、Map套Map格式,如下图05:
![2febc8f338379671423488ea23872665.png](https://i-blog.csdnimg.cn/blog_migrate/1a084728763f5471dcab91c2563dadf3.jpeg)
六、Map套List格式,如下图06:
![ebd58cbd8cee724c0cdf3b5038acc094.png](https://i-blog.csdnimg.cn/blog_migrate/99726a60c38ea29253718625a77d75d0.jpeg)
虽然有些嵌套可能并不适用,这里只是说明yml支持这样的嵌套,如果愿意的话,嵌套层次还可以更深。yml配置文件内容的存储
大家都知道SpringBoot是由Spring发展而来的,Spring里是有Environment这个概念的。
所有的环境变量、系统属性、配置文件内容都会放进去。
通常的配置项都是一些key=value,就和properties文件是一样的。所以Environment底层也是这样实现的。
但到了SpringBoot中,配置文件变为yml了,是二维结构化的,根本没有办法直接用key=value这种形式表示。
但是,yml配置文件的内容还必须要放入到Environment中去。那怎么办呢?看来二者必须要修改其一了。
由于Spring已经很多年了,它里面的很多概念都已经固化下来了,包括Environment内部的结构与实现。
因此,最终选择yml去适配Environment,把二维结构化变为一维非结构化,即把有层次的变为简单的key=value形式。
这在编程里有一个专门的术语,叫扁平化。其实人员管理里面也有扁平化。
具体规则也非常简单,把父子关系用点号(.)表示,把列表索引用中括号([])表示。
把刚刚的配置内容输出来看看,如下图070809:
![e0c23646061b9e81122c82bd85cf4491.png](https://i-blog.csdnimg.cn/blog_migrate/e09dbf3b0e4fdf15566c881bfa6de19a.jpeg)
![af97341a9aa64e708b1b9760ebc896b4.png](https://i-blog.csdnimg.cn/blog_migrate/3c7a0c60dc6187898aa6d4595362ead4.jpeg)
![4e8a20145918ec94aeddb4195f4c8ff0.png](https://i-blog.csdnimg.cn/blog_migrate/4d4e31b4d96422dd02883dead7a702f2.jpeg)
这样就完成了扁平化,就可以存入到Environment中去了。
等号(=)前面的就是key,后面的就是值。直接粗暴的使用yml配置文件内容
由于yml配置文件内容最终会进入Environment中,所以就等于直接粗暴的从Environment中读取值。
此时,key必须要写成上面那样子,否则取不到值。
一、直接从Environment中读取,如下图10:
![52368a8090c5544ef28af1a0b68b8d96.png](https://i-blog.csdnimg.cn/blog_migrate/c9e17bf4eeed52b3df3f1e9a9c92822e.jpeg)
结果输出如下图11:
![4a7b0e374f206217317ad6b4ee3fcd80.png](https://i-blog.csdnimg.cn/blog_migrate/b17e3989ba70d6d85a1756cf5cfef044.jpeg)
二、使用@Value注解,如下图12:
![c95c39ed52b2100fa207a375fbefb333.png](https://i-blog.csdnimg.cn/blog_migrate/664eedf3be258c1f67c0e0849fdcd3b2.jpeg)
结果输出如下图13:
![eba703e84db31bfefb770ee104ac5f33.png](https://i-blog.csdnimg.cn/blog_migrate/dedbcea6ffa6d451bbd061ec69dd4190.jpeg)
这就是简单粗暴的方式,除了看上去不美观之外,还把yml的结构化特征给丢失了。
其实,还有一个比较严重的问题,就是只能获取到最终key对应的单个值,如果想获取一个List或Map作为返回值,是不行的。优雅的使用yml配置文件内容
key=value这种形式其实就是个Map,而Map其实和Java Bean差的并不多,只不过Bean中是属性名和属性值罢了。
Map套Map就等于Bean套Bean,这样无论结构形式还是语义表达都能很完美的映射过来。
且Bean是强类型的,属性名和属性类型一目了然,比Map强多了。
所以yml配置文件里的内容可以映射为Java里的Bean,这就是SpringBoot推荐的优雅的使用方式。
这里的核心问题就是,yml里的配置项要和Bean中的属性名称和类型对应好,不然会出问题。
下面请看一个示例,自己瞎编了一个游泳比赛的得分和奖品的配置。
含有一等奖、二等奖、三等奖的得分区间,和它们分别对应的奖品名称和数量。
如下图14:
![8a46a3a067039b33b9a6e8aa10a19d76.png](https://i-blog.csdnimg.cn/blog_migrate/fdd2e891ace560bf0938ff13f7ae8f2f.jpeg)
可以看到scores对应的是一个列表,它有三个元素,每个元素都有level、lowBound、highBound三个属性。
awards对应一个Map,它有三个key,分别是level1、level2、level3,每个key对应的值又是一个列表。
且列表都含有两个元素,且每个元素都有name、count两个属性。
如果这个明白了,下面请看它对应的Bean,如下图15:
![f63543b703dd90bcb9217f28b819833a.png](https://i-blog.csdnimg.cn/blog_migrate/6a98bb4d5e9bdc5dcab365f7e80c15db.jpeg)
Score和Award是两个静态内部类。一个有三个属性,一个有两个属性。
ScoreProperties类中有两个属性,一个是scores,类型是List<Score>。
一个是awards,类型是Map<String, List<Award>>。
可以看出,它们和yml的结构是完全吻合的。没有难度吧。
为了使它用起来更优雅,SpringBoot定义了两个注解来助它一臂之力。
首先,在Bean上标上@ConfigurationProperties,表示它是一个“配置属性”。
如下图16:
![5d92969684d2042a9eaf03fd43d079c8.png](https://i-blog.csdnimg.cn/blog_migrate/8db2085429c439def87a8a20f8aeace8.jpeg)
其次,在另一个类上使用@EnableConfigurationProperties注解将其引入。
如下图17:
![a5abe79195a333972827f059f3d85648.png](https://i-blog.csdnimg.cn/blog_migrate/003229e03e1043afd5438a5b41c97ad8.jpeg)
经过这两步,这个“配置属性”类就已经被注册到容器里了,就变成一个普通的bean了。
这样就可以把它注入到需要的地方,如下图18:
![bbe8ed23b7f3c446e84b3fbca431aced.png](https://i-blog.csdnimg.cn/blog_migrate/9c416135712b49619a6e3cb181de2cad.jpeg)
使用的是构造方法注入,并输出一下它的值,看看和yml中配置的是否一样。
结果如下图19:
![b10381452a7bd457af8f422cd7fad52e.png](https://i-blog.csdnimg.cn/blog_migrate/265666de3ca90d475f807a77517cbe93.jpeg)
可以看到,完全没有问题。这就是SpringBoot推荐的方式。
SpringBoot框架内部的源码都是这样用的。
既然“配置属性”类最后注册了bean定义,那可不可用常规的bean定义注册方式呢?
试试就知道了,如下图20:
![1a3d675eb6be91571b4532a59653def8.png](https://i-blog.csdnimg.cn/blog_migrate/0dec1a657de315f3f0ae19e6f29cefaa.jpeg)
可以看出,这里使用的@Component注解。
这样的话,就不再需要另一个注解引入了,把它注释掉,如下图21:
![2db3e3f4870963768a1b4a5995cecf94.png](https://i-blog.csdnimg.cn/blog_migrate/81eafd260cf91589b5e11f06fffd92b4.jpeg)
其它的都保持不变。然后进行测试,发现完全可以。
不过还是推荐使用SpringBoot指定的方式,因为SpringBoot可以对这种方式进行特殊的优化处理。
比如使用@Validated进行验证。还可以把@NestedConfigurationProperty注解标到嵌套的字段上。
这样不会影响属性值的绑定,但是可以让SpringBoot给你在IDE中进行智能提示。
不然在没有源码的情况下,根本不知道“配置属性”类的结构以及属性名和属性类型。
Spring Boot教程:
Java基础、入门、精通、架构师全套资源shimo.im![4f1ab1db30510416b8832c6c44098e91.png](https://i-blog.csdnimg.cn/blog_migrate/aab5dbafc9202a77c96054732dc66edc.png)
![5b4f8b6a3ffc3af56f2771f34ad1ad52.png](https://i-blog.csdnimg.cn/blog_migrate/994e5afa5729cc99179bc2e588276cb0.jpeg)
![b4ded30a75c18a925356e8d1391f9b7f.png](https://i-blog.csdnimg.cn/blog_migrate/1cd4e9bac622ced0abfb2002b1119dd5.jpeg)