maven profile自动切换环境参数的2种方法详解

2025-05-29 0 19

前言

痛点:

在java开发的过程中,我们经常要面对各种各样的环境,比如开发环境,测试环境,正式环境,而这些环境对项目的需求也不相同。

在此之前,我们往往需要手动去修改相对应的配置文件然后打成war,才能部署到相应的环境上。

但是这样很容易出现问题,因为很容易出现少改或者漏改,造成不必要的麻烦

幻想:

要是有一种东西,能让我们打war的时候指定一个参数,就能自动把项目编译成对应环境的war,那该有多幸福啊!!!

结果:这样的东西还真有,那就是mavenprofile

在开发过程中,我们经常会根据不同的环境配置不同的参数,如数据源的ip,username,password、url、秘钥等都会不同,传统方式是在一个配置文件中通过修改properties文件中的参数值或者通过注释解注释来达到目的,这样不仅容易出错,还浪费不必要的时间,更重要的是把代码发布到测试环境或者生产环境还容易忘记改。为解决这种问题,maven提供了一种解决方案,就是profile

下图为传统方式,需要来回的注释和解注释

maven profile自动切换环境参数的2种方法详解

profile定义的位置

  • 针对于特定项目的profile配置我们可以定义在该项目的pom.xml中。
  • 针对于特定用户的profile配置,我们可以在用户的settings.xml文件中定义profile。该文件在用户家目录下的“.m2”目录下。
  • 全局的profile配置。全局的profile是定义在maven安装目录下的“conf/settings.xml”文件中的。

filter方式实现

第一步:分别定义application-dev.properties、application-test.properties、application-pro.properties三个文件

application-dev.properties

?

1

2
env.jdbc.username=dev

env.jdbc.password=123456

application-test.properties

?

1

2
env.jdbc.username=test

env.jdbc.password=888888

application-pro.properties

?

1

2
env.jdbc.username=root

env.jdbc.password=666666

第二步:定义总的属性文件application.properties,该文件中的值去引用application-<env>.properties中的key

application.properties

?

1

2

3

4

5

6
// 引用application-<env>中的key

jdbc.username=${env.jdbc.username}

jdbc.password=${env.jdbc.password}

# 公共配置

salt=123456789

第三步:配置profile

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27
<profiles>

<profile>

<!-- 开发环境 -->

<id>dev</id>

<properties>

<env>dev</env>

</properties>

<activation>

<!-- 设置默认激活这个配置 -->

<activebydefault>true</activebydefault>

</activation>

</profile>

<profile>

<!-- 测试环境 -->

<id>test</id>

<properties>

<env>test</env>

</properties>

</profile>

<profile>

<!-- 发布环境 -->

<id>pro</id>

<properties>

<env>pro</env>

</properties>

</profile>

</profiles>

第四步:配置filter和resource

${env}就是在mvn package -p <env>的名字,这样就告诉application.properties中应用的key是那个属性文件的key了

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21
<build>

<finalname>profile-app</finalname>

<!-- 定义了变量配置文件的地址 -->

<filters>

<filter>src/main/resources/config/application/application-${env}.properties</filter>

</filters>

<resources>

<resource>

<directory>src/main/resources</directory>

<filtering>true</filtering>

</resource>

</resources>

<plugins>

<plugin>

<groupid>org.apache.maven.plugins</groupid>

<artifactid>maven-war-plugin</artifactid>

</plugin>

</plugins>

</build>

打包运行

?

1

2

3

4

5
// 如果不指定环境,默认是activebydefault=true的环境,当前是指开发环境

mvn package

// 打包指定的环境通过-p 参数,注意p是大写的

mvn package -p <env>

maven profile自动切换环境参数的2种方法详解

从mvn packege -p test运行的结果中可以看到生成的target目录下classes/application.perperties中的jdbc.username和jdbc.password 就是application-test.properties中配置的env.jdbc.username和env.jdbc.password的值。

