Maven项目依赖版本统一：掌握dependencyManagement的精髓（精髓.依赖.版本.项目.Maven...）

Maven项目依赖版本统一：掌握dependencyManagement的精髓

在Maven父子项目中，实现依赖版本统一管理并允许子模块省略版本声明，是提升项目可维护性的关键。本文将深入探讨如何通过父POM中的<dependencyManagement>标签实现这一目标，从而避免在多个子模块中重复指定依赖版本，确保项目依赖的一致性，并简化版本升级流程。Maven依赖版本管理的挑战

在大型maven多模块项目中，通常会采用父子pom结构来管理各个子模块。然而，一个常见的痛点是，即使子模块继承了父pom，它们仍然需要为每个依赖项明确指定版本，即使这些依赖项的版本已经在父pom中定义过。这导致了版本信息在多处冗余，一旦某个依赖的版本需要升级，就需要在所有使用到它的子模块中逐一修改，这不仅效率低下，还极易引入版本不一致的问题。

例如，如果父POM中已经定义了fisgar-model的某个版本，但在子POM中仍然需要像下面这样显式声明：

<dependency>
    <groupId>br.com.fisgar</groupId>
    <artifactId>fisgar-model</artifactId>
    <version>${project.version}</version> <!-- 仍需指定版本 -->
</dependency>

理想情况下，我们希望像Spring Boot Starter Parent那样，子模块只需声明依赖而无需指定版本，由父POM统一管理，例如：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <!-- 版本由父POM管理，此处无需指定 -->
</dependency>

解决方案：使用<dependencyManagement>

Maven提供了一个强大的机制来解决这个问题，那就是在父POM中使用<dependencyManagement>标签。

<dependencyManagement>的作用

<dependencyManagement>标签位于POM文件的<project>根元素下，它用于声明项目中的依赖项及其版本，但不实际引入这些依赖。它的核心作用是：

集中管理版本：将所有常用依赖的版本信息集中定义在父POM中，作为“依赖版本目录”。
版本仲裁：当子模块声明了在<dependencyManagement>中定义的依赖时，如果子模块没有指定版本，Maven会自动使用父POM中定义的版本。
强制一致性：确保所有子模块使用相同版本的特定依赖，避免版本冲突。

如何在父POM中配置

在你的父POM（parent.pom）中，添加<dependencyManagement>部分，并在其中列出你希望统一管理的所有依赖项及其版本。

父POM示例 (parent.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.yourcompany</groupId>
    <artifactId>your-parent-project</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging> <!-- 父POM通常是pom类型 -->

    <name>Your Parent Project</name>
    <description>Centralized dependency management for all sub-modules</description>

    <properties>
        <!-- 可以在这里定义版本属性，方便管理和升级 -->
        <fisgar-model.version>1.2.3</fisgar-model.version>
        <slf4j.version>1.7.32</slf4j.version>
        <junit.version>5.8.2</junit.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <!-- 声明 fisgar-model 依赖及其版本 -->
            <dependency>
                <groupId>br.com.fisgar</groupId>
                <artifactId>fisgar-model</artifactId>
                <version>${fisgar-model.version}</version>
            </dependency>

            <!-- 声明 SLF4J API 依赖及其版本 -->
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-api</artifactId>
                <version>${slf4j.version}</version>
            </dependency>

            <!-- 声明 JUnit 依赖及其版本 -->
            <dependency>
                <groupId>org.junit.jupiter</groupId>
                <artifactId>junit-jupiter-api</artifactId>
                <version>${junit.version}</version>
                <scope>test</scope>
            </dependency>
            <!-- 更多需要统一管理的依赖... -->
        </dependencies>
    </dependencyManagement>

    <build>
        <pluginManagement>
            <!-- 插件管理也可以类似地集中在这里 -->
        </pluginManagement>
    </build>

    <modules>
        <!-- 如果有子模块，在这里声明 -->
        <!-- <module>your-child-module</module> -->
    </modules>

</project>

在上述父POM中，我们通过<dependencyManagement>声明了fisgar-model、slf4j-api和junit-jupiter-api的版本。注意，这里只是声明了版本，并没有实际将这些依赖添加到父POM的类路径中。

如何在子POM中引用

子模块的POM只需要继承这个父POM，并在自己的<dependencies>部分中声明所需的依赖，而无需指定版本。Maven会自动从父POM的<dependencyManagement>中查找并应用对应的版本。

子POM示例 (child.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.yourcompany</sgroupId>
        <artifactId>your-parent-project</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <artifactId>your-child-module</artifactId>
    <packaging>jar</packaging>

    <name>Your Child Module</name>
    <description>A sub-module using managed dependencies</description>

    <dependencies>
        <!-- 引用 fisgar-model，版本由父POM的 dependencyManagement 管理 -->
        <dependency>
            <groupId>br.com.fisgar</groupId>
            <artifactId>fisgar-model</artifactId>
            <!-- 注意：此处无需指定版本 -->
        </dependency>

        <!-- 引用 SLF4J API，版本由父POM的 dependencyManagement 管理 -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <!-- 注意：此处无需指定版本 -->
        </dependency>

        <!-- 引用 JUnit，版本由父POM的 dependencyManagement 管理 -->
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-api</artifactId>
            <!-- 注意：此处无需指定版本 -->
        </dependency>
        <!-- 更多实际使用的依赖... -->
    </dependencies>

</project>

通过这种方式，当your-child-module需要fisgar-model时，它只需要声明其groupId和artifactId。Maven在解析这个POM时，会向上查找父POM的<dependencyManagement>部分，找到fisgar-model对应的版本（1.2.3），并将其应用到子模块中。

注意事项与最佳实践

<dependencyManagement> vs. <dependencies>：
- <dependencyManagement>：声明依赖及其版本，但不实际引入。它只是一个“版本清单”。
- <dependencies>：实际引入依赖到当前模块的类路径中。只有在<dependencies>中声明的依赖才会被打包或用于编译。子模块必须在自己的<dependencies>中显式声明需要使用的依赖，即使其版本已由父POM管理。
版本覆盖：如果子模块在自己的<dependencies>中显式指定了某个依赖的版本，那么这个版本会覆盖父POM中<dependencyManagement>定义的版本。这提供了灵活性，允许特定子模块在必要时使用不同版本的依赖。
```
<dependencies>
    <dependency>
        <groupId>br.com.fisgar</groupId>
        <artifactId>fisgar-model</artifactId>
        <version>2.0.0</version> 
    </dependency>
</dependencies>
```

使用属性管理版本：推荐在父POM的<properties>中定义依赖的版本号，然后在<dependencyManagement>中引用这些属性。这使得版本升级更加方便，只需修改一处属性值即可。

<properties>
    <spring.version>5.3.20</spring.version>
</properties>
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>
    </dependencies>
</dependencyManagement>