Maven排除依賴和可選依賴的使用方法

更新時間：2023年06月06日 11:07:32 作者：小日子呀

我們知道Maven依賴具有傳遞性，例如A依賴于B，B依賴于C，在不考慮依賴范圍等因素的情況下，Maven會根據(jù)依賴傳遞機制，將間接依賴C 引入到A中，但如果A出于某種原因，希望將間接依賴C排除，那該怎么辦呢，Maven為用戶提供了兩種解決方式排出和可選

排除依賴

假設(shè)存在這樣的依賴關(guān)系，A 依賴于 B，B 依賴于 X，B 又依賴于 Y。B 實現(xiàn)了兩個特性，其中一個特性依賴于 X，另一個特性依賴于 Y，且兩個特性是互斥的關(guān)系，用戶無法同時使用兩個特性，所以 A 需要排除 X，此時就可以在 A 中將間接依賴 X 排除。

排除依賴是通過在 A 中使用 exclusions 元素實現(xiàn)的，該元素下可以包含若干個 exclusion 子元素，用于排除若干個間接依賴，示例代碼如下。

<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>net.biancheng.www</groupId>
    <artifactId>A</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>net.biancheng.www</groupId>
            <artifactId>B</artifactId>
            <version>1.0-SNAPSHOT</version>
            <exclusions>
                <!-- 設(shè)置排除 -->
                <!-- 排除依賴必須基于直接依賴中的間接依賴設(shè)置為可以依賴為 false -->
                <!-- 設(shè)置當前依賴中是否使用間接依賴 -->
                <exclusion>
                    <!--設(shè)置具體排除-->
                    <groupId>net.biancheng.www</groupId>
                    <artifactId>X</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>
</project>

關(guān)于 exclusions 元素及排除依賴說明如下：

排除依賴是控制當前項目是否使用其直接依賴傳遞下來的接間依賴；
exclusions 元素下可以包含若干個 exclusion 子元素，用于排除若干個間接依賴；
exclusion 元素用來設(shè)置具體排除的間接依賴，該元素包含兩個子元素：groupId 和 artifactId，用來確定需要排除的間接依賴的坐標信息；
exclusion 元素中只需要設(shè)置 groupId 和 artifactId 就可以確定需要排除的依賴，無需指定版本 version。

可選依賴

與上文的應用場景相同，也是 A 希望排除間接依賴 X，我們還可以在 B 中將 X 設(shè)置為可選依賴。

設(shè)置可選依賴

在 B 的 POM 關(guān)于 X 的依賴聲明中使用 optional 元素，將其設(shè)置成可選依賴，示例配置如下。

<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/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>net.biancheng.www</groupId>
    <artifactId>B</artifactId>
    <packaging>jar</packaging>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>net.biancheng.www</groupId>
            <artifactId>X</artifactId>
            <version>1.0-SNAPSHOT</version>
            <!--設(shè)置可選依賴  -->
            <optional>true</optional>
        </dependency>
    </dependencies>
</project>

關(guān)于 optional 元素及可選依賴說明如下：