Maven 聚合与继承

最新推荐文章于 2024-09-19 21:09:19 发布

归雀楼

最新推荐文章于 2024-09-19 21:09:19 发布

阅读量1.9k

点赞数

分类专栏： Maven 文章标签： Maven 聚合继承

Maven 专栏收录该内容

8 篇文章 0 订阅

订阅专栏

Maven 聚合与继承

1. 背景

在这个技术发展飞速的时代，各类用户对软件的要求越来越高，软件本身也变得越

来越复杂。因此，软件设计人员往往会采用各种方式对软件划分模块，以得到更清晰的

设计及更高的重用性。

Maven 的聚合特性能够把项目的各个模块聚合在一起构建，而 Maven 的继承特性

则能帮助抽取各模块相同的依赖和插件等配置，在简化 pom 配置的同时，还能促进各个

模块配置的一致性。

2. 聚合

到目前为止，我们都是一个项目一个项目的构建。一个简单的需求就出来了，我们

会想要一此构建两个项目，而不是到两个模块分别执行 mvn 命令，Maven 聚合（或者

称为多模块）这一特性就是为该需求服务的。

a) 创建聚合模块

需要创建一个新的模块，来聚合构建项目中其他所有模块。

<modelVersion>4.0.0</modelVersion>

<groupId>org.lichee</groupId>
<artifactId>lichee</artifactId>
<version>1.0.0</version>
<packaging>pom</packaging>

<name>lichee :: project</name>
<description>This is a project demo of lynch</description>
<inceptionYear>2013-2014</inceptionYear>

<modules>
  <module>parent</module>
  <module>core</module>
  <module>common</module>
  <module>support</module>
  <module>test</module>
  <module>simple-example</module>
</modules>

b) 聚合模块特征

i. Maven 项目

聚合模块本身也是一个 Maven 项目。

ii. 目录差异

准确说除了其他模块目录和 pom.xml，没有其他任何 src、test、target 等相关目录。

iii. pom.xml

1) 相同的 groupId、version

2) packaging 必须是 pom

继承父模块也一样必须是 pom。

3) name 提供一个相对容易阅读的名字

配置合理的 name 字段，会让 Maven 的构建输出更清晰。

4) modules

实现聚合的最核心配置，用户可以通过一个打包方式为 pom 的 Maven 项目中声明，

任意数量的 module 元素来实现模块的聚合。每个 module 的值都是一个当前 pom 的相对目录。

5) 模块所处的目录名称与其 artifactId 一致

文件的目录名称和 artifactId 相同，但不绝对，只是 module 里面的配置，

必须和文件目录上的名字一样。

6) 推荐目录格式

通常将聚合模块放在项目目录的最顶层，其他模块则作为聚合模块的子目录存在，

方便用户寻找聚合模块来构建整个项目。

c) 解析过程

Maven 会首先解析聚合模块的 pom、分析要构建的模块、并计算出一个反应堆构建顺序

（Reactor Build Order），然后根据这个顺序依次构建各个模块。

i. 项目构建小结报告

ii. 各个模块构建成功与否、花费时间

iii. 整个构建花费的时间、使用内存等

3. 继承

很多项目中，不同的子模块有着相同的 groupId、version，相同的 spring、junit等依赖，

相同的 maven-compiler-plugin 插件等配置。这就是重复，重复意味着更多的劳动和更多的潜在问题。

在 Maven 世界中，有机制能让我们抽取出重复的配置，这就是 pom 的继承。

a) 创建继承模块

我们需要创建 pom 的父子结构，在父 pom 中声明一些配置供子 pom 继承，一处声明，多处使用。

父模块：

<groupId>org.lichee</groupId>
<artifactId>lichee-parent</artifactId>
<version>1.0.0</version>
<packaging>pom</packaging>
<name>lichee :: parent</name>

子模块：

<parent>
<groupId>org.lichee</groupId>
<artifactId>lichee-parent</artifactId>
<version>1.0.0</version>
<relativePath>../parent/</relativePath>
</parent>
<artifactId>lichee-core</artifactId>
<packaging>jar</packaging>
<name>lichee :: core</name>

b) 继承模块特征

i. Maven 项目

继承模块本身也是一个 Maven 项目。

ii. 目录差异

准确说除了 pom.xml，没有其他任何 src、test、target 等相关目录。

iii. pom.xml

1) groupId、version

虽然子模块没有声明，不过不代表子模块没有这两个属性，隐式地从父模块继承了这两个元素，

这也就消除一些不必要的配置。如果子模块需要使用和父模块，

不一样的 groupId 或者 version 的情况，那么用户完全可以在子模块中显式声明。

对于 artifactId 元素来说，子模块应该显式声明。

2) packaging 必须是 pom

