通过Maven Profiles的方式进行Spring Boot多环境配置

1. Spring Boot 的 Profile

Profile,即配置文件,spring boot 中通常在 resources 目录内使用 yaml 或 properties 这两种格式的文件进行一些参数的配置,而在项目流程中从开发到测试最终在生产环境上,很多参数会使用不同的配置,为了减少配置文件的频繁修改,spring boot提供了一个参数spring.profiles.active,只要配置文件的命名满足 application-{active} 这个格式,就可以通过在 application.properties(或application.yaml)中的 spring.profiles.active 来指定具体使用的配置文件,比如:


这样配置之后,项目启动时会先从 application-dev.properties 加载配置,再从 application.properties 加载,如果有重复的,那么application.properties 的配置会覆盖掉dev内的配置,也就是以后加载进来的配置为准,另外 spring.profiles.active 取值不是唯一的,可以设置 spring.profiles.active=dev, test, production ,从已存在的多个配置文件中读取参数配置,不过官方并不推荐这种做法,这样不能保证得到预期的属性值(更详细的解释见官方文档:24.Externalized Configuration https://docs.spring.io/spring-boot/docs/2.1.6.RELEASE/reference/html/boot-features-external-config.html)

但是这样还是在每次打包的时候要去修改 spring.profiles.active 这个属性,为了减少文件修改次数,我们想办法在命令参数中去动态指定这个配置,最直接的方式是 java -jar 启动的时候使用 --spring.profiles.active=dev,但是这样在每次启动的时候都要指定这条属性,所以我们想办法在打包的时候就指定这个参数,这样一个项目包在不更改代码的情况下可以重复使用,减少频繁修改文件或命令参数的过程

2. Maven Profiles 指定环境配置

在maven 打包的过程中,maven install 指令提供了 -D 和 -P 两个参数,-D 指的是 properties 属性,而 -P 表示 profiles 配置文件,指定了在 install 时使用 pom.xml 中 的哪个配置,

比如一个 pom.xml 中有

那么就可以使用 maven install -Penv=dev 来指定 env 这个参数等于 dev ,这个参数在 springboot 的 yaml 配置文件中,可以通过@env@ 进行获取,同时,如果在 pom.xml 中的 plugin 设置了 delimiters,也可以增加获取此参数的表达式,比如:


则可以通过 ${env} 进行获取, 需要注意的是,在 setting.xml 中也可以通过 activeProfiles 来指定 profile 属性,比如:


这个 profile 属性会直接加在 spring.profiles.active 的值当中,前面说到了 spring.profiles.active 的值并不是唯一的,如果这个 profile 和我们 maven install -P 指定的不同,那么将会对两个配置文件同时进行读取

通过 maven 打包指定 profiles 的方式也给 yaml 文件中一些属性进行动态配置提供了条件,比如现在同一个 dev 环境需要两个连接不同 DB的工程包,那么可以在 pom.xml 中指定两个不同的 db 连接

然后在 yaml 文件 中指定 spring.datasource.url 为 ${dbUrl} ,在 maven install 时分别指定 -Pdb1 和 -Pdb2 ,则两个工程包在启动时会自动连接到不同的 dbUrl ,其中可以通过添加 activeByDefault 为 true 来设置默认配置

更多具体的profile参数配置,可以前往官方文档查看:https://maven.apache.org/pom.html#Environment_Settings

你可能感兴趣的:(通过Maven Profiles的方式进行Spring Boot多环境配置)