使用Maven Profile和Spring Profile进行多环境配置
Springboot使用Maven Profile和Spring Profile进行多环境配置
在实际的项目上,一般会分三种环境dev、test、prod来方便我们的开发和部署,要求我们在开发的时候可以方便地进行环境的切换,又要满足在发布版本的时候可以尽可能减少测试人员的配置。
Springboot使用Maven Profile和Spring Profile进行多环境配置
目的
在实际的项目上,一般会分三种环境dev、test、prod来方便我们的开发和部署,要求我们在开发的时候可以方便地进行环境的切换,又要满足在发布版本的时候可以尽可能减少测试人员的配置。
Spring Profile
多环境
为了实现多环境配置,我们可以在本地开发的时候在Resource文件夹下新建不同环境的配置文件,如下图所示:
这时候我们只需要在主配置文件application.yml文件使用spring.profiles.active = dev/test/prod来进行不同环境的切换
spring:
profiles:
active: dev #加载dev配置文件
经过上述步骤,我们即可在本地开发时根据不同的环境进行测试。
主配置文件与不同环境的配置文件
Spring Profile有一个特性即可以在application.yml配置通用的内容,在application-dev.yml文件中配置不同文件的差异化配置,这样可以精简我们的配置文件。配置如下:
1# 主配置文件主要用来存放公共设置,不受环境配置影响
2server:
3 port: 8082 # 指定端口号
4 context-path: /server # 指定访问资源的根路径
5spring:
6 profiles:
7 active: dev
dev配置文件
1# 主要用来存放不同环境差异化配置,包括ftp地址、数据库连接等
2spring:
3 datasource:
4 username: xxx
5 password: xxx
6 url: xxx
7 driver-class-name: oracle.jdbc.driver.OracleDriver
上述解决方案虽然可以解决我们的环境问题,但是不够优雅,还有一些值得优化的地方,比如打包出的配置文件有四个、每次需要手动修改主配置文件的环境信息等。
Maven Profile
Profile配置
Maven 也提供了 Profile 支持,它允许我们在 pom.xml
中定义多个 Profile ,每个 profile 可以指定自己的一些配置、依赖、触发条件等。例如:
1<profiles>
2 <profile>
3 <id>dev</id>
4 <activation>
5 <activeByDefault>true</activeByDefault>
6 </activation>
7 <properties>
8 <profile.active>dev</profile.active>
9 </properties>
10 </profile>
11 <profile>
12 <id>prod</id>
13 <properties>
14 <profile.active>prod</profile.active>
15 </properties>
16 </profile>
17</profiles>
按照上述的配置,我们配置了dev/test/prod三种配置并默认选择dev环境。
资源过滤
在进行打包的时候,我们并不需要把dev或者test等配置文件打包进行,所有我们在打包的时候进行如下配置
1<build>
2 <resources>
3 <resource>
4 <directory>src/main/resources</directory>
5 <!--先排除所有的配置文件-->
6 <excludes>
7 <exclude>application*.yml</exclude>
8 </excludes>
9 </resource>
10 <resource>
11 <directory>src/main/resources</directory>
12 <!--引入所需环境的配置文件-->
13 <filtering>true</filtering>
14 <includes>
15 <include>application.yml</include>
16 <include>application-${profile.active}.yml</include>
17 </includes>
18 </resource>
19 </resources>
20 <plugins>
21 <plugin>
22 <groupId>org.springframework.boot</groupId>
23 <artifactId>spring-boot-maven-plugin</artifactId>
24 <configuration>
25 <classifier>exec</classifier>
26 </configuration>
27 </plugin>
28 </plugins>
29 </build>
主要是分为两个步骤:
- 先排除所有的配置文件
- 引入我们所需要的配置文件,根据${profile.active}来动态指定
熟悉idea的同学都知道,这里的${profile.active}我们在idea的maven的配置处进行快速的切换。
从上面的配置文件可以看出,我们引入了两个配置文件(application.yml),一个是主配置文件,一个是实际环境(application-dev.yml)的配置文件,但是到这里还没有结束。我们知道主配置文件的dev/test/prod在没有使用Maven Profile的时候,我们是需要手动修改的,但是使用Maven Profile之后,我们可以把这个工作交给maven去做。
在application.yml进行下面的修改:
1spring:
2 profiles:
3 active: @profile.active@ #此处由maven的环境选择决定
这样我们就可以完全把配置文件的指定和生成交给maven。
Spring Profile与Maven Profile具体使用
配置如下:
1# 主配置文件主要用来存放公共设置,不受环境配置影响
2server:
3 port: 8082 # 指定端口号
4 context-path: /server # 指定访问资源的根路径
5spring:
6 profiles:
7 active: @profile.active@ #此处由maven的环境选择决定