SpringBoot 简明教程之项目属性配置（三）：配置文件优先级及多配置切换

客官°小女子只卖身不卖艺 2022-05-12 08:50 200阅读 0赞

# SpringBoot 简明教程之项目属性配置（三）：配置优先级及多环境切换 #

*  SpringBoot 简明教程之项目属性配置（三）：配置优先级及多环境切换
    
     *  配置文件优先级
        
         *  位置优先级
         *  更改默认的配置文件位置
         *  总结
     *  外部配置文件加载
        
         *  总结
     *  多环境切换
     *  源码地址
     *  总结：

在实际的项目开发中，一个项目从开发到上线的过程中会有多个配置环境，比如：

> 开发环境 -> 测试环境 -> 生产环境

所以，如果我们忘记修改了，那就是个伤脑经的问题。幸好，Spring Boot依靠其优先级配置读取的机制来帮助我们从这种困境中走出来。

## 配置文件优先级 ##

### 位置优先级 ###

Springboot 启动会扫描以下位置的application.yml文件作为Spring boot的默认配置文件

> –file:./config/
> 
> –file:./
> 
> –classpath:/config/
> 
> –classpath:/

例如：

首先，我们在【classpath:/】路径下将端口配置为：8080，我们启动Spring Boot项目：

![这里写图片描述][70]

此时，启动的端口是：8080.

接着，我们再在【classpath:/】下创建【config/】文件，并将端口配置为：8081，启动项目：

![这里写图片描述][70 1]

我们发现，即使【classpath:/】下的application.yml未注销的情况下，启动端口依然变成了：8081。

接着，我们再在【file:./】下配置端口为：8082，启动项目：

![这里写图片描述][70 2]

接着，我们再在【file:./】下创建【config/】文件，并将端口配置为：8083，启动项目：

![这里写图片描述][70 3]

