Maven继承

Maven 在设计时,借鉴了 Java 面向对象中的继承思想,提出了 POM 继承思想。

当一个项目包含多个模块时,可以在该项目中再创建一个父模块,并在其 POM 中声明依赖,其他模块的 POM 可通过继承父模块的 POM 来获得对相关依赖的声明。对于父模块而言,其目的是为了消除子模块 POM 中的重复配置,其中不包含有任何实际代码,因此父模块 POM 的打包类型(packaging)必须是 pom。

如图 1 所示,一个项目中存在如下多个模块。

Maven 继承

 

图1:多模块项目各模块关系图

如上图所示:

  • App-UI-WAR 依赖于 App-Core-lib 和 App-Data-lib。
  • Root 是 App-Core-lib 和 App-Data-lib 的父模块。
  • Root 在它的依赖部分定义了 junit 4.9、mysql-connector-java 5.1.18 以及 c3p0 0.9.1 作为其依赖。


App-UI-WAR 的 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>App-UI-WAR</artifactId>
  7. <version>1.0</version>
  8. <dependencies>
  9. <!-- 依赖 App-Core-lib-->
  10. <dependency>
  11. <groupId>net.jhelp.www</groupId>
  12. <artifactId>App-Core-lib</artifactId>
  13. <version>1.0</version>
  14. </dependency>
  15. <!-- 依赖 App-Data-lib-->
  16. <dependency>
  17. <groupId>net.jhelp.www</groupId>
  18. <artifactId>App-Data-lib</artifactId>
  19. <version>1.0</version>
  20. </dependency>
  21. </dependencies>
  22. </project>

父模块 POM 配置

父模块 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 打包类型使pom -->
  9. <packaging>pom</packaging>
  10. <dependencies>
  11. <dependency>
  12. <groupId>junit</groupId>
  13. <artifactId>junit</artifactId>
  14. <version>4.9</version>
  15. <scope>test</scope>
  16. </dependency>
  17. <dependency>
  18. <groupId>mysql</groupId>
  19. <artifactId>mysql-connector-java</artifactId>
  20. <version>5.1.18</version>
  21. <scope>runtime</scope>
  22. </dependency>
  23. <dependency>
  24. <groupId>c3p0</groupId>
  25. <artifactId>c3p0</artifactId>
  26. <version>0.9.1</version>
  27. </dependency>
  28. </dependencies>
  29. </project>

在父模块 Root 的 pom.xml 中,其打包类型(packaging)为 pom,并声明了 3 个依赖:junit 4.9、mysql-connector-java 5.1.18 以及 c3p0 0.9.1 。

子模块 POM 配置

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. <groupId>net.jhelp.www</groupId>
  6. <artifactId>App-Core-lib</artifactId>
  7. <version>1.0</version>
  8. <parent>
  9. <groupId>net.jhelp.www</groupId>
  10. <artifactId>Root</artifactId>
  11. <version>1.0</version>
  12. <relativePath>../Root</relativePath>
  13. </parent>
  14. <dependencies>
  15. <dependency>
  16. <groupId>log4j</groupId>
  17. <artifactId>log4j</artifactId>
  18. <version>1.2.17</version>
  19. </dependency>
  20. </dependencies>
  21. </project>

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>net.jhelp.www</groupId>
  6. <artifactId>App-Data-lib</artifactId>
  7. <version>1.0</version>
  8. <parent>
  9. <groupId>net.jhelp.www</groupId>
  10. <artifactId>Root</artifactId>
  11. <version>1.0</version>
  12. <!-- <relativePath>../Root</relativePath> -->
  13. </parent>
  14. </project>

在子模块 App-Core-lib 和 App-Data-lib 的 pom.xml 中,使用 parent 元素声明父模块,其子元素如下表:

元素描述是否必需
groupId父模块的项目组 id。
artifactId父模块 id。
version父模块版本。
relativePath父模块 POM 的相对路径,默认值为 ../pom.xml。
项目构建时,Maven 会先根据 relativePath 查找父模块 POM,如果找不到,再从本地仓库或远程仓库中查找。

子模块的 POM 中,当前模块的 groupId 和 version 元素可以省略,但这并不意味着当前模块没有 groupId 和 version,子模块会隐式的从父模块中继承这两个元素,即由父模块控制子模块的公司组织 id 以及版本,这样可以简化 POM 的配置。

查看继承依赖项

在 App-Core-lib 和 App-Data-lib 两个子模块的 pom.xml 中,只有 App-Core-lib 声明了一个依赖: log4j 1.2.17。那么如何验证子模块是否继承了父模块 POM 中声明的依赖项呢?