在spring中如果要使用属性配置文件,直接引入这个总的配置文件即可,其他的环境配置文件的使命已经结束了。
<context:property-placeholder location="classpath:application.properties"/>

实现原理:

在pom.xml中为每个不同的环境定义不同的profile,每个profile都有一个环境名称,然后为不同环境定义不同的配置文件(如application-<env>.properties), 再定义一个总的属性文件(如application.properties), 然后让application.properties的value去引用application-<env>.properties中对应的key,在打包时指定要打包的环境的名称即可,这样application.properties中的key的值就是相对应环境application-<env>.properties对应的值了。

多resource实现方式

步骤

第一步:在src/main/resource创建一个env目录,再创建各个环境的子目录,再再各个环境子目录下创建名为config.properties的文件,每个键相同,值不同。
env/dev/config.properties

?

1

2
jdbc.username=dev

jdbc.password=123456

env/test/config.properties

?

1

2
jdbc.username=test

jdbc.password=888888

env/pro/config.properties

?

1

2
jdbc.username=root

jdbc.password=666666

第二步:创建一个与环境无关的application.properties

application.properties

?

1

2
# 公共配置

salt=123456789

第三步:配置profiles

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27
<profiles>

<profile>

<!-- 开发环境 -->

<id>dev</id>

<properties>

<env>dev</env>

</properties>

<activation>

<!-- 设置默认激活这个配置 -->

<activebydefault>true</activebydefault>

</activation>

</profile>

<profile>

<!-- 测试环境 -->

<id>test</id>

<properties>

<env>test</env>

</properties>

</profile>

<profile>

<!-- 发布环境 -->

<id>pro</id>

<properties>

<env>pro</env>

</properties>

</profile>

</profiles>

第四步:配置resource

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31
<build>

<finalname>profile-app</finalname>

<!-- 定义了变量配置文件的地址 -->

<resources>

<resource>

<directory>src/main/resources</directory>

<excludes>

<exclude>env/dev/*</exclude>

<exclude>env/test/*</exclude>

<exclude>env/pro/*</exclude>

</excludes>

<filtering>true</filtering>

</resource>

<resource>

<directory>src/main/resources/env/${env}</directory>

<includes>

<include>*.*</include>

<include>**/*.xml</include>

<include>**/*.properties</include>

</includes>

<filtering>true</filtering>

</resource>

</resources>

<plugins>

<plugin>

<groupid>org.apache.maven.plugins</groupid>

<artifactid>maven-war-plugin</artifactid>

</plugin>

</plugins>

</build>

第五步:运行 mvn package -p test

maven profile自动切换环境参数的2种方法详解

如果经常使用mvn package -p <env>可以在idea中配置一些maven, 步骤为:edit configurations… —– + —- maven —- 分别为每个环境添加maven 命令,以后双击run configureations中的任意一个就是相当于运行mvn package -p <env>命令了

maven profile自动切换环境参数的2种方法详解

maven profile自动切换环境参数的2种方法详解

两种方式比较

filter方式会把所有的application-dev.properties、application-test.properties、application-pro.properties文件都会打包进去,而且此种方式只能针对属性文件,如果有其他文件(如.xml)也根据不同的环境有不同的配置,这种方式是不好处理。

多resource方式在打包时只打包指定环境的配置文件,可以将各种文件放到各自的环境文件夹中,在打包的时候会将整个文件夹都打包进去。推荐此种方式

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对快网idc的支持。

原文链接:https://blog.csdn.net/vbirdbest/article/details/78744786

收藏 (0) 打赏

感谢您的支持,我会继续努力的!

打开微信/支付宝扫一扫,即可进行扫码打赏哦,分享从这里开始,精彩与您同在
点赞 (0)

声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。

快网idc优惠网 建站教程 maven profile自动切换环境参数的2种方法详解 https://www.kuaiidc.com/111771.html

相关文章

发表评论
暂无评论