【由浅入深认识Maven】第3部分 maven多模块管理

第三篇：Maven多模块管理

一、前言

开发大型项目时，我们通常需要将项目拆分为多个模块，每个模块负责不同的功能。这样做不仅能够提高代码的可维护性，还能让团队成员分工合作，减少冲突。项目的规模不断扩展，随之而来的问题是， 如何有效地管理这些模块之间的依赖关系。在这种情况下，Maven 的多模块项目支持功能显得尤为重要。

参与企业级应用开发时，由于项目分成了多个模块，每个模块分别处理不同的业务逻辑。刚开始，大家在构建各自模块时都比较顺利，但当涉及到模块间的依赖和版本管理时，问题开始浮现：有些模块的版本不一致，某些模块需要更新，依赖关系很难清晰地管理。使用 Maven 来管理多模块项目可以很好解决这个问题。通过配置父POM和子模块POM，Maven帮助我们很好地解决了这些问题，使得模块之间的依赖变得清晰而且自动化。

本章节将为大家详细讲解如何使用 Maven 来管理多模块项目，帮助大家理解如何通过合理的模块拆分和POM配置，让复杂的项目变得更易于管理和维护。

二. 多模块项目结构

在Maven中，管理多模块项目的核心是通过父POM文件来统一管理多个子模块。父POM文件包含了所有共享的配置和插件，而子模块则继承父POM，继而共享这些配置。每个子模块都有自己的POM文件，并且可以覆盖父POM中的配置。

1、多模块项目的典型结构

Maven推荐的多模块项目结构通常如下所示：

parent-project/
|-- pom.xml (父POM文件)
|-- module-a/
|   |-- pom.xml (子模块A的POM文件)
|-- module-b/
|   |-- pom.xml (子模块B的POM文件)
|-- module-c/
|   |-- pom.xml (子模块C的POM文件)

在这个结构中，parent-project 是根项目（父模块），它的 pom.xml 文件作为父POM文件管理所有子模块。每个子模块 module-a、module-b、module-c 都是独立的模块，它们分别有各自的POM文件，这些文件可以继承父POM中的配置。

2、父POM与子模块POM的关系

在父POM中，我们可以统一配置项目的插件、版本、依赖等，而子模块则可以继承这些配置，从而保持模块之间的一致性。例如，父POM中可以定义所有子模块的Java版本、Maven插件版本、构建步骤等。子模块则可以在需要时覆盖这些配置或补充自己的特定配置。

以下是一个简单的父POM配置示例：

<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.example</groupId>
    <artifactId>parent-project</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>  <!-- 根项目没有实际的构建产物 -->

    <modules>
        <module>module-a</module>
        <module>module-b</module>
        <module>module-c</module>
    </modules>

    <dependencyManagement>
        <!-- 统一管理子模块的依赖版本 -->
        <dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-core</artifactId>
                <version>5.3.10</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

在这个父POM中，我们指定了 module-a、module-b 和 module-c 作为子模块，并通过 <dependencyManagement> 元素统一管理依赖版本，确保每个子模块使用相同版本的 Spring 库。

3、子模块POM配置

子模块的 pom.xml 文件通常会继承父POM的配置。通过 <parent> 元素，子模块可以继承父POM的所有配置信息。子模块如果需要特定的配置，可以在自己的 POM 文件中进行覆盖。

<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.example</groupId>
        <artifactId>parent-project</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath> <!-- 父POM的路径 -->
    </parent>

    <artifactId>module-a</artifactId>

    <dependencies>
        <!-- 继承父POM中的依赖管理，不需要重复声明版本 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
        </dependency>
    </dependencies>
</project>

在这个子模块POM中，通过 <parent> 元素指定了父POM，继承了父POM中的依赖和插件配置，简化了子模块的配置。

三、 多模块项目的构建

Maven 提供了 -pl（project list）选项来指定构建特定的模块，以及 -am（also make）选项来构建该模块的依赖。例如，构建 module-a 和它的依赖模块：

mvn install -pl module-a -am

如果你只想构建所有模块，可以在父项目目录中运行：

mvn clean install

这将自动构建父POM中的所有模块，并按需下载和编译依赖。

四、 版本管理与模块间依赖

在多模块项目中，版本管理是一个非常重要的方面，尤其是当模块之间有相互依赖时。父POM的 <dependencyManagement> 元素可以帮助我们统一管理所有模块的依赖版本，确保各个模块之间版本一致，避免因不同版本导致的兼容性问题。

例如，假设 module-a 和 module-b 都依赖 spring-core 库，我们可以在父POM中统一声明 spring-core 的版本，而在子模块的 pom.xml 中省略版本号：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
</dependency>

Maven会自动根据父POM中的版本管理，选择合适的版本。

五、 总结

Maven 的多模块项目支持能够帮助我们更高效地管理大型项目，尤其是在模块化开发和团队协作的环境中。通过合理地配置父POM和子模块POM，可以确保项目依赖和构建过程的统一性。通过Maven的多模块支持，团队成员可以专注于自己的模块，减少冲突和依赖问题，使得项目的构建、维护和扩展更加高效和规范。

希望通过今天的分享，大家能够掌握如何使用Maven管理多模块项目，帮助团队更好地协作、开发和维护复杂的企业级应用。