maven 与多模块构建

实际工作中,从远程仓库拉下来的 java 工程可能会由多个子模块工程组成,像 dk 刚学习那会总是整不清模块之间的关系。

一、多模块构建存在的问题

多模块构建有两个问题需要解决。

|-- hello-world
|-- hello-test

1. 重复操作问题

hello-world 项目和 hello-test 项目是两个单独的子模块,现在想要编译这两个模块,需要分两步做:切换到 hello-world 目录执行 $ mvn compile 编译 hello-world 目录下的文件,切换到 hello-test 目录再次执行 $ mvn compile 编译 hello-test 目录下的文件。如果不止两个子模块呢?有十个子模块,就得重复十次编译操作,这并不合理。

我们期望的结果是:只要执行一次编译操作,就可以对所有子模块都进行编译操作。

2.重复配置问题

hello-world 和 hello-test 项目下的 pom.xml 文件有很多重复的配置。

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.dkvirus</groupId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.11</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

我们期望的是:将重复配置提取到公共 pom.xml 中,子模块的 pom.xml 只需继承公共 pom.xml 即可。

二、解决重复操作问题

要解决重复操作的问题,我们需要再新建一个 maven 工程,该工程下没有任何代码,只需一个 pom.xml 文件即可。下面两种方法都可以解决重复操作的问题,推荐第二种。

1. 平行目录结构

|-- hello-parent
    |-- pom.xml
|-- hello-test
|-- hello-world

在子模块同级目录下新建 hello-parent 项目,其 pom.xml 内容如下:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.dkvirus</groupId>
  <artifactId>hello-parent</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>pom</packaging>
  <name>hello-parent</name>

  <modules>
    <module>../hello-world</module>
    <module>../hello-test</module>
  </modules>
</project>

此时切换到 hello-parent 目录下,执行 $ mvn clean compile 会发现 hello-world 和 hello-test 项目也会一同编译。

关于上面 pom.xml 文件,进行两点说明:

1)packaging 元素值设置为 pom。可以看一下 hello-world 和 hello-test 项目并没有 packaging 元素,此时使用的是默认值 jar,所以子模块最终打包结果是 jar 包;对于父模块 hello-parent 来说,其 packaging 元素的值必须为 pom,否则无法构建。

2)modules 元素定义父模块 hello-parent 拥有哪些子模块,子模块填写在 module 元素中,使用相对路径 ../hello-world 找到子模块的根目录。在对父模块执行 mvn 命令时,也会对这里设定的子模块起作用。

2. 父子目录结构

平行目录结构看着并不直观,拿到一个多模块项目,还得找一下哪个是父模块。还有一种父子目录结构,看起来更直观。

|-- hello-world
    |-- hello-world
    |-- hello-test
    |-- pom.xml

创建 hello-world 项目,将之前创建的 hello-world 项目和 hello-test 项目都移到该目录下,并在该目录下创建 pom.xml,内容如下:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.dkvirus</groupId>
  <artifactId>hello-parent</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>pom</packaging>
  <name>hello-parent</name>

  <modules>
    <module>./hello-world</module>
    <module>./hello-test</module>
  </modules>
</project>

此时切换到 hello-parent 目录下,执行 $ mvn clean compile,可以看到对子模块 hello-world 和 hello-test 也执行了编译操作。

需要注意的一点是 module 元素中相对路径变成了 ./hello-world,因为 hello-world 现在和 pom.xml 在同级目录下,只需要 . 即可找到位置。./hello-world 通常可以直接简写为 hello-world

三、解决重复配置问题

子模块 hello-world 和 hello-test 有一些共同的配置,将这些配置写到父模块 hello-parent 的 pom.xml 里进行统一管理。

修改 hello-parent 的 pom.xml 文件。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.dkvirus</groupId>
    <artifactId>hello-parent</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>pom</packaging>
    <name>hello-parent</name>

    <properties>
        <junit.version>4.7</junit.version>
    </properties>

    <modules>
        <module>hello-world</module>
        <module>hello-test</module>
    </modules>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>${junit.version}</version>
                <scope>test</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

1)properties 元素里定义变量名 junit.version,变量值为 4.7,在下面通过 ${junit.version} 获取变量的值,这样做方便统一修改。
2)dependencyManagement 元素只会出现在父模块中,用于统一管理子模块的依赖包。

修改子模块 hello-world 的 pom.xml 文件。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.dkvirus</groupId>
        <artifactId>hello-parent</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <relativePath>..</relativePath>
    </parent>

    <artifactId>hello-world</artifactId>
    <packaging>jar</packaging>
    <name>hello-world</name>

    <!-- 依赖配置 -->
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
    </dependencies>
</project>

1)子模块 pom.xml 中添加了 parent 元素,该元素内 groupId、artifactId、version 确定父模块唯一坐标,relativePath 为子模块 pom.xml 相对于父模块 pom.xml 的相对路径。
2)子模块 pom.xml 移除了自身的 groupId 和 version 元素,这两个元素继承父模块的属性;
3)子模块 pom.xml dependency 元素也移除了 version 元素,也继承父模块中依赖包的版本属性。

hello-test 子模块的 pom.xml 参照 hello-world 子模块配置即可,这里不再赘述。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,874评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,102评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,676评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,911评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,937评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,935评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,860评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,660评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,113评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,363评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,506评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,238评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,861评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,486评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,674评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,513评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,426评论 2 352

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,649评论 18 139
  • Maven编译代码的相关命令 第一、main目录下的主代码编写完毕后,使用Maven进行编译,在项目根目录下运行命...
    加油小杜阅读 1,185评论 0 2
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,801评论 6 342
  • 简介 概述 Maven 是一个项目管理和整合工具 Maven 为开发者提供了一套完整的构建生命周期框架 Maven...
    闽越布衣阅读 4,288评论 6 39
  • 今天早晨按照《自控力》所教开始冥想。不知各位如何,反正我是集中不起来。虽说冥想不是不想,但只要你想“呼”和“吸”呀...
    fieldsky阅读 85评论 0 0