Maven ＜dependencyManagement＞：如何在多模块项目中集中管理依赖版本

文章目录

一、先给结论
二、为什么需要dependencyManagement
三、dependencyManagement示例解析
- [1. 项目结构](#1. 项目结构)
- [2. 父模块 module-parent 的 pom.xml](#2. 父模块 module-parent 的 pom.xml)
- [3. 子模块 module-a 和 module-b 的 pom.xml](#3. 子模块 module-a 和 module-b 的 pom.xml)
四、dependencyManagement的优势
五、总结

在 多模块项目 中，Maven 提供了一个非常强大的功能------<dependencyManagement>。它能够帮助我们集中管理所有子模块的依赖版本，确保项目的一致性和可维护性。很多开发者在管理多个模块的项目时，可能会忽略这个功能，但它在复杂项目中的作用至关重要。

本文将深入探讨 <dependencyManagement> 的用法 ，并通过 示例项目 讲解其如何帮助我们简化版本管理、避免依赖冲突。

一、先给结论

结论一句话版：

<dependencyManagement>：将所有依赖的版本集中在父 POM 中进行管理，子模块无需指定版本，自动继承父模块的版本。

通过 <dependencyManagement>，你可以避免每个子模块独立管理版本，确保版本一致性，并简化项目的维护和升级。

用一句更形象的话说：

<dependencyManagement> 是集中管理依赖版本的利器，让你不再为每个子模块的版本号而头疼。

二、为什么需要dependencyManagement

1. 版本不一致的困扰

在多模块项目中，每个子模块可能会使用不同版本的相同依赖，导致 版本冲突。这不仅增加了项目维护的复杂度，还可能引发兼容性问题。

无 <dependencyManagement> 时的潜在问题

假设我们有两个子模块 module-a 和 module-b，它们都依赖于同一个库 spring-boot-starter-web，但是版本不同：

xml 复制代码

<!-- module-a 的 pom.xml -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.4.5</version>
</dependency>

<!-- module-b 的 pom.xml -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.5.4</version>
</dependency>

如果没有在父模块中统一管理版本，module-a 和 module-b 之间可能会出现版本冲突，导致项目难以维护。

2. 如何使用dependencyManagement？

<dependencyManagement> 的作用

<dependencyManagement> 用来在父 POM 中集中管理依赖的版本。子模块只需引用依赖而无需显式指定版本号，父模块会自动提供版本号。这样可以确保整个项目中的依赖版本统一，避免版本不一致的问题。

三、dependencyManagement示例解析

1. 项目结构

假设我们有一个多模块的项目，项目结构如下：

复制代码

parent-project/          # 根 POM 项目
│
├── module-parent/       # 父模块（真正的依赖管理模块）
│   ├── pom.xml          # 包含 <dependencyManagement> 等依赖版本管理
│
├── module-a/            # 子模块 A
│   └── pom.xml
│
├── module-b/            # 子模块 B
│   └── pom.xml

在这个示例中，module-parent 模块作为父模块，集中管理所有依赖的版本，module-a 和 module-b 作为子模块，继承父模块的配置。

2. 父模块 module-parent 的 pom.xml

父模块 module-parent 的 pom.xml 中将所有依赖的版本管理集中在 <dependencyManagement> 中，而不直接在依赖中指定版本。

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.example</groupId>
    <artifactId>module-parent</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

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

    <dependencyManagement>
        <dependencies>
            <!-- 统一管理版本 -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
                <version>3.0.0</version>  <!-- Boot 3.x -->
            </dependency>

            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-bus-amqp</artifactId>
                <version>3.0.0</version>  <!-- Spring Cloud 3.x -->
            </dependency>

            <dependency>
                <groupId>com.fasterxml.jackson.core</groupId>
                <artifactId>jackson-databind</artifactId>
                <version>2.13.1</version>  <!-- Jackson 2.x -->
            </dependency>

            <dependency>
                <groupId>org.springframework.security</groupId>
                <artifactId>spring-security-core</artifactId>
                <version>5.5.1</version>  <!-- Spring Security 5.x -->
            </dependency>

            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-jpa</artifactId>
                <version>3.0.0</version>  <!-- Boot 3.x -->
            </dependency>

            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <version>3.0.0</version>  <!-- Boot 3.x -->
                <scope>test</scope>
            </dependency>

            <dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-lang3</artifactId>
                <version>3.12.0</version>  <!-- Commons Lang 3.x -->
            </dependency>

            <dependency>
                <groupId>org.flywaydb</groupId>
                <artifactId>flyway-core</artifactId>
                <version>9.3.0</version>  <!-- Flyway 9.x -->
            </dependency>

            <dependency>
                <groupId>org.springframework.kafka</groupId>
                <artifactId>spring-kafka</artifactId>
                <version>3.0.0</version>  <!-- Spring Kafka 3.x -->
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

** dependencyManagement 的关键作用**

在父 POM 中集中管理了 spring-boot-starter-web、spring-cloud-starter-bus-amqp、jackson-databind 等多个依赖的版本。
子模块 module-a 和 module-b 只需要引用这些依赖，而不需要显式指定版本号。

3. 子模块 module-a 和 module-b 的 pom.xml

module-a 的 pom.xml

在子模块 module-a 中，我们只需要引用父模块定义的依赖，而无需指定版本号：

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.example</groupId>
        <artifactId>module-parent</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../module-parent/pom.xml</relativePath> <!-- 引用父模块 -->
    </parent>

    <artifactId>module-a</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bus-amqp</artifactId>
        </dependency>

        <!-- 其他依赖 -->
    </dependencies>
</project>

module-b 的 pom.xml

同样，module-b 也无需指定版本号，自动继承父模块中的版本管理：

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.example</groupId>
        <artifactId>module-parent</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../module-parent/pom.xml</relativePath>
    </parent>

    <artifactId>module-b</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bus-amqp</artifactId>
        </dependency>

        <!-- 其他依赖 -->
    </dependencies>
</project>

四、dependencyManagement的优势

统一版本管理

<dependencyManagement> 的最大优势是将版本集中在父 POM 中管理，避免了子模块中的版本不一致。这样可以确保所有子模块使用相同版本的依赖，避免版本冲突。

降低维护成本

当需要更新某个依赖的版本时，只需要在父 POM 中修改版本号，所有子模块会自动继承新的版本，减少了手动更新多个子模块的工作量。

确保兼容性

集中管理版本可以确保所有模块之间的依赖版本兼容，避免由于版本不同而导致的兼容性问题。

五、总结

通过本文的讲解，我们深入了解了 <dependencyManagement> 在多模块 Maven 项目中的应用。通过集中管理依赖版本，<dependencyManagement> 帮助我们保持项目中所有模块的依赖一致性，避免版本冲突，简化了项目的维护和版本升级工作。