企业级依赖管理: 深入解读 Maven BOM
一、背景
当开发者在一个大型项目中使用 Maven 进行依赖管理时，项目往往会包含多个模块或子项目，并且这些模块会共享相同的依赖项。但是，不同模块可能会独立地指定各自的依赖版本，这可能导致以下问题：
- 依赖版本不一致： 不同模块中对相同依赖项使用不同的版本号，可能导致潜在的兼容性问题或冲突。
- 版本管理困难： 在多个模块中管理和维护依赖版本的一致性可能变得复杂，因为需要手动确保每个模块中的依赖版本保持同步。
- 重复配置： 在每个模块中单独指定依赖项的版本，导致了大量的重复配置，增加了维护成本。
为解决以上问题，Maven BOM（Bill of Materials，依赖关系管理）被引入，提供了一种集中管理依赖版本的方法。
此时有些同学可能会有疑问：我可以在项目的根pom中通过
诚然，当项目使用 Maven 的 dependencyManagement 标签集中管理依赖时，确实能够集中指定依赖版本，但这种方式并不能将该项目的依赖版本供其他项目使用；相信大家对springboot并不陌生，在使用springboot的开发过程中我们通常可以看到如下依赖：
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-dependenciesartifactId>
<version>2.6.3version>
<type>pomtype>
<scope>importscope>
dependency>
<dependency>
<groupId>com.alibaba.cloudgroupId>
<artifactId>aliyun-spring-boot-dependenciesartifactId>
<version>1.0.0version>
<type>pomtype>
<scope>importscope>
Spring Boot BOM（Bill of Materials，依赖关系管理）的优势在于，它不仅集中管理依赖版本，还允许其他项目通过引用 Spring Boot BOM 来继承其依赖版本管理的功能。换句话说，其他项目可以直接引入 Spring Boot BOM，继承其所管理的依赖版本，而无需单独指定每个依赖的版本。
相比之下，普通的 Maven 项目中，使用 dependencyManagement 标签虽然能够在当前项目中集中管理依赖版本，但其他项目无法直接继承该管理依赖版本的配置，需要手动复制相应的依赖管理部分到其他项目中，这样会增加维护成本且可能出现版本不一致的问题。
文章中提及的所有代码示例都可以在 GitHub 上找到：maven-bom-examples
二、什么是BOM
Maven 项目的打包类型时，通常可以分为三种：
- jar： 这是最常见的打包类型，适用于普通的 Java 项目。项目会以 jar 类型的格式进行打包。
- pom： 这种类型的项目通常被用作多模块项目的管理和维护。在父模块中定义了依赖项、插件等内容，实现了对版本的统一维护管理。
- war： 这类项目打包成为可运行的 Java Web 项目，例如可以在诸如 Tomcat、Jetty 等应用服务器上运行。
BOM 实际上是一个以 POM 类型定义的普通 Maven 项目，主要用于维护描述 Maven 项目所需的一系列公共依赖信息。通过引用 BOM 项目，可以实现对依赖版本的统一维护管理，而无需明确指定每个依赖项的版本号。
BOM 文件结构定义结构
<parent>
<groupId>org.examplegroupId>
<artifactId>maven-bom-examplesartifactId>
<version>${revision}version>
parent>
<packaging>pompackaging>
<artifactId>example-bomartifactId>
<properties>
properties>
<dependencyManagement>
<dependencies>
dependencies>
dependencyManagement>
<build>
<pluginManagement>
<plugins>
plugins>
pluginManagement>
build>
三、使用指南
3.1、创建bom
当创建 BOM（Bill Of Materials，物料清单）时，常见的两种方式包括：
- 单独仓库存放依赖： 在一个专门的仓库中，建立 BOM 模块用于存放特定需求的依赖信息。这种方法适用于需要隔离和管理独立的依赖需求，确保依赖版本独立于其他项目。
- 应用内创建 BOM 模块： 在现有应用的仓库中创建 BOM 模块，让应用的所有子模块共享使用。这种方法适用于在应用内统
选择使用哪种方式创建 BOM 取决于需求的特点和项目的架构，本文参考aliyun-spring-boot 实现方式，即应用内创建BOM模块。
新建一个maven-bom-examples项目，其目录结构如下：
maven-bom-examples
├─.idea
├─example-bom
│ └─pom.xml
└─pom.xml
example-bom模块pom.xml文件如下：
<parent>
<groupId>org.examplegroupId>
<artifactId>maven-bom-examplesartifactId>
<version>${revision}version>
parent>
<packaging>pompackaging>
<artifactId>example-bomartifactId>
<properties>
<mysql.connector.java.version>8.0.33mysql.connector.java.version>
<lingxi.cas.starter.version>1.1.4-RELEASElingxi.cas.starter.version>
properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
<version>${mysql.connector.java.version}version>
dependency>
<dependency>
<groupId>com.qihoo.finance.lingxigroupId>
<artifactId>lingxi-cas-starterartifactId>
<version>${lingxi.cas.starter.version}version>
dependency>
dependencies>
dependencyManagement>
<build>
<pluginManagement>
<plugins>
<plugin>
plugin>
plugins>
pluginManagement>
build>
project>
3.2、错误使用：循环依赖
为了maven-bom-examples后续创建新的子模块可以使用bom的统一依赖，传统方式应该是将example-bom的GAV坐标放在maven-bom-examples的
<groupId>org.examplegroupId>
<artifactId>maven-bom-examplesartifactId>
<version>${revision}version>
<packaging>pompackaging>
<modules>
<module>example-bommodule>
modules>
<properties>
<revision>1.0.0-SNAPSHOTrevision>
<maven.compiler.source>8maven.compiler.source>
<maven.compiler.target>8maven.compiler.target>
<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.examplegroupId>
<artifactId>example-bomartifactId>
<version>${revision}version>
<type>pomtype>
<scope>importscope>
dependency>
dependencies>
dependencyManagement>
project>
然而这种做法会导致项目打包报错，如下：循环依赖
> mvn clean install
[ERROR] The project org.example:maven-bom-examples:1.0.0-SNAPSHOT (D:\IdeaProjects\maven-bom-examples\pom.xml) has 1 error
[ERROR] The dependencies of type=pom and with scope=import form a cycle: org.example:example-bom:1.0.0-SNAPSHOT -> org.example:example-bom:1.0.0-SNAPSHOT @ org.example:example-bom:1.0.0-SNAPSHOT
导致循环依赖的原因在于：maven-bom-examples的POM 是以 type=pom 和 scope=import 的方式导入example-bom的pom，而example-bom的pom又依赖于父pom，即maven-bom-examples，因而形成了循环依赖导致maven报错；需要注意的是如果依赖的是jar包类型的子模块则不会有循环依赖问题，
例如新增一个example-api子模块，此时目录结构如下：
maven-bom-examples
├─.idea
├─example-api
│ └─src
│ └─pom.xml
├─example-bom
│ └─pom.xml
└─pom.xml
maven-bom-examplespom新增example-api依赖，更改如下：
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.examplegroupId>
<artifactId>example-apiartifactId>
<version>${revision}version>
dependency>
dependencies>
dependencyManagement>
此时打包正常，可以看到example-api与example-bom 处于同级目录，却只有example-bom 出现了循环依赖，这根本原因便在于
而example-api模块为普通jar包模块故不会导致循环依赖问题。
3.3、正确使用
正确的使用方式是创建一个名为 example-parent 模块，使其与 example-bom处于同级目录下，并在 example-parent 模块中导入 BOM 的依赖。然后，其他子模块只需引入 example-parent 模块作为其父模块，从而实现对 BOM 依赖的继承。此时目录结构如下：
maven-bom-examples
├─.idea
├─example-api
│ └─src
│ └─pom.xml
├─example-parent
│ └─pom.xml
├─example-bom
│ └─pom.xml
└─pom.xml
example-parent pom如下：由于example-parent 与 example-bom处于同级目录下，故不会出现循环依赖问题。
<parent>
<groupId>org.examplegroupId>
<artifactId>maven-bom-examplesartifactId>
<version>${revision}version>
parent>
<packaging>pompackaging>
<artifactId>example-parentartifactId>
<properties>
<maven.compiler.source>8maven.compiler.source>
<maven.compiler.target>8maven.compiler.target>
<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.examplegroupId>
<artifactId>example-bomartifactId>
<version>${revision}version>
<type>pomtype>
<scope>importscope>
dependency>
dependencies>
dependencyManagement>
project>
maven-bom-examplespom：无依赖
<groupId>org.examplegroupId>
<artifactId>maven-bom-examplesartifactId>
<version>${revision}version>
<packaging>pompackaging>
<modules>
<module>example-bommodule>
<module>example-apimodule>
<module>example-parentmodule>
modules>
<properties>
<revision>1.0.0-SNAPSHOTrevision>
<maven.compiler.source>8maven.compiler.source>
<maven.compiler.target>8maven.compiler.target>
<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
properties>
project>
3.4、创建子模块
由于 example-parent 模块引入了 BOM 依赖，因此，若要在后续的子模块中使用统一的依赖管理，只需要在 example-parent 父模块下创建相应的子模块即可实现统一依赖的继承。例如新建example-model，此时目录结构如下：
maven-bom-examples
├─.idea
├─example-api
│ ├─src
│ └─pom.xml
├─example-parent
│ ├─example-model
│ │ ├─src
│ │ └─pom.xml
│ └─pom.xml
├─example-bom
│ └─pom.xml
└─pom.xml
example-parentpom如下：
<parent>
<groupId>org.examplegroupId>
<artifactId>maven-bom-examplesartifactId>
<version>${revision}version>
parent>
<packaging>pompackaging>
<artifactId>example-parentartifactId>
<modules>
<module>example-modelmodule>
modules>
<properties>
<maven.compiler.source>8maven.compiler.source>
<maven.compiler.target>8maven.compiler.target>
<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.examplegroupId>
<artifactId>example-bomartifactId>
<version>${revision}version>
<type>pomtype>
<scope>importscope>
dependency>
dependencies>
dependencyManagement>
example-modelpom如下：
<parent>
<groupId>org.examplegroupId>
<artifactId>example-parentartifactId>
<version>${revision}version>
parent>
<artifactId>example-modelartifactId>
<properties>
<maven.compiler.source>8maven.compiler.source>
<maven.compiler.target>8maven.compiler.target>
<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
properties>
<dependencies>
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
dependency>
<dependency>
<groupId>com.qihoo.finance.lingxigroupId>
<artifactId>lingxi-cas-starterartifactId>
dependency>
dependencies>
3.5、扩展：
<parent>
<groupId>xxxgroupId>
<artifactId>xxxartifactId>
<version>xxxversion>
<relativePath>../xxx/pom.xmlrelativePath>
parent>
这个元素通常在子模块的 POM 文件中用于指定父 POM 文件的路径，以便在项目中更灵活地管理父子模块之间的关系。
如果父模块就在当前项目的根目录下，则不需要指定 example-model子模块就无需使用
之所以要介绍
此时新增example-relative子模块，目录结构如下：
maven-bom-examples
├─.idea
├─example-api
│ ├─src
│ └─pom.xml
├─example-parent
│ ├─example-model
│ │ ├─src
│ │ └─pom.xml
│ └─pom.xml
├─example-bom
│ └─pom.xml
├─example-relative
│ ├─src
│ └─pom.xml
└─pom.xml
example-relativepom：
<parent>
<groupId>org.examplegroupId>
<artifactId>example-parentartifactId>
<version>${revision}version>
<relativePath>../example-parent/pom.xmlrelativePath>
parent>
<artifactId>example-relativeartifactId>
<properties>
<maven.compiler.source>8maven.compiler.source>
<maven.compiler.target>8maven.compiler.target>
<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
properties>
<dependencies>
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
dependency>
dependencies>
example-parentpom：
<parent>
<groupId>org.examplegroupId>
<artifactId>maven-bom-examplesartifactId>
<version>${revision}version>
parent>
<packaging>pompackaging>
<artifactId>example-parentartifactId>
<modules>
<module>example-modelmodule>
<module>../example-relativemodule>
modules>
<properties>
<maven.compiler.source>8maven.compiler.source>
<maven.compiler.target>8maven.compiler.target>
<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.examplegroupId>
<artifactId>example-bomartifactId>
<version>${revision}version>
<type>pomtype>
<scope>importscope>
dependency>
dependencies>
dependencyManagement>
四、总结
当涉及到大型项目和多模块应用时，Maven BOM（Bill of Materials）提供了一种管理依赖版本的强大机制。通过创建BOM可以：
- 集中管理依赖的版本号，确保各模块使用相同的依赖版本。
- 减少版本冲突和不一致性的问题，提高项目的稳定性和可靠性。
- 允许其他项目引用BOM并继承其依赖版本，减少重复配置的需求，提高项目的可维护性和一致性。
深入理解和有效使用Maven BOM有助于简化依赖管理过程，提高项目的开发效率和整体质量。
五、相关资料
- debezium
- aliyun-spring-boot-parent