和聚合模块一样。

3) name 提供一个相对容易阅读的名字

配置合理的 name 字段，会让 Maven 的构建输出更清晰。

4) relativePath

表示父模块 pom 的相对路径，默认值为../pom.xml，也就是说，

Maven默认父 pom 在上一层目录下。如果子模块没有设置正确的 relativePath，

Maven 将无法找到父 pom，这将直接导致构建失败。

4. 可继承的 pom 元素

a) groupId

项目组 Id，项目坐标的核心元素。

b) version

项目版本，项目坐标的核心元素。

c) description

项目的描述信息。

d) organization

项目的组织信息。

e) inceptionYear

项目的创始年份。

f) url

项目的 url 地址。

g) developers

项目的开发者信息。

h) contributors

项目的贡献者信息。

i) distributionManagement

项目的部署配置。

j) issueManagement

项目的缺陷跟踪系统信息。

k) ciManagement

项目的持续集成系统信息。

l) scm

项目的版本控制系统信息。

m) mailingLists

项目的邮件信息列表。

n) properties

自定义的 Maven 属性。

o) dependencies

项目的依赖配置。

p) dependencyManagement

项目的依赖管理配置。

q) repositories

项目的仓库配置。

r) build

包括项目的源码目录配置、输出目录配置、插件配置、插件管理配置等。

s) reporting

包括项目的报告输出目录配置、报告插件配置等。

5. 依赖管理

通过 dependencies 元素，可以将父模块的依赖继承到子类中，但并不是每一个子模块

都需要相同的依赖。也不合理。

a) dependencyManagement

让子模块继承到父模块的依赖配置，又能保证子模块依赖使用的灵活性。

在这个元素下的依赖声明不会引入实际的依赖，不过它能够约束 dependencies 下的依赖使用。

父模块：

<properties>
  <junit.version>4.11</junit.version>
  <spring.version>3.2.5.RELEASE</spring.version>
  <jdk.version>1.6</jdk.version>
</properties>

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>${junit.version}</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context-support</artifactId>
      <version>${spring.version}</version>
    </dependency>
  </dependencies>
</dependencyManagement>

子模块：

<dependencies>
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
  </dependency>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
  </dependency>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context-support</artifactId>
  </dependency>
</dependencies>

i. 变量提取

spring 和 junit 依赖的版本以 maven 变量的形式提取出来，不仅消除了一些重复，

也使得个依赖的版本处于更加明显的位置。

ii. 引入时机

dependencyManagement 声明的依赖不会被任何一个子模块引入，

不过这段配置是会被子模块继承的。子模块的引入这些依赖就很简单了。

1) 只配置 groupId 和 artifactId

省去 version 和 scope，这些想信息可以被省略是因为子模块继承了，

父模块的 dependencyManagement，完整的依赖声明在父 pom 中，

子模块只需要配置简单的 groupId 和 artifactId 就能获得对应的依赖信息，

从而引入正确的依赖。

2) 选择性引入依赖

如果子模块的 pom 中不声明某个依赖的使用，即使该依赖已经在父 pom

的 dependencyManagement 中声明了，也不会产生任何实际的效果，

也就是说不会被引入到子模块的依赖中。

3) 最佳推荐

这种依赖管理机制似乎不能减少太多的 pom 配置，不过还是推荐采用这种方式。

因为在父 pom 中使用 dependencyManagement 声明依赖能够统一项目范围中的依赖版本，

子模块在使用过程中无需声明版本，也不会发生多个子模块使用的依赖版本不一致，

这可以降低依赖冲突的几率，对于后期升级或者修改依赖版本，也是提供了大大的便利。

4) import 依赖范围

这个范围的依赖只在 dependencyManagement 元素下才有效果，使用该范围的依赖通常

指向一个 pom，作用是将目标 pom 中的dependencyManagement 配置导入并合并到，

当前 pom 的dependencyManagement 元素中。import 范围依赖由于其特俗性，

一般都是指向打包类型为 pom 的模块。

6. 插件管理

Maven 提供了 dependencyManagement 元素帮助管理依赖，类似的，

Maven 也提供了 pluginManagement 元素帮助管理插件。

a) pluginManagement

该元素中配置的依赖插件不会造成实际插件的行为，当子模块 pom 中配置了真正的plugin 元素，

并且 groupId、artifactId 与 pluginManagement 中配置的插件匹配时，

pluginManagement 的配置才会影响实际的插件行为。

父模块：

<pluginManagement>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <version>3.1</version>
      <configuration>
        <source>1.6</source>
        <target>1.6</target>
        <showWarnings>true</showWarnings>
      </configuration>
    </plugin>
  </plugins>
</pluginManagement>

子模块：

<plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
    </plugin>
</plugins>