Maven中BOM

一、BOM简介

BOM(Bill of Materials)是由Maven提供的功能,它通过定义一整套相互兼容的jar包版本集合,使用时只需要依赖该BOM文件,即可放心的使用需要的依赖jar包,且无需再指定版本号。BOM的维护方负责版本升级,并保证BOM中定义的jar包版本之间的兼容性。

  • 1.1、为什么需要BOM

使用BOM除了可以方便使用者在声明依赖的客户端时不需要指定版本号外,最主要的原因是可以解决依赖冲突,如考虑以下的依赖场景:

项目A依赖项目B 2.1和项目C 1.2版本: 
项目B 2.1依赖项目D 1.1版本; 
项目C 1.2依赖项目D 1.3版本;

在该例中,项目A对于项目D的依赖就会出现冲突,按照maven dependency mediation的规则,最后生效的可能是:项目A中会依赖到项目D1.1版本(就近原则,取决于路径和依赖的先后,和Maven版本有关系)。
在这种情况下,由于项目C依赖1.3版本的项目D,但是在运行时生效的确是1.1版本,所以在运行时很容易产生问题,如 NoSuchMethodError, ClassNotFoundException等。

  • 1.2、如何定义BOM

BOM本质上是一个普通的POM文件,区别是对于使用方而言,生效的只有<dependencyManagement>这一个部分。只需要在<dependencyManagement>定义对外发布的客户端版本即可:

<?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.ydj.qd</groupId>
    <artifactId>inf-bom</artifactId>
    <version>1.0</version>
    <packaging>pom</packaging>

    <name>inf-bom</name>
    <description>第三方jar包统一管理</description>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring.version>4.3.15.RELEASE</spring.version>
    </properties>

    <dependencyManagement>
        <dependencies>

            <!-- 阿里 -->
            <!-- https://mvnrepository.com/artifact/com.alibaba/druid -->
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.12</version>
            </dependency>
            <!-- https://mvnrepository.com/artifact/com.aliyun.mns/aliyun-sdk-mns -->
            <dependency>
                <groupId>com.aliyun.mns</groupId>
                <artifactId>aliyun-sdk-mns</artifactId>
                <version>1.1.8</version>
                <classifier>jar-with-dependencies</classifier>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>1.2.29</version>
            </dependency>

            <!-- Apache -->
            <dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-lang3</artifactId>
                <version>3.3.2</version>
            </dependency>
            <dependency>
                <groupId>commons-collections</groupId>
                <artifactId>commons-collections</artifactId>
                <version>3.2.2</version>
            </dependency>
            <dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-collections4</artifactId>
                <version>4.1</version>
            </dependency>
            <dependency>
                <groupId>commons-beanutils</groupId>
                <artifactId>commons-beanutils</artifactId>
                <version>1.9.1</version>
            </dependency>


            <!-- 谷歌 -->
            <!-- https://mvnrepository.com/artifact/com.google.guava/guava -->
            <dependency>
                <groupId>com.google.guava</groupId>
                <artifactId>guava</artifactId>
                <version>27.0.1-jre</version>
            </dependency>
            <dependency>
                <groupId>com.google.code.gson</groupId>
                <artifactId>gson</artifactId>
                <version>2.8.5</version>
            </dependency>


            <!-- 常用工具 -->
            <dependency>
                <groupId>joda-time</groupId>
                <artifactId>joda-time</artifactId>
                <version>2.7</version>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.14.4</version>
            </dependency>

        </dependencies>
    </dependencyManagement>

    <build>
    </build>

    <distributionManagement>
        <repository>
            <id>maven-releases</id>
            <name>maven-releases</name>
            <url>http://mvn.ydj.com/repository/maven-releases/</url>
        </repository>
        <snapshotRepository>
            <id>maven-snapshots</id>
            <name>maven-snapshots</name>
            <url>http://mvn.ydj.com/repository/maven-snapshots/</url>
        </snapshotRepository>
    </distributionManagement>

</project>

二、项目使用方法

  • 2.1、在你的项目主pom.xml文件中<dependencyManagement></dependencyManagement>节点下首位处加入如下:
