dependencyManagement：管理Maven依赖

工具使用指南
天蓝色 发表于 2023年10月21日 11:21  352次阅读  举报

我们知道，子模块可以通过继承获得父模块中声明的全部依赖，这样虽然避免了在各个子模块 POM 中重复进行依赖声明，但也极有可能造成子模块中引入一些不必要的依赖。为此 Maven 引入了 dependencyManagement 来对依赖进行管理。

依赖管理

Maven 可以通过 dependencyManagement 元素对依赖进行管理，它具有以下 2 大特性：

  • 在该元素下声明的依赖不会实际引入到模块中，只有在 dependencies 元素下同样声明了该依赖，才会引入到模块中。
  • 该元素能够约束 dependencies 下依赖的使用，即 dependencies 声明的依赖若未指定版本，则使用 dependencyManagement 中指定的版本，否则将覆盖 dependencyManagement 中的版本。

例如，修改 App-Data-lib 模块的 pom.xml 如下。

  1. <project xmlns="http://maven.apache.org/POM/4.0.0"
  2.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <!--由于不是继承，所以必须重新添加 groupId 和 version-->
  6.     <groupId>net.jhelp.www</groupId>
  7.     <artifactId>App-Data-lib</artifactId>
  8.     <version>1.0</version>
  9.     <!--dependencyManagement 标签用于控制子模块的依赖版本等信息 -->
  10.     <!-- 该标签只用来控制版本，不能将依赖引入 -->
  11.     <dependencyManagement>
  12.         <dependencies>
  13.             <dependency>
  14.                 <groupId>log4j</groupId>
  15.                 <artifactId>log4j</artifactId>
  16.                 <!--引用的properties标签中定义的属性 -->
  17.                 <version>1.2.17</version>
  18.             </dependency>
  19.             <dependency>
  20.                 <groupId>junit</groupId>
  21.                 <artifactId>junit</artifactId>
  22.                 <!--引用的properties标签中定义的属性 -->
  23.                 <version>4.9</version>
  24.                 <!-- <scope>test</scope> -->
  25.             </dependency>
  26.             <dependency>
  27.                 <groupId>mysql</groupId>
  28.                 <artifactId>mysql-connector-java</artifactId>
  29.                 <!--引用的properties标签中定义的属性 -->
  30.                 <version>5.1.18</version>
  31.                 <scope>runtime</scope>
  32.             </dependency>
  33.             <dependency>
  34.                 <groupId>c3p0</groupId>
  35.                 <artifactId>c3p0</artifactId>
  36.                 <!--引用的properties标签中定义的属性 -->
  37.                 <version>0.9.1</version>
  38.             </dependency>
  39.         </dependencies>
  40.     </dependencyManagement>
  41.     <!--声明依赖-->
  42.     <dependencies>
  43.         <dependency>
  44.             <groupId>junit</groupId>
  45.             <artifactId>junit</artifactId>
  46.         </dependency>
  47.     </dependencies>
  48. </project>

 

在以上配置中，由于 dependencyManagement 元素中已经定义完整的依赖声明，所以在 dependencies 元素中声明的依赖只配置了 groupId 和 artifactId，省略了 version 和 scope。

在实际的开发过程中，dependencyManagement 很少会单独使用，通常它需要与 Maven 继承或依赖范围 import 配合使用才能展现它的优势。

继承依赖管理

