Spring Boot中的yaml配置简介

电玩女神 2021-10-15 12:43 221阅读 0赞

搞Spring Boot的小伙伴都知道，Spring Boot中的配置文件有两种格式，properties或者yaml，一般情况下，两者可以随意使用，选择自己顺手的就行了，那么这两者完全一样吗？肯定不是啦！本文就来和大伙重点介绍下yaml配置，最后再来看看yaml和properties配置有何区别。

#### 狡兔三窟 ####

首先application.yaml在Spring Boot中可以写在四个不同的位置，分别是如下位置：

1.  项目根目录下的config目录中
2.  项目根目录下
3.  classpath下的config目录中
4.  classpath目录下

四个位置中的application.yaml文件的优先级按照上面列出的顺序依次降低。即如果有同一个属性在四个文件中都出现了，以优先级高的为准。

那么application.yaml是不是必须叫application.yaml这个名字呢？当然不是必须的。开发者可以自己定义yaml名字，自己定义的话，需要在项目启动时指定配置文件的名字，像下面这样：

![640?wx\_fmt=png][640_wx_fmt_png]

当然这是在IntelliJ IDEA中直接配置的，如果项目已经打成jar包了，则在项目启动时加入如下参数：

java -jar myproject.jar --spring.config.name=app

这样配置之后，在项目启动时，就会按照上面所说的四个位置按顺序去查找一个名为app.yaml的文件。当然这四个位置也不是一成不变的，也可以自己定义，有两种方式，一个是使用 `spring.config.location`属性，另一个则是使用 `spring.config.additional-location`这个属性，在第一个属性中，表示自己重新定义配置文件的位置，项目启动时就按照定义的位置去查找配置文件，这种定义方式会覆盖掉默认的四个位置，也可以使用第二种方式，第二种方式则表示在四个位置的基础上，再添加几个位置，新添加的位置的优先级大于原本的位置。

配置方式如下：

![640?wx\_fmt=png][640_wx_fmt_png 1]

这里要注意，配置文件位置时，值一定要以/结尾。

#### 数组注入 ####

yaml也支持数组注入，例如

my:	
      servers:	
        - dev.example.com	
        - another.example.com

这段数据可以绑定到一个带Bean的数组中：

@ConfigurationProperties(prefix="my")	
    @Component	
    public class Config {	
        private List<String> servers = new ArrayList<String>();	
        public List<String> getServers() {	
            return this.servers;	
        }	
    }

项目启动后，配置中的数组会自动存储到servers集合中。当然，yaml不仅可以存储这种简单数据，也可以在集合中存储对象。例如下面这种：

redis:	
      redisConfigs:	
        - host: 192.168.66.128	
          port: 6379	
        - host: 192.168.66.129	
          port: 6380

这个可以被注入到如下类中：

@Component	
    @ConfigurationProperties(prefix = "redis")	
    public class RedisCluster {	
        private List<SingleRedisConfig> redisConfigs;	
        //省略getter/setter	
    }

#### 优缺点 ####

不同于properties文件的无序，yaml配置是有序的，这一点在有些配置中是非常有用的，例如在Spring Cloud Zuul的配置中，当我们配置代理规则时，顺序就显得尤为重要了。当然yaml配置也不是万能的，例如，yaml配置目前不支持@PropertySource注解。

好了，关于YAML的配置就先说这么多，有问题欢迎留言讨论。

▼往期精彩回顾▼ [2019新年福利，新书免费送！][2019] [Docker教程][Docker] [Redis教程][Redis] [SpringCloud教程][SpringCloud] [Git教程][Git] [MongoDB教程][MongoDB] [SpringBoot+Vue前后端分离开源项目-微人事][SpringBoot_Vue_-] [SpringBoot+Vue前后端分离开源项目-V部落][SpringBoot_Vue_-V]

![640?wx\_fmt=png][640_wx_fmt_png 2]

[640_wx_fmt_png]: /images/20211015/0f070cc7b4384dcb9658b6e04b9505b0.png?wx_fmt=png
[640_wx_fmt_png 1]: /images/20211015/aa9d614d20d54a258091c074def1035c.png?wx_fmt=png
[2019]: https://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247484824&idx=1&sn=c1a27990b02775f55824403f6632310c&scene=21#wechat_redirect
[Docker]: https://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247484780&idx=1&sn=00884d2c6f5f53fc46fb5a0b1b001106&scene=21#wechat_redirect
[Redis]: https://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247484570&idx=1&sn=37ffb660b4d1d250bfd89ece438b3f98&scene=21#wechat_redirect
[SpringCloud]: https://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247484185&idx=1&sn=6b72030427bf829c00305bf28ca34de3&scene=21#wechat_redirect
[Git]: https://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247484228&idx=1&sn=ae3b332187e52a55e8aa862678425c4c&scene=21#wechat_redirect
[MongoDB]: https://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247484364&idx=1&sn=5d32131694885c78444ec1b2bb65a7ec&scene=21#wechat_redirect
[SpringBoot_Vue_-]: https://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247484616&idx=1&sn=0d6deb14d54808c033076cff6f646899&scene=21#wechat_redirect
[SpringBoot_Vue_-V]: https://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247484348&idx=1&sn=f3e6f81e873863f494db56305e982ea5&scene=21#wechat_redirect
[640_wx_fmt_png 2]: /images/20211015/89df12bbf62d40b496ad2c4fcf4f2571.png?wx_fmt=png