在开发过程中,我们的软件会面对不同的运行环境,比如开发环境、测试环境、生产环境,而我们的软件在不同的环境中,有的配置可能会不一样,比如数据源配置、日志文件配置、以及一些软件运行过程中的基本配置,那每次我们将软件部署到不同的环境时,都需要修改相应的配置文件,这样来回修改,很容易出错,而且浪费劳动力。
maven提供了一种方便的解决这种问题的方案,就是profile功能。
Maven:
profile可以让我们定义一系列的配置信息,然后指定其激活条件。这样我们就可以定义多个profile,然后每个profile对应不同的激活条件和配置信息,从而达到不同环境使用不同配置信息的效果。
profile定义的位置
(1) 针对于特定项目的profile配置我们可以定义在该项目的pom.xml中。(下面举例是这种方式)
(2) 针对于特定用户的profile配置,我们可以在用户的settings.xml文件中定义profile。该文件在用户家目录下的“.m2”目录下。
(3) 全局的profile配置。全局的profile是定义在Maven安装目录下的“conf/settings.xml”文件中的。
假设场景:
1、项目需要根据需求,使用不同配置或不同依赖。
2、项目A依赖项目B,项目A仅使用项目B中部分模块,不想引入项目B全部依赖
springboot项目B pom.xml:
test true dev dev true org.redisson redisson-spring-boot-starter 3.13.1 compile prod prod test test
org.redisson redisson-spring-boot-starter 3.13.1 provided
说明:
1)两处redisson依赖说明:
profiles标签下的依赖,只有当相应的profile被激活时,才会导入依赖。scope为compile,使得依赖本项目B的 项目A会导入该redisson依赖。
dependencies标签下的依赖,给本项目B正常使用。scope使用provided,表示用于当前项目编译使用,不向下传递,使得依赖本项目B的 项目A不会导入该redisson依赖。
参考:maven scope 的作用
2)默认激活:
这里定义了三个环境,分别是dev(开发环境)、test(测试环境)、prod(发布环境),其中开发环境是默认激活的(activeByDefault为true),这样如果在不指定profile时默认是开发环境,也在package的时候显示指定你要选择哪个开发环境,详情见激活介绍。
针对不同的环境,我们定义了不同的配置文件,文件目录如下:
多个环境的配置文件,命名规则为是application-环境名称.yml
或者 application-环境名称.properties
。
如图所示,开发环境、测试环境、生产环境的配置文件分别默认放到src/main/resources
目录下。如果要在resources文件下再分类新目录下,如src/main/resources/config
,那么就要在pom文件中作特别配置,如下:
src/main/resources/config/application-${env}.properties src/main/resources true org.apache.maven.plugins maven-war-plugin
点此查看maven更多激活方式
1、使用命令行激活:
示例:
mvn compile -P dev
mvn package -P dev
mvn install -P dev
mvn deploy -P dev
mvn help:active-profiles
mvn deploy -P test,dev
,test和dev都是上面自定义的profile的id值。2、使用IDEA Maven插件激活
1)勾选想要激活的profile,可以多选。
2)点击Lifecycle下相应的选项。
1、项目B打包发布时激活id为dev的profile:mvn deploy -P dev
(1)注意在pom.xml中加入spring-boot-maven-plugin打包插件,这样项目的依赖会一起打包在jar中,否则即使激活了dev的profile,该profile下的依赖并不会被项目A中使用到。
(2)因为是发布到远程仓库,需要添加相关配置。这里的远程仓库是我本地搭建的一个nexus私服,具体如何搭建使用请自行搜索。
com.wy.springboot
demo
1.0.0-SNAPSHOT
demo
Demo project for Spring Boot
nexus Nexus Sites http://localhost:8081/repository/maven-snapshots/
org.springframework.boot spring-boot-maven-plugin
2、在项目A中引用项目B:
com.wy.springboot demo 1.0.0-SNAPSHOT
3、查看项目A中所导入的依赖:
(1)点击打开项目的依赖图:
(2)在依赖图中搜索redis,发现成功引入。
项目A、B pom
(1) 项目B完整pom.xml
4.0.0 org.springframework.boot spring-boot-starter-parent 2.3.4.RELEASE com.wy.springboot demo 1.0.0-SNAPSHOT demo Demo project for Spring Boot 1.8 test true dev org.redisson redisson-spring-boot-starter 3.13.1 compile org.redisson redisson-spring-boot-starter 3.13.1 provided nexus Nexus Sites http://localhost:8081/repository/maven-snapshots/ org.springframework.boot spring-boot-maven-plugin
(2)项目A完整pom.xml
4.0.0 org.springframework.boot spring-boot-starter-parent 2.3.4.RELEASE com.wuyou.springboot demo2 1.0.0-SNAPSHOT demo2 Demo project for Spring Boot 1.8 nexus nexus http://localhost:8081/repository/maven-snapshots/ true true org.springframework.boot spring-boot-starter org.springframework.boot spring-boot-starter-test test org.junit.vintage junit-vintage-engine com.wy.springboot demo 1.0.0-SNAPSHOT org.springframework.boot spring-boot-maven-plugin
1.【IDEA】Maven踩坑:pom文件中的默认profiles不生效+IDEA中Maven的profiles使用说明
2.pom.xml中maven profile的激活方式