由于 dependencyManagement 元素是可以被继承的，因此我们可以在父模块 POM 中使用 dependencyManagement 元素声明所有子模块的依赖，然后在各个子模块 POM 使用 dependencies 元素声明实际用到的依赖即可。这样既可以让子模块能够继承父模块的依赖配置，还能避免将不必要的依赖引入到子模块中。

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

  1. <project xmlns="http://maven.apache.org/POM/4.0.0"
  2.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <groupId>net.jhelp.www</groupId>
  6.     <artifactId>Root</artifactId>
  7.     <version>1.0</version>
  8.     <!--定义的父类pom.xml 打包类型使pom -->
  9.     <packaging>pom</packaging>
  10.     <properties>
  11.         <!-- 定义一些 maven 变量 -->
  12.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  13.         <log4j.version>1.2.17</log4j.version>
  14.         <junit.version>4.9</junit.version>
  15.         <system.version>1.0</system.version>
  16.         <mysql.connector.version>5.1.18</mysql.connector.version>
  17.         <c3p0.version>0.9.1</c3p0.version>
  18.     </properties>
  19.     <!--dependencyManagement 标签用于控制子模块的依赖版本等信息 -->
  20.     <!-- 该标签只用来控制版本，不能将依赖引入 -->
  21.     <dependencyManagement>
  22.         <dependencies>
  23.             <dependency>
  24.                 <groupId>log4j</groupId>
  25.                 <artifactId>log4j</artifactId>
  26.                 <!--引用的properties标签中定义的变量 -->
  27.                 <version>${log4j.version}</version>
  28.             </dependency>
  29.             <dependency>
  30.                 <groupId>junit</groupId>
  31.                 <artifactId>junit</artifactId>
  32.                 <!--引用的properties标签中定义的变量 -->
  33.                 <version>${junit.version}</version>
  34.                 <!-- <scope>test</scope> -->
  35.             </dependency>
  36.             <dependency>
  37.                 <groupId>mysql</groupId>
  38.                 <artifactId>mysql-connector-java</artifactId>
  39.                 <!--引用的properties标签中定义的变量 -->
  40.                 <version>${mysql.connector.version}</version>
  41.                 <scope>runtime</scope>
  42.             </dependency>
  43.             <dependency>
  44.                 <groupId>c3p0</groupId>
  45.                 <artifactId>c3p0</artifactId>
  46.                 <!--引用的properties标签中定义的变量 -->
  47.                 <version>${c3p0.version}</version>
  48.             </dependency>
  49.         </dependencies>
  50.     </dependencyManagement>
  51. </project>

注：以上配置中，将所有依赖的版本信息以 Maven 变量（properties）的形式提取出来，这样不仅消除了一些重复，也使得各个依赖的版本信息更加明显，便于管理。

在父模块 Root 中使用 dependencyManagement 元素声明的依赖，既不会给 Root 模块引入依赖，也不会给其子模块引入依赖，但这段配置是可以被继承的。

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

  1. <project xmlns="http://maven.apache.org/POM/4.0.0"
  2.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <artifactId>App-Core-lib</artifactId>
  6.     <parent>
  7.         <groupId>net.jhelp.www</groupId>
  8.         <artifactId>Root</artifactId>
  9.         <version>1.0</version>
  10.         <relativePath>../Root</relativePath>
  11.     </parent>
  12.     <dependencies>
  13.         <dependency>
  14.             <groupId>log4j</groupId>
  15.             <artifactId>log4j</artifactId>
  16.         </dependency>
  17.         <dependency>
  18.             <groupId>junit</groupId>
  19.             <artifactId>junit</artifactId>
  20.         </dependency>
  21.         <dependency>
  22.             <groupId>mysql</groupId>
  23.             <artifactId>mysql-connector-java</artifactId>
  24.         </dependency>
  25.         <dependency>
  26.             <groupId>c3p0</groupId>
  27.             <artifactId>c3p0</artifactId>
  28.         </dependency>
  29.     </dependencies>
  30.     <distributionManagement>
  31.         <repository>
  32.             <id>jhelp_Release_hosted</id>
  33.             <url>http://localhost:8082/nexus/content/repositories/jhelp_Release_hosted/</url>
  34.         </repository>
  35.         <snapshotRepository>
  36.             <id>Snapshot</id>
  37.             <url>http://localhost:8082/nexus/content/repositories/jhelp_Snapshot_hosted/</url>
  38.         </snapshotRepository>
  39.     </distributionManagement>
  40. </project>

