快捷導(dǎo)航

Maven dependencyManagement元素標(biāo)簽的具體使用

更新時(shí)間：2024年03月28日 14:24:24 作者：懶鳥(niǎo)一枚

在Maven中dependencyManagement的作用其實(shí)相當(dāng)于一個(gè)對(duì)所依賴(lài)jar包進(jìn)行版本管理的管理器,本文主要介紹了Maven dependencyManagement元素標(biāo)簽的具體使用,感興趣的可以了解一下

我們知道，子模塊可以通過(guò)繼承獲得父模塊中聲明的全部依賴(lài)，這樣雖然避免了在各個(gè)子模塊 POM 中重復(fù)進(jìn)行依賴(lài)聲明，但也極有可能造成子模塊中引入一些不必要的依賴(lài)。為此 Maven 引入了 dependencyManagement 來(lái)對(duì)依賴(lài)進(jìn)行管理。

依賴(lài)管理

Maven 可以通過(guò) dependencyManagement 元素對(duì)依賴(lài)進(jìn)行管理，它具有以下 2 大特性：

在該元素下聲明的依賴(lài)不會(huì)實(shí)際引入到模塊中，只有在 dependencies 元素下同樣聲明了該依賴(lài)，才會(huì)引入到模塊中。
該元素能夠約束 dependencies 下依賴(lài)的使用，即 dependencies 聲明的依賴(lài)若未指定版本，則使用 dependencyManagement 中指定的版本，否則將覆蓋 dependencyManagement 中的版本。
例如，修改 App-Data-lib 模塊的 pom.xml 如下。

<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--由于不是繼承，所以必須重新添加 groupId 和 version-->
    <groupId>org.example</groupId>
    <artifactId>App-Data-lib</artifactId>
    <version>1.0</version>
    <!--dependencyManagement 標(biāo)簽用于控制子模塊的依賴(lài)版本等信息 -->
    <!-- 該標(biāo)簽只用來(lái)控制版本，不能將依賴(lài)引入 -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <!--引用的properties標(biāo)簽中定義的屬性 -->
                <version>1.2.17</version>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <!--引用的properties標(biāo)簽中定義的屬性 -->
                <version>4.9</version>
                <!-- <scope>test</scope> -->
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <!--引用的properties標(biāo)簽中定義的屬性 -->
                <version>5.1.18</version>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>c3p0</groupId>
                <artifactId>c3p0</artifactId>
                <!--引用的properties標(biāo)簽中定義的屬性 -->
                <version>0.9.1</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <!--聲明依賴(lài)-->
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
    </dependencies>
</project>

在以上配置中，由于 dependencyManagement 元素中已經(jīng)定義完整的依賴(lài)聲明，所以在 dependencies 元素中聲明的依賴(lài)只配置了 groupId 和 artifactId，省略了 version 和 scope。

在實(shí)際的開(kāi)發(fā)過(guò)程中，dependencyManagement 很少會(huì)單獨(dú)使用，通常它需要與 Maven 繼承或依賴(lài)范圍 import 配合使用才能展現(xiàn)它的優(yōu)勢(shì)。

繼承依賴(lài)管理

由于 dependencyManagement 元素是可以被繼承的，因此我們可以在父模塊 POM 中使用 dependencyManagement 元素聲明所有子模塊的依賴(lài)，然后在各個(gè)子模塊 POM 使用 dependencies 元素聲明實(shí)際用到的依賴(lài)即可。這樣既可以讓子模塊能夠繼承父模塊的依賴(lài)配置，還能避免將不必要的依賴(lài)引入到子模塊中。

1. 修改父模塊 Root 的 pom.xml 如下。