<dependencyManagement>
    <dependencies>
         <dependency>
            <groupId>com.jlcx.qd</groupId>
            <artifactId>inf-bom</artifactId>
            <version>${version}</version>
            <type>pom</type>
            <scope>import</scope>
          </dependency>
          
          <dependency>
            ...
          </dependency>
    </dependencies>
</dependencyManagement>
  • 2.2、在需要使用相关JAR包的pom.xml文件中<dependencies></dependencies>节点下引入如下:
    <dependencies>
        ...
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
        </dependency>

        <dependency>
            <groupId>commons-collections</groupId>
            <artifactId>commons-collections</artifactId>
        </dependency>
        ....
    </dependencies>

如果需要使用不同于当前bom中所维护的jar包版本,则加上<version>覆盖即可,如:

    <dependencies>
        ...
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
        </dependency>

        <dependency>
            <groupId>commons-collections</groupId>
            <artifactId>commons-collections</artifactId>
            <version>3.2.1</version>
        </dependency>
        ....
    </dependencies>

三、参考资料

### Maven BOM(Bill of Materials)的作用 Maven BOM 是一种特殊的 POM 文件,用于管理一组模块的版本一致性。它的主要目的是简化依赖管理和解决不同模块之间的版本冲突问题[^1]。通过引入 BOM,开发者可以确保所有相关组件都使用相同的版本号,从而减少因版本不一致而导致的问题。 BOM 的核心功能在于提供了一个统一的版本声明机制。当一个项目导入某个 BOM 后,该 BOM 中定义的所有依赖项都会自动继承其指定的版本号,而无需在 `pom.xml` 中显式地重复声明这些版本号[^3]。 --- ### Maven BOM 的用法 #### 1. 导入 BOM 到项目中 要在 Maven 项目中使用 BOM,可以通过 `<dependencyManagement>` 部分将其引入到父 POM 或子模块中: ```xml <dependencyManagement> <dependencies> <!-- 引入 MicroProfile BOM --> <dependency> <groupId>org.eclipse.microprofile</groupId> <artifactId>microprofile-bom</artifactId> <version>4.0</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> ``` 上述代码片段展示了如何将 `microprofile-bom` 引入到项目的依赖管理部分。注意以下几点: - `<groupId>` 和 `<artifactId>` 定义了 BOM 所属的坐标。 - `<version>` 指定了要使用的 BOM 版本。 - `<type>` 设置为 `pom` 表明这是一个 POM 类型的文件。 - `<scope>` 设置为 `import` 表示这是用来导入其他依赖管理的内容。 #### 2. 使用 BOM 中的依赖 一旦 BOM 被成功导入,就可以直接在项目中引用它所管理的依赖项,而不需要再手动指定版本号。例如: ```xml <dependencies> <dependency> <groupId>javax.ws.rs</groupId> <artifactId>jakarta.ws.rs-api</artifactId> </dependency> </dependencies> ``` 在这个例子中,由于 `microprofile-bom` 已经包含了 `jakarta.ws.rs-api` 的版本信息,因此这里只需要声明 groupId 和 artifactId 即可。 --- ### 实际案例分析 以 `MicroProfile BOM` 为例,该项目提供了 Jakarta EE 平台的一组标准化 API 及其实现版本控制方案。如果开发人员希望构建兼容 MicroProfile 的应用程序,则只需简单地引入对应的 BOM,并按照其中预设的标准来选择所需库。 另一个实际应用是 `CycloneDX-Maven-Plugin` 提供的功能支持。虽然此插件本身并不涉及传统意义上的 BOM 结构,但它能够生成软件物料清单(Software Bill Of Materials, SBOM),这有助于企业级安全审计以及供应链风险管理场景下的透明度提升工作[^2]。 --- ### 总结 Maven BOM 主要是为了帮助开发者更方便地处理复杂的多模块项目中的依赖关系问题。通过集中化的方式设定好各个构件的具体实现版本之后,在具体业务逻辑编写过程中便不再需要频繁调整个别第三方类库间的匹配情况;同时也降低了因为人为失误造成潜在隐患的可能性^。 ```python # 示例 Python 代码仅作为展示用途,与主题无关 def example_function(): print("This is an example function.") example_function() ```
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值