Maven多模块任意构建和多环境构建详解

需求背景

我们需要做一个电商项目,一般都会做成微服务的形式,按业务进行划分,本次我们主要以账户业务和订单业务为例,我们将这两块业务分别作为2个大的模块来开发,而订单模块又会调用账户模块中的接口,所以对账户模块接口部分会有依赖。

搭建项目结构

1、创建b2b项目


2、以聚合的方式创建b2b-account模块,Maven聚合创建项目可以参考文章Maven聚合与继承深入解析。


3、以聚合的方式创建b2b-account的子模块b2b-account-Api和b2b-account-Service。


4、在b2b下创建b2b-order模块,和第二步骤类似。

5、参考第三步骤,在b2b-order下创建b2b-order-Api和b2b-order-Service。最终项目结构如下:


引入项目依赖

b2b-account-Service依赖于 b2b-account-Api 模块,所以在 b2b-account-Service/pom.xml 中加入下面配置:

b2b-order-Service依赖2个模块 b2b-order-Api、b2b-account-Api ,所以在 b2b-order-service/pom.xml 中加入下面配置:

各个pom文件配置如下:

b2b/pom.xml


b2b/b2b-account/pom.xml


b2b/b2b-account-Api/pom.xml


b2b/b2b-account-Service/pom.xml


b2b/b2b-order/pom.xml


b2b/b2b-order-Api/pom.xml


b2b/b2b-order-Service/pom.xml


反应堆

上面项目都开发好了,我们需要安装到本地仓库,一般情况下,在 b2b/pom.xml 所在目录执行下面命令:mvn clean install


mvn 命令对多模块构件时,会根据模块的依赖关系而得到模块的构建顺序,这个功能就是maven的反应堆(reactor)做的事情,反应堆会根据模块之间的依赖关系、聚合关系、继承关系等等,从而计算得出一个合理的模块构建顺序。

按需随意构建

b2b-account-Api 被 b2b-account-Service 和 b2b-order-Service 依赖了,所以当 b2b-account-Api 有修改的时候,我们希望他们3个都能够被重新构建一次,而不是去对所有的模块都进行重新构建。mvn命令提供了一些功能可以帮我们实现这些操作。

-pl,--projects

构件指定的模块,arg表示多个模块,之间用逗号分开,模块有两种写法:

  • -pl 模块1相对路径 [,模块2相对路径] [,模块n相对路径]

  • -pl [模块1的groupId]:模块1的artifactId [,[模块2的groupId]:模块2的artifactId] [,[模块n的groupId]:模块n的artifactId]

-rf,--resume-from

从指定的模块恢复反应堆

-am,--also-make

同时构建所列模块的依赖模块

-amd,--also-make-dependents

同时构件依赖于所列模块的模块

多环境构建支持

Maven属性

maven的属性主要分为2大类,第一类就是上面说的自定义属性,另外一类是不需要自定义的,可以直接拿来使用的。第二类属性在pom.xml中都是采用 ${属性名称} 进行引用,maven运行的时候会将 ${} 替换为属性实际的值。

maven中不需要自定义的5类属性:

内置属性

  • ${basedir}:表示项目根目录,即包含pom.xml文件的目录

  • ${version}:表示项目的版本号

POM属性

用户可以使用该属性引用pom.xml文件中对应元素的值。

常用的POM属性:

  • ${pom.build.sourceDirectory}:项目的主源码目录,默认为src/main/java/

  • ${project.build.testSourceDirectory}:项目的测试源码目录,默认为src/test/java/

  • ${project.build.directory}:项目构建输出目录,默认为target/

  • ${project.build.outputDirectory}:项目主代码编译输出目录,默认为target/classes

  • ${project.build.testOutputDirectory}:项目测试代码编译输出目录,默认为target/test-classes

  • ${project.groupId}:项目的groupId

  • ${project.artifactId}:项目的artifactId

  • ${project.version}:项目的version,与${version}等价

  • ${project.build.finalName}:项目打包输出文件的名称,默认为${project.artifactId}-${project.version}

Settings属性

