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

Maven依赖版本管理的挑战

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

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

    br.com.fisgar
    fisgar-model
    ${project.version} 

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

    org.springframework.boot
    spring-boot-starter-web
    

解决方案：使用

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

的作用

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

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

如何在父POM中配置

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

父POM示例 (parent.pom)：

    4.0.0

    com.yourcompany
    your-parent-project
    1.0.0-SNAPSHOT
    pom 

    Your Parent Project
    Centralized dependency management for all sub-modules

    
        
        1.2.3
        1.7.32
        5.8.2
    

    
        
            
            
                br.com.fisgar
                fisgar-model
                ${fisgar-model.version}
            

            
            
                org.slf4j
                slf4j-api
                ${slf4j.version}
            

            
            
                org.junit.jupiter
                junit-jupiter-api
                ${junit.version}
                test
            
            
        
    

    
        
            
        
    

    
        
        
    

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

如何在子POM中引用

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

Codiga

可自定义的静态代码分析检测工具

下载

子POM示例 (child.pom)：

    4.0.0

    
        com.yourcompany
        your-parent-project
        1.0.0-SNAPSHOT
    

    your-child-module
    jar

    Your Child Module
    A sub-module using managed dependencies

    
        
        
            br.com.fisgar
            fisgar-model
            
        

        
        
            org.slf4j
            slf4j-api
            
        

        
        
            org.junit.jupiter
            junit-jupiter-api
            
        
        
    

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

注意事项与最佳实践

1. vs. ：

   • ：声明依赖及其版本，但不实际引入。它只是一个“版本清单”。
   • ：实际引入依赖到当前模块的类路径中。只有在中声明的依赖才会被打包或用于编译。 子模块必须在自己的中显式声明需要使用的依赖，即使其版本已由父POM管理。

2. 版本覆盖： 如果子模块在自己的中显式指定了某个依赖的版本，那么这个版本会覆盖父POM中定义的版本。这提供了灵活性，允许特定子模块在必要时使用不同版本的依赖。

   
       
           br.com.fisgar
           fisgar-model
           2.0.0 
       
   

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

   
       5.3.20
   
   
       
           
               org.springframework
               spring-core
               ${spring.version}
           
       
   

4. 传递性依赖： 也能影响传递性依赖。如果某个直接依赖引入了冲突的传递性依赖，通过在中明确声明该传递性依赖的版本，可以强制Maven使用指定版本，解决依赖冲突。

总结

通过在Maven父POM中有效利用，可以极大地优化多模块项目的依赖管理。它提供了一种集中、统一的方式来控制所有子模块的依赖版本，避免了版本冗余和不一致，简化了项目维护和升级流程。掌握这一机制是构建健壮、可维护的Maven项目结构的关键一步。