Spring Boot中的yaml配置简介

Love The Way You Lie 2023-06-08 07:00 17阅读 0赞

文章转自江南一点雨：[http://springboot.javaboy.org/2019/0416/spring-boot-yaml][http_springboot.javaboy.org_2019_0416_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名字，自己定义的话，需要在项目启动时指定配置文件的名字，像下面这样：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly90aGlua2luZ2Nhby5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70][]

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

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

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

配置方式如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly90aGlua2luZ2Nhby5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70 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注解，如果想要yml配置和properties配置同时支持@PropertySource注解，需要对DefaultPropertySourceFactory类进行重写扩展，详细可以查看这篇文章： [记一则对SpringBoot@PropertySource不能解析yml和yaml文件的问题][SpringBoot_PropertySource_yml_yaml]

[http_springboot.javaboy.org_2019_0416_spring-boot-yaml]: http://springboot.javaboy.org/2019/0416/spring-boot-yaml
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly90aGlua2luZ2Nhby5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70]: /images/20230531/8a5f10203d4245148c5b024e1f408fe7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly90aGlua2luZ2Nhby5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70 1]: /images/20230531/d5418e260cf445d2a6f25f111625f28b.png
[SpringBoot_PropertySource_yml_yaml]: https://www.jianshu.com/p/ce98dad48e2b