这种属性以settings.开头来引用 ~/.m2/settings.xml 中的内容。如:${settings.localRepository} 指用户本地仓库的地址。

java系统属性

所有java系统属性都可以使用maven属性来进行引用,例如 ${user.home} 指向了当前用户目录。java系统属性可以通过 mvn help:system 命令看到。

环境变量属性

所有的环境变量都可以使用env.开头的方式来进行引用。如:${env.JAVA_HOME}可以获取环境变量 JAVA_HOME 的值。用户可以使用 mvn help:system 命令查看所有环境变量的值。

多套环境构建问题

pom.xml的 project 元素下面提供了一个 profiles 元素可以用来对多套环境进行配置。

资源文件打包过程

设置资源文件复制过程采用的编码

设置资源文件内容动态替换

上面开启动态替换的元素是 filtering 。上面build元素中的 resources 和 testResources 是用来控制构建过程中资源文件配置信息的。resources 元素中可以包含多个 resource ,每个 resource 表示一个资源的配置信息,一般使用来控制主资源的复制的。testResources 元素和 testResources 类似,是用来控制测试资源复制的。

自定义替换的分隔符

自定义分隔符,需要我们配置 maven-resources-plugin 插件的参数,如下:

delimiters 中可以配置多个 delimiter ,可以配置 #*# ,其中的 * 表示属性名称,那么资源文件中的#属性名# 在复制的过程中会被替换掉, * 前后都是#,表示前后分隔符都一样,那么可以简写为 # ,所以 #*# 和 # 写法是一样的,我们去看一下源码,delimiters的默认值如下:

指定需要替换的资源文件

我们需要在资源构建的过程中排除不需要构建的文件,可以使用 exclude 元素信息进行排除操作。如下:

includes 列出需要被处理的,使用 excludes 排除不需要被处理的资源文件列表,采用通配符的写法,**匹配任意深度的文件路径,*匹配任意个字符。

profiles处理多环境构建问题

maven支持让我们配置多套环境,每套环境中可以指定自己的maven属性,mvn命令对模块进行构建的时候可以通过 -P 参数来指定具体使用哪个环境的配置。

profiles元素支持定义多套环境的配置信息,配置如下用法:

id:表示这套环境的标识信息,properties可以定义环境中使用到的属性列表。

执行mvn命令编译的时候可以带上一个 -P profileid 来使用指定的环境进行构建。

开启默认环境配置

我们可以指定一个默认开启的配置,我们默认开启dev的配置,修改dev的profile元素,在这个元素下面加上:

activeByDefault表示默认开启这个环境的配置,默认值是false。

通过maven属性来控制环境的开启

我们想通过自定义的属性值来控制使用哪个环境。可以在profile元素中加入下面配置:

我们可以在mvn后面跟上下面的命令可以开启匹配的环境:

mvn -D 属性xx=属性xx的值

启动时指定多个环境

可以在 -P 参数后跟多个环境的id,多个之间用逗号隔开,当使用多套环境的时候,多套环境中的maven属性会进行合并,如果多套环境中属性有一样的,后面的会覆盖前面的。可以根据这个特性简化环境的配置,属性相同的只保留一个。

查看目前有哪些环境

mvn help:all-profiles -pl

查看目前激活的是哪些环境

mvn help:active-profiles

指定外部配置文件配置环境

maven可以在profile中指定一个外部属性文件 xx.properties ,文件格式:

然后在profile元素中加入下面配置:

filter 元素可以指定多个,当有多个外部属性配置文件的时候,可以指定多个来进行引用。资源文件复制的时候就可以使用下面的方式引用外部资源文件的内容。

profile元素可以用于对不同环境的构建进行配置,project中包含的元素,在profile元素中基本上都有,所以profile可以定制更复杂的构建过程,不同环境依赖的构件、插件、build过程、测试过程都是不一样的,这些都可以在profile中进行指定,也就是说不同的环境所有的东西都可以通过profile元素来进行个性化的设置,这部分的功能有兴趣的大家可以自己去研究一下。

你可能感兴趣的:(Maven多模块任意构建和多环境构建详解)