Maven使用 | 多模块下的打包问题
背景
在实际的Java项目中,经常会见到多模块应用 (multi-module applications),比如一个简单的基于Maven多模块项目的文件结构如下:
+- pom.xml
+- my-app
| +- pom.xml
| +- src
| +- main
| +- java
+- my-webapp
| +- pom.xml
| +- src
| +- main
| +- webapp
+- my-others
| +- pom.xml
| +- src
| +- main
| +- others
这个示例项目包含my-app
和my-webapp
两个子项目,其中my-webapp
依赖于my-app
,但如果我们只希望打包my-webapp
这个项目,需要怎么做呢?
1. Maven相关知识介绍
1.1 The Reactor
The mechanism in Maven that handles multi-module projects is referred to as the reactor. This part of the Maven core does the following:
- Collects all the available modules to build
- Sorts the projects into the correct build order
- Builds the selected projects in order
Maven中处理多模块项目的机制称为Reactor。Maven 核心的这一部分执行以下操作:
- 收集要构建的所有可用模块
- 将项目按正确的生成顺序排序
- 按顺序生成选定的项目
1.2 Reactor Sorting
由于多模块构建中的模块可以相互依赖,因此反应堆必须对所有项目进行排序,以确保在需要之前构建任何项目。
对项目进行排序时,将遵循以下关系:
- 项目依赖于生成中的另一个模块
- 插件声明,其中插件是构建中的另一个模块
- 插件依赖于构建中的另一个模块
- 生成中另一个模块上的生成扩展声明
- 元素中声明的顺序(如果没有其他规则适用)
1.3 Maven高级reactor命令
-pl, --projects
Build specified reactor projects instead of all projects
-am, --also-make
If project list is specified, also build projects required by the list
1.4 总结
因此,要想正确对某个子模块打包,就必须要使用到Maven的Reactor机制,使Maven能够正确理解子模块打包所需依赖的顺序。
2. 多模块打包的正确做法
2.1 Maven生命周期
package
: 完成了项目编译、单元测试、打包功能,但没有把打好的可执行jar包(war包或其它形式的包)布署到本地maven仓库和远程maven私服仓库install
: 完成了项目编译、单元测试、打包功能,同时把打好的可执行jar包(war包或其它形式的包)布署到本地maven仓库,但没有布署到远程maven私服仓库。deploy
: 完成了项目编译、单元测试、打包功能,同时把打好的可执行jar包(war包或其它形式的包)布署到本地maven仓库和远程maven私服仓库
2.2 第一次打包
需要注意的是,如果是第一次打包,则需要在最顶层目录下,对指定子模块进行打包,使用Maven命令如下所示:
mvn install -pl my-webapp -am
- 至于使用
install
或package
,则取决于是否还需要进行进一步代码修改、再打包,如果需要,使用install
可以将打好的可执行jar包(war包或其它形式的包)布署到本地maven仓库
2.3 第二次打包
- 如果上一步已经再顶层目录下执行过
install
,对指定子模块的二次打包只需要在子目录下执行即可(在依赖的其他模块代码不修改的情况下),如果依赖的其他模块代码修改了,则仍需要在顶层目录下进行打包