经过测试，我们发现这四个位置的配置文件都是可以在Springboot 启动时被读取的，优先级存在以下关系：**file:./config/** > **file:./** > **classpath:/config/**  > **classpath:/**。

然后我们在【classpath:/】下的配置文件中配置访问路径为：/test , 启动项目：  
![这里写图片描述][70 4]

我们发现，除了项目虽然采用了最高优先级的启动端口，但是同时因为最高优先级没有设置启动的路由，所以Spring Boot依然读取了低优先级的配置，所以，Spring Boot采用的是一种**互补配置**，即：最高优先级会覆盖低优先级的配置，但是同时也会读取低优先级中，在高优先级所没有的配置信息。

### 更改默认的配置文件位置 ###

我们可以使用【–spring.config.location=】来更改已经打成Jar包的配置文件。

首先，我们将复制一份application.yml文件到项目目录外（我选择放在D盘下），并将配置文件中的启动端口更改为：8085。

然后我们将项目打成Jar包：

![这里写图片描述][70 5]

然后进入控制台：  
![这里写图片描述][70 6]  
执行命令行：

java -jar springboot-04-0.0.1-SNAPSHOT.jar --spring.config.location=D:\application.yml

![这里写图片描述][70 7]

然后我们就发现，启动的端口变成了：8085端口。

![这里写图片描述][70 8]

但是需要注意的是：**项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置，但是指定的配置文件和默认加载的这些配置文件依然是共同起作用形成互补配置；**

### 总结 ###

配置文件具有优先级，高优先级的配置会覆盖低优先级的配置，且SpringBoot会从这四个位置全部加载主配置文件形成**互补配置**；同时，我们还可以通过**spring.config.location**命令来改变默认的配置文件位置。但同时需要注意的是：**我们项目在打包成Jar包的过程中，**【file:./config/】、【–file:./】下的配置文件是**不会被打包的**，例如，我们直接运行上面打包好的Jar包，我们发现运行的端口为：8081，

![这里写图片描述][70 9]

所以，我们就需要了解下面的外部配置文件加载。

## 外部配置文件加载 ##

SpringBoot官方给出了17种加载的方式，有兴趣的小伙伴可以自行参考：[官方文档][Link 1]

![这里写图片描述][70 10]

我们演示一下其中几个：

1.命令行参数

例如，我们通过命令行指定Jar包的启动端口为：8086，![这里写图片描述][70 11]

![这里写图片描述][70 12]

我们发现，启动端口就已经被更改为：8086了。

2.Jar包外部的配置文件

加入当我们需要修改多个配置信息时，我们就可以编写一个新的配置文件上传，例如：我们创建一个新的文件夹【test】，并将Jar吧和将启动端口更改为：8087的配置文件放在里面：

![这里写图片描述][70 13]

然后，我们运行

![这里写图片描述][70 14]

![这里写图片描述][70 15]

我们就发现启动端口已经被更改。

### 总结 ###

我们对于更改一些比较少的配置信息，我们可以通过命令行的形式实现，但是如果我们更改的内容比较多，我们就可以通过编写新的配置文件的方式实现，其中：**配置文件由jar包外向jar包内进行寻找**，即：jar包外的配置文件优先级高于jar包内的。

## 多环境切换 ##

我们在进行多环境文件配置时，我们可以使用： application-\{profile\}.yml的方式进行命名，例如：

![这里写图片描述][70 16]  
然后，我们在三个配置中，分别设置为：

application.yml

server:
      port: 8083

application-dev.yml

server:
      port: 8084

application-prod.yml

server:
      port: 8085

然后，我们重新启动项目：

![这里写图片描述][70 17]

我们发现端口依然是：8083，那么证明：Spring Boot\*\*默认使用application.properties的配置\*\*；

那么，我们如何将使用其他配置呢？

我们将application.yml修改为：

server:
      port: 8083
    spring:
      profiles:
        active: dev

然后，我们再次启动项目：

![这里写图片描述][70 18]

发现，端口就已经变成了：application-dev.yml文件中的内容，同理，如果我们将【active】的值赋为【prod】，那么就将使用application-prod.yml中的配置文件，这里我们就不再演示。

或许，你会得写这么多的配置文件会不会有点麻烦呢？那么YAML的优势就显示出来了，我们可以使用YAML文件的文档块来进行配置：(先将application-dev.yml、application-prod.yml文件中的内容进行注释)

application.yml

server:
      port: 8083
    spring:
      profiles:
        active: prod
    
    ---
    server:
      port: 8084
    spring:
      profiles: dev  #指定属于哪个配置文件
    
    
    ---
    
    server:
      port: 8085
    spring:
      profiles: prod

我们再重新启动项目：

![这里写图片描述][70 19]

启动的端口就已经变成了：8085。

除此之外，我们还可以通过指定命令行的方式指定配置文件，命令为：

spring.profiles.active=dev

这里就不再演示。

## 源码地址 ##

[源码地址][Link 2]

## 总结： ##

Spring Boot中的配置文是具有优先级制度的，总体上是：高优先级将覆盖低优先级的配置，同时进行互补配置。对于Jar包来说，jar包外的优先级高于Jar包内的，带有spring.profiles的高于不带的。

**关注博主的个人公众号，更多Spring Boot视频学习资源分享~**  
![70 20][]

[70]: /images/20220512/eee5459ad1064789bcace9038cebf313.png
[70 1]: /images/20220512/9eda4eeff7af4e59bb35863be6352dee.png
[70 2]: /images/20220512/5af3e28fd5ab4b668a6e56ccf68f82dc.png
[70 3]: /images/20220512/28465a75e30a483aba968a7fd281e520.png
[70 4]: /images/20220512/0a36071a8dde4e879fc87f14d6a08016.png
[70 5]: /images/20220512/ac44d8a8a9384844bdefe3c4b5e91239.png
[70 6]: /images/20220512/b03c9783c58e4b2fb58c38125c00bec8.png
[70 7]: /images/20220512/073b08ea0d0c4e45ac7db24e697286c3.png
[70 8]: /images/20220512/b5c87a7303504110a522f5c986b3b22a.png
[70 9]: /images/20220512/cc6df11b46184be6b9a9213834b53b85.png
[Link 1]: https://docs.spring.io/spring-boot/docs/2.0.5.RELEASE/reference/htmlsingle/#boot-features-external-config
[70 10]: /images/20220512/9785afc0f86e407d83a5612b62107498.png
[70 11]: /images/20220512/9a8214b7a93243c29d26005b9ea5f208.png
[70 12]: /images/20220512/7c4766175ed44d1cb6e4ea300b147eed.png
[70 13]: /images/20220512/4f2e7165fa3046479f608a483c2d69c2.png
[70 14]: /images/20220512/c8b7b6e14f7d4700b197a1cecd301d03.png
[70 15]: /images/20220512/c19601708b454b80bd19f4e418d1d4e0.png
[70 16]: /images/20220512/2d5f6ae79d624dc1afae2c5e9b79312c.png
[70 17]: /images/20220512/9ed997f8f5d548cd88b0f1486480b7b2.png
[70 18]: /images/20220512/956490b6b0f64579aad9f00da1f9999e.png
[70 19]: /images/20220512/5138d7568d924d60a1611baa2671fe95.png
[Link 2]: https://github.com/cquptrhw/Spring-boot-learning
[70 20]: /images/20220512/8d083d4848c0468c9dd5d862b6afdb5a.png