当前位置：首页 > article >正文

Maven 多模块项目管理

article 2025/2/13 4:36:39

1. 什么是 Maven 多模块项目？

在 Maven 中，多模块项目是指一个父项目管理多个子模块的项目结构。每个子模块都可以是一个独立的模块或应用，但都在同一个父 POM 文件的管理下。通过这种结构，团队可以更好地组织大型项目，简化版本管理、依赖管理和构建过程。

多模块项目的好处：

模块化管理：将复杂的应用分解成多个小模块，便于开发、维护和扩展。
依赖共享：父模块可以统一管理所有子模块的公共依赖和插件。
版本控制：父 POM 管理所有子模块的版本，使得各模块版本保持一致。
构建优化：只需要构建父模块，Maven 会自动构建所有子模块。

2. 多模块项目的结构

在多模块项目中，通常会有一个父项目，它包含多个子模块。父项目的 pom.xml 文件负责管理整个项目的依赖、插件和构建配置，而每个子模块都有自己的 pom.xml 文件，通常用于定义模块特定的依赖或配置。

典型的多模块项目结构：

enterprise-project/
├── pom.xml                # 父 POM 文件，管理全局依赖和插件
├── common/                # 公共模块（如工具类、共享功能）
│   ├── pom.xml            # 子模块的 POM 文件
│   ├── src/
├── service/               # 业务模块（如业务逻辑层）
│   ├── pom.xml            # 子模块的 POM 文件
│   ├── src/
├── dao/                   # 数据访问模块（如数据库操作）
│   ├── pom.xml            # 子模块的 POM 文件
│   ├── src/
├── web/                   # Web 层模块（如前端接口、控制器）
│   ├── pom.xml            # 子模块的 POM 文件
│   ├── src/

3. 多模块项目的构建和依赖管理

3.1 父 POM 配置

父 POM 文件是多模块项目的核心，负责定义 所有模块的公共依赖、插件和版本管理。每个子模块都需要继承这个父 POM 文件。

父 POM 示例（enterprise-project/pom.xml）：

<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>enterprise-project</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>  <!-- 父项目的 packaging 设置为 pom -->
    
    <!-- 子模块定义 -->
    <modules>
        <module>common</module>
        <module>service</module>
        <module>dao</module>
        <module>web</module>
    </modules>
    
    <!-- 依赖管理 -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-core</artifactId>
                <version>5.3.9</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
    
    <!-- 构建插件 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

在上述配置中：

modules 元素列出了所有子模块，Maven 会自动根据顺序构建每个子模块。
dependencyManagement 用于定义全局依赖版本，确保所有子模块使用相同版本的依赖。
build 部分配置了构建插件，如编译插件等。

3.2 子模块配置

每个子模块的 pom.xml 文件通常会继承父 POM 文件，并根据需要定义自己的模块特定依赖和配置。

子模块配置（common/pom.xml）：

<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>enterprise-project</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    
    <artifactId>common</artifactId>  <!-- 子模块的 artifactId -->
    
    <dependencies>
        <!-- 子模块特定依赖 -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.12.0</version>
        </dependency>
    </dependencies>
</project>

在该配置中：

通过 <parent> 元素，子模块继承了父 POM 文件。
子模块定义了自己特有的依赖，如 commons-lang3。

3.3 构建多模块项目

当所有子模块都配置完成后，我们可以通过在父项目目录执行以下命令来构建所有模块：

mvn clean install

clean：清理旧的构建文件。
install：构建所有模块并将其安装到本地仓库。

Maven 会根据父 POM 中的模块顺序依次构建 common、service、dao 和 web 模块。

4. 多模块项目中的依赖管理

4.1 共享依赖

在多模块项目中，父 POM 文件管理了所有公共的依赖项，这样可以避免重复配置，保证项目中所有模块使用相同版本的依赖。

例如，父项目已经配置了 Spring 依赖，所有子模块都可以直接使用，而无需在每个子模块中单独声明。

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

4.2 子模块之间的依赖

如果某个子模块依赖其他子模块，父项目会自动管理这些依赖。比如，service 模块依赖 dao 模块，可以在 service 模块的 pom.xml 中声明：

<dependency>
    <groupId>com.example</groupId>
    <artifactId>dao</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

4.3 版本管理

使用 dependencyManagement 元素，父项目可以统一管理版本号，确保所有子模块使用一致的版本。

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>5.3.9</version>
        </dependency>
    </dependencies>
</dependencyManagement>