下面我们需要用到一个插件:maven-dependency-plugin,它可以帮助我们分析项目依赖,其插件目标 dependency:list 能够列出项目最终解析到的依赖列表,dependency:tree 能够进一步的描绘项目依赖树。

1. 打开命令行窗口,跳转到子模块 App-Core-lib 的目录下,执行以下命令,查看该模块依赖列表。

  • mvn dependency:list

命令执行结果如下。

  • [INFO] Scanning for projects...
  • [INFO]
  • [INFO] -------------------< net.jhelp.www:App-Core-lib >-------------------
  • [INFO] Building App-Core-lib 1.0
  • [INFO] --------------------------------[ jar ]---------------------------------
  • [INFO]
  • [INFO] --- maven-dependency-plugin:2.8:list (default-cli) @ App-Core-lib ---
  • [INFO]
  • [INFO] The following files have been resolved:
  • [INFO] junit:junit:jar:4.9:compile
  • [INFO] log4j:log4j:jar:1.2.17:compile
  • [INFO] c3p0:c3p0:jar:0.9.1:compile
  • [INFO] mysql:mysql-connector-java:jar:5.1.18:runtime
  • [INFO] org.hamcrest:hamcrest-core:jar:1.1:compile
  • [INFO]
  • [INFO] ------------------------------------------------------------------------
  • [INFO] BUILD SUCCESS
  • [INFO] ------------------------------------------------------------------------
  • [INFO] Total time: 0.921 s
  • [INFO] Finished at: 2021-04-14T15:09:18+08:00
  • [INFO] ------------------------------------------------------------------------


可以看到,App-Core-lib 有 5 个依赖项,其中 junit 4.9、mysql-connector-java 5.1.18 以及 c3p0 0.9.1 是从父模块 Root 中继承的;log4j 1.2.17 是该模块本身的 POM 中声明的;hamcrest 1.1 是 junit 4.9 传递下来的依赖项。 
 

2. 在命令行窗口中,跳转到子模块 App-Data-lib 的目录下,执行以下命令,查看该模块依赖列表。

  • mvn dependency:list


命令执行结果如下。

  • [INFO] Scanning for projects...
  • [INFO]
  • [INFO] -------------------< net.jhelp.www:App-Data-lib >-------------------
  • [INFO] Building App-Data-lib 1.0
  • [INFO] --------------------------------[ jar ]---------------------------------
  • [INFO]
  • [INFO] --- maven-dependency-plugin:2.8:list (default-cli) @ App-Data-lib ---
  • [INFO]
  • [INFO] The following files have been resolved:
  • [INFO] junit:junit:jar:4.9:compile
  • [INFO] c3p0:c3p0:jar:0.9.1:compile
  • [INFO] mysql:mysql-connector-java:jar:5.1.18:runtime
  • [INFO] org.hamcrest:hamcrest-core:jar:1.1:compile
  • [INFO]
  • [INFO] ------------------------------------------------------------------------
  • [INFO] BUILD SUCCESS
  • [INFO] ------------------------------------------------------------------------
  • [INFO] Total time: 0.938 s
  • [INFO] Finished at: 2021-04-14T15:37:28+08:00
  • [INFO] ------------------------------------------------------------------------


可以看到,App-Data-lib 有 4 个依赖项,其中 junit 4.9、mysql-connector-java 5.1.18 以及 c3p0 0.9.1 是从父模块 Root 中继承的;hamcrest 1.1 是 junit 4.9 传递下来的依赖项。 

可继承的 POM 元素

在上面的例子中,我们可以看出 groupId、version 以及项目的依赖配置 dependencies 是可以被继承的,除了这 3 个元素之外,还有哪些元素可以被继承呢?

Maven 可通过继承获得 POM 元素,如下表。

元素描述
groupId项目组 ID,项目坐标的核心元素
version项目版本,项目坐标的核心元素
description项目的描述信息
organization项目的组织信息
inceptionYear项目的创始年份
url项目的URL地址
developers项目的开发者信息
contributors项目的贡献者信息
distributionManagement项目的部署配置
issueManagement项目的缺陷跟踪系统信息
ciManagement项目的持续集成系统信息
scm项目的版本控制系统信息
mailingLists项目的邮件列表信息
properties自定义的Maven属性
dependencies项目的依赖配置
dependencyManagement项目的依赖管理配置
repositories项目的仓库配置
build包括项目的源码目录配置、输出目录配置、插件配置、插件管理配置等
reporting包括项目的报告输出目录配置、报告插件配置等
腾讯云推出云产品限时特惠抢购活动:2C2G云服务器7.9元/月起
本文链接:https://www.jhelp.net/p/zWPVpzMq3aJHn22K (转载请保留)。
关注下面的标签,发现更多相似文章