[SpringBoot] SpringBoot-05-多环境开发
一、配置多环境
如下例:
# 当前激活的环境为 dev
spring:
profiles:
active: dev
# 日志等级
logging:
level:
root: info
---
# 开发环境
spring:
config:
activate:
on-profile: dev
server:
port: 81
---
#生产环境
spring:
config:
activate:
on-profile: pro
server:
port: 80
---
# 测试环境
spring:
config:
activate:
on-profile: test
server:
port: 82
在 yml 配置文件中,用三个横线分隔不同的环境,spring.config.activate.on-profile 属性表示当前环境名称,没有设置环境名称的部分,会作为默认配置,被所有环境采用,比如上例中的日志等级
spring.config.activate.on-profile 也可以写成 spring.profiles 更简便些,如下例:
# 开发环境
spring:
profiles: dev
但这个写法已经过时了,会被警告
二、激活环境
1. spring.profiles.active 属性
将 spring.profiles.active 属性配置在没有环境名称的部分,即可激活指定环境,如前一部分中的样例
也可以指定多个环境,用逗号分隔或者写成数组
spring:
profiles:
active: env_1, env_2
2. 命令行激活
将项目打成 jar 包,通过 jar 包运行项目时指定 spring.profiles.active 属性值即可,如下:
java -jar 包名.jar --spring.profiles.active=env_1,env_2
激活多个环境时,逗号后不能有空格
即使 yaml 中配置了 spring.profiles.active 的值,还是会按照命令行来激活环境,因为命令行的优先级高于配置文件,同样的,配置文件中的其他属性也可以通过命令行来指定
3. 读取 pom.xml 激活
Maven进阶中可以过滤资源文件,使其能够读取 pom.xml 中的属性
这里就是在 pom 中指定 spring.profiles.active 的值,达到激活环境的目的
yaml 配置文件中这样写:
spring:
profiles:
active: @profiles.active@
SpringBoot 项目中资源文件读取 pom 属性要用 @ 包裹属性名,而不能用 ${ }
pom.xml 中这样写:
<properties>
<profiles.active>env_1, env_2</profiles.active>
</properties>
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
</resource>
</resources>
</build>
如此配置,编译以后 yaml 中的属性值就被替换了
三、配合 Maven 的多环境开发
Maven 进行 package 或者 install 时会进行测试
但我们似乎无法指定测试时的 SpringBoot环境
想要在执行 Maven 命令时指定 SpringBoot 的环境,可以这样:
配置 Maven 多环境,其中包含 SpringBoot 的环境属性,再让 SpringBoot 读取该属性来激活环境
这样在执行 Maven 命令时指定 Maven 的环境即可
Maven 配置:
<profiles>
<profile>
<id>dev</id>
<properties>
<!-- 此处属性值要与 SpringBoot 环境id一致 -->
<profile.active>env_dev</spring.profile.active>
</properties>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
</profile>
<profile>
<id>pro</id>
<properties>
<!-- 此处属性值要与 SpringBoot 环境id一致 -->
<profile.active>env_pro</spring.profile.active>
</properties>
</profile>
</profiles>
SpringBoot 配置:
spring:
profiles:
active: @profile.active@ # 读取 pom 中的 profile.active 属性值
---
spring:
config:
activate:
on-profile: env_dev
# ...
---
spring:
config:
activate:
on-profile: env_pro
使用命令 mvn package -P pro
指定 Maven 的环境为 pro,同时也指定了 SpringBoot 的环境为 env_pro
并且,打好的包中 @profile.active@ 已被替换为 env_pro,运行时不必再指定 SpringBoot 环境