Maven之多模块项目管理

1.　　什么是多模块项目

　　　　Maven 多模块项目(Multi-module Project)是指一个父项目(parent project)包含多个子模块(submodules)的项目结构。这种结构允许我们将一个大型项目拆分成多个逻辑上独立但又相互关联的模块，每个模块可以单独构建，也可以作为整体一起构建。

2.　　多模块项目的优势

　　　　1.　　代码复用：　　公共代码可以提取到单独的模块中供其他模块使用

　　　　2.　　职责分离：　　不同团队可以专注于不同模块的开发

　　　　3.　　构建效率：　　只构建发生变化的模块，减少构建时间

　　　　4.　　依赖管理：　　统一管理所有模块的依赖关系

　　　　5.　　版本控制：　　所有模块使用统一的版本号，便于管理

3.　　适用场景

　　　　1.　　大型项目分层

　　　　2.　　微服务架构

　　　　3.　　共享通用代码

4.　　标准目录结构

parent-project/          # 父项目根目录
├── pom.xml             # 父POM（packaging=pom）
├── module-a/           # 子模块A
│   ├── src/
│   └── pom.xml         # 子模块A的POM
├── module-b/           # 子模块B
│   ├── src/
│   └── pom.xml         # 子模块B的POM
└── module-web/         # Web模块
    ├── src/
    └── pom.xml

　　　　1.　　父POM

　　　　　　　　1.　　必须设置<packaging>pom</packaging>

　　　　　　　　2.　　通过<modules>管理子模块

　　　　2.　　子模块

　　　　　　　　1.　　通过<parent>继续父POM

　　　　　　　　2.　　可以有自己的依赖和构建配置

5.　　创建Maven多模块项目

　　　　1.　　创建父项目

　　　　　　　　父项目本身通常不包含任何代码，它主要用来管理子模块和公共配置。

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>parent-project</artifactId>
    <version>1.0.0</version>
    <packaging>pom</packaging>
    
    <modules>
        <module>module1</module>
        <module>module2</module>
    </modules>
</project>

　　　　2.　　创建子模块

　　　　　　　　子模块是实际的代码模块，可以是普通的 Java 项目、Web 应用等。每个子模块都有自己的 pom.xml 文件，但需要声明父项目

<project>
    <parent>
        <groupId>com.example</groupId>
        <artifactId>parent-project</artifactId>
        <version>1.0.0</version>
    </parent>
    
    <modelVersion>4.0.0</modelVersion>
    <artifactId>module1</artifactId>
</project>

6.　　多模块项目依赖管理

　　　　1.　　模块之间相互依赖

　　　　　　　　module2依赖module1　　　　　　　

<project>
    <!-- module2 的 pom.xml -->
    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>module1</artifactId>
            <version>${project.version}</version>
        </dependency>
    </dependencies>
</project>　

　　　　2.　　依赖继承

　　　　　　　　1.　　父项目可以定义公共依赖，子模块会自动继承这些依赖

<project>
    <!-- 父项目 pom.xml -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
                <scope>test</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

　　　　　　　　2.　　子模块只需要声明依赖的groupId和artifactId，无需指定版本

<project>
    <!-- 子模块 pom.xml -->
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
    </dependencies>
</project>

7.　　多模块项目构建

　　　　1.　　构建整个项目

　　　　　　　　在父项目录下执行

　　　　　　　　　　mvn clean install　　这会按照依赖顺序构建所有子模块

　　　　2.　　构建单个模块

　　　　　　　　进入特定模块目录执行

　　　　　　　　　　cd module1

　　　　　　　　　　mvn clean install

　　　　3.　　构建模块及其依赖

　　　　　　　　mvn -pl module1 -am clean install　　　　　　　　　　

8.　　多模块项目最佳实践

　　　　1. 　　合理的模块划分

• • • 按功能划分模块
    • 按层次划分模块(如 dao, service, web)
    • 公共工具提取到单独模块

　　　　2. 　　版本管理

• • • 使用父项目统一管理版本号

    • 考虑使用 Maven 的版本插件管理版本升级

　　　　3. 　　构建优化

• • • 配置适当的构建顺序

    • 使用 profile 管理不同环境的构建

    • 考虑并行构建提高效率

　　　　4. 　　依赖管理

• • • 在父项目中集中管理公共依赖
    • 使用 dependencyManagement 统一版本
    • 避免循环依赖

9.　　常见问题与解决方案　　

　　　　1.　　循环依赖问题

　　　　　　　　问题：模块A依赖模块B，模块B又依赖模块A

　　　　　　　　解决：重新设计模块结构，提取公共代码到第三个模块

　　　　　　　　　　　　使用接口解耦

　　　　2.　　构建顺序问题

　　　　　　　　问题：Maven不能正确识别模块间的依赖顺序

　　　　　　　　解决：显示声明模块依赖关系

　　　　　　　　　　　　使用reactor插件分析构建顺序

　　　　3.　　版本不一致问题

　　　　　　　　问题：不同模块使用不同版本的依赖

　　　　　　　　解决：在父项目中统一管理依赖版本

　　　　　　　　　　　　使用dependencyManagement