<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.example</groupId>
    <artifactId>Root</artifactId>
    <version>1.0</version>
    <!--定義的父類(lèi)pom.xml 打包類(lèi)型使pom -->
    <packaging>pom</packaging>
    <properties>
        <!-- 定義一些 maven 變量 -->
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <log4j.version>1.2.17</log4j.version>
        <junit.version>4.9</junit.version>
        <system.version>1.0</system.version>
        <mysql.connector.version>5.1.18</mysql.connector.version>
        <c3p0.version>0.9.1</c3p0.version>
    </properties>
    <!--dependencyManagement 標(biāo)簽用于控制子模塊的依賴(lài)版本等信息 -->
    <!-- 該標(biāo)簽只用來(lái)控制版本，不能將依賴(lài)引入 -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <!--引用的properties標(biāo)簽中定義的變量 -->
                <version>${log4j.version}</version>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <!--引用的properties標(biāo)簽中定義的變量 -->
                <version>${junit.version}</version>
                <!-- <scope>test</scope> -->
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <!--引用的properties標(biāo)簽中定義的變量 -->
                <version>${mysql.connector.version}</version>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>c3p0</groupId>
                <artifactId>c3p0</artifactId>
                <!--引用的properties標(biāo)簽中定義的變量 -->
                <version>${c3p0.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

注：以上配置中，將所有依賴(lài)的版本信息以 Maven 變量（properties）的形式提取出來(lái)，這樣不僅消除了一些重復(fù)，也使得各個(gè)依賴(lài)的版本信息更加明顯，便于管理。

在父模塊 Root 中使用 dependencyManagement 元素聲明的依賴(lài)，既不會(huì)給 Root 模塊引入依賴(lài)，也不會(huì)給其子模塊引入依賴(lài)，但這段配置是可以被繼承的。

2. 修改子模塊 App-Core-lib 的 pom.xml 如下。

<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <artifactId>App-Core-lib</artifactId>
    <parent>
        <groupId>org.example</groupId>
        <artifactId>Root</artifactId>
        <version>1.0</version>
        <relativePath>../Root</relativePath>
    </parent>
    <dependencies>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>c3p0</groupId>
            <artifactId>c3p0</artifactId>
        </dependency>
    </dependencies>
    <distributionManagement>
        <repository>
            <id>bianchengbang_Release_hosted</id>
            <url>http://localhost:8082/nexus/content/repositories/bianchengbang_Release_hosted/</url>
        </repository>
        <snapshotRepository>
            <id>Snapshot</id>
            <url>http://localhost:8082/nexus/content/repositories/bianchengbang_Snapshot_hosted/</url>
        </snapshotRepository>
    </distributionManagement>
</project>

在子模塊 App-Core-lib 和 App-Data-lib 的 POM 中，所有在 dependencies 元素中聲明的依賴(lài)都只配置了 groupId 和 artifactId，省去了 version 和 scope。之所以能夠省略這些信息，是因?yàn)樗鼈兝^承了父模塊 Root 中 dependencyManagement 的配置，其完整的依賴(lài)聲明已經(jīng)包含在父模塊的 POM 中，子模塊只需要配置 groupId 和 artifactId 就能獲得相應(yīng)的依賴(lài)信息，從而引入正確的依賴(lài)。

使用這種依賴(lài)管理機(jī)制似乎并不能減少太多 POM 配置，但我們?nèi)匀煌扑]使用這種方式，其原因主要有 2 個(gè)：

-在父模塊中使用 dependencyManagement 聲明依賴(lài)能夠統(tǒng)一項(xiàng)目?jī)?nèi)依賴(lài)的版本，子模塊無(wú)須聲明版本，也就不會(huì)出現(xiàn)多個(gè)子模塊使用同一依賴(lài)項(xiàng)版本不一致的情況，降低依賴(lài)沖突的幾率。

dependencyManagement 聲明的依賴(lài)不會(huì)被實(shí)際引入，子模塊需要什么依賴(lài)就自己引入，增加了靈活性，避免引入一些不必要的依賴(lài)。

導(dǎo)入依賴(lài)管理

因?yàn)?import 依賴(lài)范圍只能與 dependencyManagement 元素配合使用才會(huì)有效，其功能是將目標(biāo) pom.xml 中的 dependencyManagement 配置導(dǎo)入合并到當(dāng)前 pom.xml 的 dependencyManagement 中。

例如，App-Data-lib 模塊想要使用 Root 模塊中的 dependencyManagement 配置，除了通過(guò)繼承或者直接復(fù)制這兩種方式之外，還可以使用 import 依賴(lài)范圍將其導(dǎo)入，具體配置如下。

<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--由于不是繼承，所以必須重新添加 groupId 和 version-->
    <groupId>org.example</groupId>
    <artifactId>App-Data-lib</artifactId>
    <version>1.0</version>
    <!--定義依賴(lài)管理-->
    <dependencyManagement>
        <dependencies>
            <!--導(dǎo)入依賴(lài)管理配置-->
            <dependency>
                <groupId>org.example</groupId>
                <artifactId>Root</artifactId>
                <version>1.0</version>
                <!--依賴(lài)范圍為 import-->
                <scope>import</scope>
                <!--類(lèi)型一般為pom-->
                <type>pom</type>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <!--聲明依賴(lài)-->
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
    </dependencies>
</project>

以上配置中，由于 import 依賴(lài)范圍的特殊性，一般都是指向打包類(lèi)型為 pom 的模塊，所以 type 元素的值一般為 pom。

若存在多個(gè)模塊，它們使用的依賴(lài)版本都是一致的，則就可以定義一個(gè)使用 dependencyManagement 專(zhuān)門(mén)管理依賴(lài)的 POM，然后在各個(gè)模塊中導(dǎo)入這些依賴(lài)管理配置。

到此這篇關(guān)于Maven dependencyManagement元素標(biāo)簽的具體使用的文章就介紹到這了,更多相關(guān)Maven dependencyManagement內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: