多环境开发配置
在实际开发中,项目的开发环境、测试环境、生产环境的配置信息往往是不一致的(比如数据库连接配置),所以我们需要掌握如何快速切换环境。
Spring 利用 profile 对不同环境提供了不同配置功能的支持,可以通过激活不同的环境版本,实现快速切换环境。
多配置文件
我们在主配置文件编写的时候,文件名可以是 application-{profile}.properties/yml
, 用来指定多个环境版本;
例如:
application-test.properties
代表测试环境配置application-dev.properties
代表开发环境配置
但是 SpringBoot 并不会直接启动这些配置文件,它 默认使用 application.properties 主配置文件
我们需要通过一个配置来选择需要激活的环境:
#比如在配置文件中指定使用dev环境,我们可以通过设置不同的端口号进行测试;
#我们启动SpringBoot,就可以看到已经切换到dev下的配置了;
spring.profiles.active=dev
yaml 的多文档块
和 properties 配置文件中一样,但是使用 yml 去实现则不需要创建多个配置文件,更加方便了
#公共配置信息
server:
port: 8081
#选择要激活的环境块
spring:
profiles:
active: pro
---
server:
port: 8083
spring:
profiles: pro #配置环境的名称
---
server:
port: 8084
spring:
profiles: dev #配置环境的名称
---
server:
port: 8085
spring:
profiles: test #配置环境的名称
注意:如果 yml 和 properties 同时都配置了端口,并且没有激活其他环境,默认会使用 properties 配置文件里的!
配置文件加载位置
外部加载配置文件的方式十分多,我们选择最常用的即可,在开发的资源文件中进行配置!
官方外部配置文件说明参考文档:
springboot 启动会扫描以下位置的 application.properties
或者 application.yml
文件作为 SpringBoot 的默认配置文件:
- 优先级1:项目路径下的 config 文件夹配置文件
- 优先级2:项目路径下配置文件
- 优先级3:资源路径下的 config 文件夹配置文件
- 优先级4:资源路径下配置文件
优先级由高到底,高优先级的配置会覆盖低优先级的配置;
SpringBoot 会从这四个位置全部加载主配置文件,互补配置;
1 级与 2 级一般留做系统打包后设置通用属性,3 级与 4 级一般用于系统开发阶段设置通用属性。
拓展,运维小技巧
指定位置加载配置文件:我们可以通过 spring.config.location
来改变默认的配置文件位置。
项目打包好以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新位置。
这种情况,一般是后期运维做的多,相同配置,外部指定的配置文件优先级是最高的。
java -jar spring-boot-config.jar --spring.config.location=F:/application.properties
java –jar springboot.jar --spring.profiles.active=test
java –jar springboot.jar --server.port=88
java –jar springboot.jar --server.port=88 --spring.profiles.active=test
Maven 与 SpringBoot 多环境兼容
SpringBoot 工程最终由 Maven 来指定自己的 profile 内容,也就是如果二者指定的环境不同,会由 Maven 主导运行环境。
Maven 中设置多环境属性
<profiles>
<!--开发环境-->
<profile>
<id>dev_env</id>
<properties>
<profile.active>dev</profile.active>
</properties>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
</profile>
<!--生产环境-->
<profile>
<id>pro_env</id>
<properties>
<profile.active>pro</profile.active>
</properties>
</profile>
<!--测试环境-->
<profile>
<id>test_env</id>
<properties>
<profile.active>test</profile.active>
</properties>
</profile>
</profiles>
SpringBoot 中引用 Maven 属性
执行 Maven 打包指令
- Maven 指令执行完毕后,生成了对应的包,其中类参与编译,但是配置文件并没有编译,而是直接复制到了包中
- 解决思路:对于源码中非 Java 类的操作,要求加载 Maven 对应的属性,解析${}占位符
对资源文件开启对默认占位符的解析
<build>
<plugins>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<configuration>
<encoding>utf-8</encoding>
<useDefaultDelimiters>true</useDefaultDelimiters>
</configuration>
</plugin>
</plugins>
</build>
- Maven打包加载到属性,打包顺利通过