maven 与多模块构建

2023年3月19日 171次阅读 来源: dkvirus

实际工作中，从远程仓库拉下来的 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 子模块配置即可，这里不再赘述。

    原文作者：dkvirus
    原文地址: https://www.jianshu.com/p/d386230cd524
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