Spring Boot中的yaml配置简介

搞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名字,自己定义的话,需要在项目启动时指定配置文件的名字,像下面这样:

Spring Boot中的yaml配置简介

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

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

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

配置方式如下:

Spring Boot中的yaml配置简介

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

数组注入

yaml也支持数组注入,例如

  
  
  
  1. my:

  2. servers:

  3. - dev.example.com

  4. - another.example.com

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

  
  
  
  1. @ConfigurationProperties(prefix="my")

  2. @Component

  3. public class Config {


  4. private List<String> servers = new ArrayList<String>();


  5. public List<String> getServers() {

  6. return this.servers;

  7. }

  8. }

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

  
  
  
  1. redis:

  2. redisConfigs:

  3. - host: 192.168.66.128

  4. port: 6379

  5. - host: 192.168.66.129

  6. port: 6380

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

  
  
  
  1. @Component

  2. @ConfigurationProperties(prefix = "redis")

  3. public class RedisCluster {

  4. private List<SingleRedisConfig> redisConfigs;

  5. //省略getter/setter

  6. }

优缺点

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

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


往期精彩回顾

2019新年福利,新书免费送!
Docker教程
Redis教程
SpringCloud教程
Git教程
MongoDB教程
SpringBoot+Vue前后端分离开源项目-微人事
SpringBoot+Vue前后端分离开源项目-V部落

Spring Boot中的yaml配置简介

本文分享自微信公众号 - 江南一点雨(a_javaboy)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。

版权声明:程序员胖胖胖虎阿 发表于 2022年8月29日 下午10:56。
转载请注明:Spring Boot中的yaml配置简介 | 胖虎的工具箱-编程导航

相关文章

暂无评论

暂无评论...