SpringBoot 多环境配置文件的使用

简介

在实际的的开发中，对于一个工程，经常配置很多个Profile(配置文件)，每个Profile都对应一个完整的全局配置，例如开发环境(application-dev.properties)、测试环境(application-test.properties)、生产环境(application-prod.properties)等。在不同的环境下，配置有可能是不一样的。

Springboot 提供了很多方式，帮助我们实现不同环境应用配置的定制化：我们可以通过 properties 文件、yaml 文件、环境变量和命令行参数定制化配置。
SpringBoot 可以很方便地切换不同场景下的配置文件，激活哪个，其对应的全局配置就生效。

一、配置文件的存放位置

1、当前项目中配置文件

SpringBoot 配置文件可以放置在多种路径下，不同路径下的配置优先级有所不同。默认会扫描这几个放置目录的默认配置文件：

如果这四个位置都有配置文件，那么四个配置文件都会生效，只不过四个配置文件中的相同配置项，生效的是高优先级的配置文件里的配置项。即：优先级由高到底，高优先级的配置会覆盖低优先级的相同配置项，不同的配置项互补配置。

2、外部配置文件

（1）应用场景

在项目已打包运行后，若需要修改配置文件时，可以在 jar 包的外面，新建一个外部配置文件。

（2）激活方式

在运行 jar 包命令后面添加激活外部配置文件的命令参数 （--spring.config.location=文件路径）。

java -jar spring-boot-demo-config-0.0.1-SNAPSHOT.jar --spring.config.location=D:\lhj\application.yml； 

（3）优先级

外部配置文件会覆盖 jar 包中配置文件里相同的配置项信息。即：外部配置文件优先级最高。

二、配置多环境配置文件

1、properties 格式全局配置文件

1、首先必须要有 application.properties 文件，在该文件下可以进行不同环境下共同的配置。
2、然后再写几个不同环境下的配置文件，Spring 官方给出的命名规则是 application-{profile}.properties。
3、如果不做激活配置，默认就使用application.properties。
4、在 application.properties 做激活配置，激活哪个，哪个生效。激活方式如下：

spring.profiles.active = prod

2、yml 格式全局配置文件

（1）多文档块方式配置

YAML 格式全局配置文件，可以在同一个 application.yml 全局配置文件进行多文档块方式配置。

文档块之间用 "---" 隔开，文档块的激活方式如下：

spring:
 profiles:
   active: prod

注意：有两个以上没定义文档块名称的，以最后一个文档块作为全局配置文件，所以文档块记得取名。

（2）yml 文件拆分

为了更方便维护各种环境的配置，可以将 yml 文件拆分。

1）在 src/main/resource 目录下，再创建 yml 配置文件（配置文件中不需要定义 spring.profiles 属性），yml 配置文件命名规则为 application-{profiles}.yml。

2）在 application.yml 做激活配置，激活哪个，哪个生效。

三、多环境配置文件的激活

1、在主配置文件 application.properties 或 application.yml 中激活指定配置文件

同上

2、命令行参数激活指定配置文件

将项目打包成 jar 包，然后在 cmd 运行如下命令启动项目：

java -jar spring-boot-demo-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev； 

在启动项目的时候传入命令行参数 --spring.profiles.active=dev 激活指定配置文件。

3、IDEA 中配置参数激活指定配置文件

（1）运行参数

将 program arguments 的参数设置为 --spring.profiles.active=dev

（2）虚拟机参数

将 VM options 的参数设置为 -Dspring.profiles.active=dev

4、激活方式的优先级

优先级：命令行参数激活 > IDEA参数激活 > 配置文件激活

优先级高的会覆盖优先级低的激活配置