springboot中spring.profiles.include的妙用分享

spring.profiles.include的妙用

我们有这样的一个SpringBoot项目。项目分为开发、测试、生产三个不同阶段(环境)，每个阶段都会有db、ftp、Redis等的不同配置信息。

我们可以使用spring.profiles.include来实现三种不同环境的一键切换。

项目总(入口)配置文件

bootstrap.yml  ，内容如下

spring.profiles.active:  dev  #dev、test、prod 三种配置可以在这里进行一键切换，默认激活 dev(开发)环境配置

项目开发环境配置文件

application-dev.yml (开发环境入口配置)、application-devDb.yml 、application-devFtp.yml、application-devRedis.yml 

application-dev.yml 中含有如下内容

spring.profiles.include: devDb,devFtp,devRedis

项目测试环境配置文件

application-test.yml (测试环境入口配置)、application-testDb.yml 、application-testFtp.yml、application-testRedis.yml 

application-test.yml 中含有如下内容

spring.profiles.include: testDb,testFtp,testRedis

项目生产环境配置文件

application-prod.yml (生产环境入口配置)、application-prodDb.yml 、application-prodFtp.yml、application-prodRedis.yml 

application-prod.yml 中含有如下内容

spring.profiles.include: prodDb,prodFtp,prodRedis

spring.profiles.include 的作用是可以叠加激活新的profile ，这样可以在总的项目配置(bootstrap.yml)中实现一键切换dev、test、prod三者不同环境, 即 

切换为dev时，同时激活了dev、devDb、devFtp、devRedis 的profile

切换为test时，同时激活了test、testDb、testFtp、testRedis 的profile

切换为prod时，同时激活了prod、prodDb、prodFtp、prodRedis 的profile

另外： 在yml配置文件中配置List<String> 的值，可以采用  -子项 的方式，如 ：

spring.profiles.include:

  - 子项1

  - 子项2

  - 子项3   

也可以采用 逗号分隔元素列表的方式，如： 

spring.profiles.include: 子项1,子项2,子项3    

spring.profiles.active 与spring.profiles.include

spring.profiles.active和spring.profiles.include区别

主要是语意上的区别，实际使用效果相同。

以上两种，在创建不同的配置文件时，命名规则遵循 application-${profile}.properties，

• spring.profiles.active：根据部署场景不同，切换不同的配置文件：配置spring.profiles.active，属性值为${profile}。
• spring.profiles.include：可以用来无条件的添加生效的配置。

将特定的配置属性添加到生效的配置中而不是替换它们。

【格式】： spring.profiles.include: 子项1,子项2,子项3

配置的位置和区别

配置方式一：application.properties中，配置spring.profiles.active=dev的同时指定spring.profiles.include=dev1,dev2

配置方式二：application.properties中，配置spring.profiles.active=dev，application-dev.properties中，配置spring.profiles.include=dev1,dev2。使用application-dev.properties时自动就激活了dev1、dev2两个文件，不用再次指定。（个人认为第二种方法更好）

区别：

第一种方式启动时，控制台打印The following profiles are active:dev1,dev2,dev。

第二种方式启动时，控制台打印The following profiles are active:dev, dev1,dev2。

按照顺序，后面的覆盖前面的。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持编程网。