3. 修改子模块 App-Data-lib 的 pom.xml 如下。

  1. <project xmlns="http://maven.apache.org/POM/4.0.0"
  2.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <artifactId>App-Data-lib</artifactId>
  6.     <parent>
  7.         <groupId>net.jhelp.www</groupId>
  8.         <artifactId>Root</artifactId>
  9.         <version>1.0</version>
  10.     </parent>
  11.    
  12.     <dependencies>
  13.         <dependency>
  14.             <groupId>junit</groupId>
  15.             <artifactId>junit</artifactId>
  16.         </dependency>
  17.     </dependencies>
  18. </project>

在子模块 App-Core-lib 和 App-Data-lib 的 POM 中，所有在 dependencies 元素中声明的依赖都只配置了 groupId 和 artifactId，省去了 version 和 scope。之所以能够省略这些信息，是因为它们继承了父模块 Root 中 dependencyManagement 的配置，其完整的依赖声明已经包含在父模块的 POM 中，子模块只需要配置 groupId 和 artifactId 就能获得相应的依赖信息，从而引入正确的依赖。

使用这种依赖管理机制似乎并不能减少太多 POM 配置，但我们仍然推荐使用这种方式，其原因主要有 2 个：

  • 在父模块中使用 dependencyManagement 声明依赖能够统一项目内依赖的版本，子模块无须声明版本，也就不会出现多个子模块使用同一依赖项版本不一致的情况，降低依赖冲突的几率。
  • dependencyManagement 声明的依赖不会被实际引入，子模块需要什么依赖就自己引入，增加了灵活性，避免引入一些不必要的依赖。

导入依赖管理

在 Maven 依赖传递 一节介绍依赖范围时，提到了一个名为 import 的依赖范围，之所以要放在这介绍是因为 import 依赖范围只能与 dependencyManagement 元素配合使用才会有效，其功能是将目标 pom.xml 中的 dependencyManagement 配置导入合并到当前 pom.xml 的 dependencyManagement 中。

例如，App-Data-lib 模块想要使用 Root 模块中的 dependencyManagement 配置，除了通过继承或者直接复制这两种方式之外，还可以使用 import 依赖范围将其导入，具体配置如下。

  1. <project xmlns="http://maven.apache.org/POM/4.0.0"
  2.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <!--由于不是继承，所以必须重新添加 groupId 和 version-->
  6.     <groupId>net.jhelp.www</groupId>
  7.     <artifactId>App-Data-lib</artifactId>
  8.     <version>1.0</version>
  9.     <!--定义依赖管理-->
  10.     <dependencyManagement>
  11.         <dependencies>
  12.             <!--导入依赖管理配置-->
  13.             <dependency>
  14.                 <groupId>net.jhelp.www</groupId>
  15.                 <artifactId>Root</artifactId>
  16.                 <version>1.0</version>
  17.                 <!--依赖范围为 import-->
  18.                 <scope>import</scope>
  19.                 <!--类型一般为pom-->
  20.                 <type>pom</type>
  21.             </dependency>
  22.         </dependencies>
  23.     </dependencyManagement>
  24.     <!--声明依赖-->
  25.     <dependencies>
  26.         <dependency>
  27.             <groupId>junit</groupId>
  28.             <artifactId>junit</artifactId>
  29.         </dependency>
  30.     </dependencies>
  31. </project>

以上配置中，由于 import 依赖范围的特殊性，一般都是指向打包类型为 pom 的模块，所以 type 元素的值一般为 pom。

若存在多个模块，它们使用的依赖版本都是一致的，则就可以定义一个使用 dependencyManagement 专门管理依赖的 POM，然后在各个模块中导入这些依赖管理配置。

腾讯云推出云产品限时特惠抢购活动：2C2G云服务器7.9元/月起
郑重声明：本文版权归原作者所有，转载文章仅为传播更多信息之目的，如作者信息标记有误，请第一时间联系我们修改或删除，多谢。
本文链接：https://www.jhelp.net/p/HoOE2VGFDfIggBjl (转载请保留)。
关注下面的标签，发现更多相似文章