【Maven】 的继承机制

cangloe2024-07-26 18:22

Maven是一个强大的项目管理工具，主要用于Java项目的构建和管理。它以其项目对象模型（POM）为基础，允许开发者定义项目的依赖、构建过程和插件。Maven的继承机制是其核心特性之一，它允许子项目继承和复用父项目的配置，从而提高了代码重用性和管理的简洁性。

在本篇文章中，我们将详细讲解Maven的继承机制，包括继承的基本概念、继承的实现方式以及一些常见的应用场景。

一、Maven继承的基本概念

1.1 POM文件

在Maven中，项目对象模型（POM，Project Object Model）是项目的核心配置文件，位于项目根目录的pom.xml文件中。POM文件定义了项目的基本信息、依赖、插件、构建配置等。

一个典型的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
         http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>
    
    <groupId>com.example</groupId>
    <artifactId>my-project</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>
        <!-- 依赖声明 -->
    </dependencies>

    <build>
        <plugins>
            <!-- 插件声明 -->
        </plugins>
    </build>

</project>

1.2 继承的作用

Maven继承机制允许子项目从父项目继承POM配置。这意味着子项目可以复用父项目的依赖、插件、构建配置等，避免了重复定义。

继承的主要作用有：

  • 配置复用：子项目可以继承父项目的依赖、插件、构建配置等，从而减少重复配置。
  • 集中管理：可以在父项目中集中管理公共依赖和配置，方便版本的统一升级和维护。
  • 模块化开发：支持多模块项目的管理，每个子项目可以有自己的特定配置。

1.3 Maven继承的局限性

  • 单一继承：Maven不支持多继承，每个子项目只能有一个直接的父项目。
  • 继承与聚合的混淆：有时候开发者会将继承与聚合混淆，需要明确它们的区别。

二、Maven继承的实现

Maven继承通过父子关系实现。子项目通过指定父项目的groupId、artifactId和version来建立继承关系。

2.1 创建父项目

首先，我们需要创建一个父项目，定义公共的POM配置。

父项目POM (parent-pom.xml)：

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
         http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>parent-project</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <properties>
        <!-- 公共属性 -->
        <java.version>17</java.version>
        <spring.version>5.3.12</spring.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <!-- 公共依赖 -->
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>${spring.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <!-- 公共插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.11.0</version>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

2.2 创建子项目

接下来，我们创建一个子项目，并让其继承父项目的POM配置。

子项目POM (child-pom.xml)：

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
         http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.example</groupId>
        <artifactId>parent-project</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>child-project</artifactId>

    <dependencies>
        <!-- 子项目特有的依赖 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>${spring.version}</version>
        </dependency>
    </dependencies>

</project>

2.3 执行Maven命令

在根目录下执行mvn clean install，Maven会自动处理父子关系，并构建整个项目。

2.4 查看继承效果

当子项目继承父项目后，子项目的构建将使用父项目中定义的依赖和插件配置：

  • 子项目会自动使用父项目中的spring-context依赖。
  • 子项目会自动使用父项目中的maven-compiler-plugin插件，Java版本为17。

子项目的有效POM

我们可以通过Maven命令查看子项目的有效POM（Effective POM），它展示了继承后的最终配置。

执行以下命令：

shell 复制代码 
mvn help:effective-pom

在终端输出中，可以看到子项目的完整POM配置，包括从父项目继承的部分。

三、Maven继承中的常用元素

3.1 dependencyManagement

  • 作用：用于在父项目中定义依赖的版本管理。
  • 特点：子项目继承时，不会自动引入依赖，而是只继承版本信息。

示例：

xml 复制代码 
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
    </dependencies>
</dependencyManagement>

子项目使用时只需引用依赖，而不需要显式指定版本：

xml 复制代码 
<dependencies>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <!-- 版本号已由父项目管理 -->
    </dependency>
</dependencies>

3.2 pluginManagement

  • 作用：用于在父项目中定义插件的版本管理。
  • 特点：子项目继承时，不会自动引入插件，而是只继承版本信息。

示例：

xml 复制代码 
<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.11.0</version>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                </configuration>
            </plugin>
        </plugins>
    </pluginManagement>
</build>

子项目需要手动引入插件：

xml 复制代码 
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
        </plugin>
    </plugins>
</build>

3.3 properties

  • 作用：用于在父项目中定义全局属性，子项目可以继承并使用这些属性。
  • 示例：
xml 复制代码 
<properties>
    <java.version>17</java.version>
    <spring.version>5.3.12</spring.version>
</properties>

子项目使用属性：

xml 复制代码 
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.11.0</version>
            <configuration>
                <source>${java.version}</source>
                <target>${java.version}</target>


            </configuration>
        </plugin>
    </plugins>
</build>

3.4 build与profiles

  • 作用：定义构建过程中的配置和多环境配置。
  • 示例：
xml 复制代码 
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.0.0-M5</version>
        </plugin>
    </plugins>
</build>

<profiles>
    <profile>
        <id>development</id>
        <properties>
            <env>dev</env>
        </properties>
    </profile>
    <profile>
        <id>production</id>
        <properties>
            <env>prod</env>
        </properties>
    </profile>
</profiles>

子项目可以通过命令行参数激活特定配置：

shell 复制代码 
mvn clean install -Pdevelopment

四、Maven继承与聚合的区别

Maven中的继承与聚合是两个不同的概念，容易混淆。

4.1 继承（Inheritance）

  • 特点 ：
    • 父子项目有继承关系。
    • 子项目继承父项目的POM配置。
  • 用途 ：
    • 适用于需要共享公共配置的项目。

4.2 聚合（Aggregation）

  • 特点 ：
    • 父项目是一个容器项目，没有实际业务逻辑。
    • 父项目通过modules元素管理多个子模块。
  • 用途 ：
    • 适用于多模块项目的管理。

4.3 继承与聚合同时使用

在实际项目中，继承和聚合可以同时使用，以实现更高效的项目管理。

示例：

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
         http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>multi-module-project</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <modules>
        <module>module-a</module>
        <module>module-b</module>
    </modules>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>5.3.12</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

</project>

模块A的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
         http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.example</groupId>
        <artifactId>multi-module-project</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>module-a</artifactId>

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

</project>

模块B的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
         http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.example</groupId>
        <artifactId>multi-module-project</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>module-b</artifactId>

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

</project>

五、Maven继承的高级应用

5.1 多层继承

Maven支持多层继承，即子项目可以继续充当父项目，提供更深层次的继承结构。

plaintext 复制代码 
parent-pom
  ├── intermediate-pom
  │     ├── child-a
  │     └── child-b
  └── child-c

中间层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
         http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.example</groupId>
        <artifactId>parent-project</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>intermediate-project</artifactId>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-lang3</artifactId>
                <version>3.12.0</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

</project>

子项目A的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
         http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.example</groupId>
        <artifactId>intermediate-project</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>child-a</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </dependency>
    </dependencies>

</project>

5.2 使用自定义的父POM

在某些情况下，我们可能需要自定义一个父POM，用于管理公司的多个项目。

  • 创建一个company-parent-pom，其中包含公司标准的依赖、插件和构建配置。
  • 每个项目都可以继承这个company-parent-pom，实现标准化的项目管理。

公司父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
         http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <groupId>com.company</groupId>
    <artifactId>company-parent-pom</artifactId>
    <version>1.0</version>
    <packaging>pom</packaging>

    <properties>
        <java.version>17</java.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.apache.logging.log4j</groupId>
                <artifactId>log4j-core</artifactId>
                <version>2.17.1</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.11.0</version>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

项目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
         http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4

.0.0</modelVersion>

    <parent>
        <groupId>com.company</groupId>
        <artifactId>company-parent-pom</artifactId>
        <version>1.0</version>
    </parent>

    <artifactId>my-company-project</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
        </dependency>
    </dependencies>

</project>

5.3 使用parent.relativePath实现跨项目继承

在多模块项目中，子项目默认会在相对路径上寻找父项目。但在某些情况下，我们希望子项目引用远程仓库中的父POM，而不是本地的父POM。这时可以使用parent.relativePath属性。

xml 复制代码 
<parent>
    <groupId>com.company</groupId>
    <artifactId>company-parent-pom</artifactId>
    <version>1.0</version>
    <relativePath/> <!-- 设置为空，强制从远程仓库获取 -->
</parent>

六、常见问题与解决方案

6.1 子项目不继承父项目的依赖版本

问题：子项目引用父项目的依赖时，需要手动指定版本号。

解决方案 ：确保依赖被定义在dependencyManagement中，而不是dependencies中。

6.2 多模块项目构建失败

问题：在多模块项目中，某个子模块构建失败导致整个项目构建失败。

解决方案 ：可以使用-pl参数单独构建某个模块：

shell 复制代码 
mvn clean install -pl module-a

6.3 父子项目之间版本不兼容

问题：子项目与父项目使用的依赖版本不一致，导致冲突。

解决方案：可以在子项目中覆盖父项目的依赖版本：

xml 复制代码 
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>5.3.15</version> <!-- 覆盖版本 -->
</dependency>

七、总结

Maven的继承机制是项目管理中的一个重要特性，它通过父子关系实现配置复用、集中管理和模块化开发。在实际应用中，我们可以结合继承和聚合机制，实现更高效的项目管理。

关键点回顾

  • Maven的POM文件是项目配置的核心。
  • 子项目通过parent元素继承父项目的配置。
  • dependencyManagement和pluginManagement用于管理依赖和插件的版本。
  • 继承与聚合是Maven中两个不同的概念，但可以结合使用。
  • 通过多层继承和自定义父POM实现更复杂的项目管理。
相关推荐
xlsw_2 小时前
java全栈day20--Web后端实战(Mybatis基础2)
java·开发语言·mybatis
神仙别闹3 小时前
基于java的改良版超级玛丽小游戏
java
黄油饼卷咖喱鸡就味增汤拌孜然羊肉炒饭3 小时前
SpringBoot如何实现缓存预热？
java·spring boot·spring·缓存·程序员
暮湫3 小时前
泛型（2）
java
超爱吃士力架3 小时前
邀请逻辑
java·linux·后端
南宫生4 小时前
力扣-图论-17【算法学习day.67】
java·学习·算法·leetcode·图论
转码的小石4 小时前
12/21java基础
java
李小白664 小时前
Spring MVC(上)
java·spring·mvc
GoodStudyAndDayDayUp4 小时前
IDEA能够从mapper跳转到xml的插件
xml·java·intellij-idea
装不满的克莱因瓶5 小时前
【Redis经典面试题六】Redis的持久化机制是怎样的？
java·数据库·redis·持久化·aof·rdb
热门推荐
01〔AI 绘画〕Stable Diffusion 之 解决绘制多人或面部很小的人物时面部崩坏问题 篇02ARM学习（31）编译器对overlay方式的支持03玄机平台应急响应—webshell查杀04DisplayPort AltMode On Type-c协议_Ver2.0(学习笔记)05校验 GPT-4 真实性的三个经典问题：快速区分 GPT-3.5 与 GPT-4，并提供免费测试网站06Docker 夺命连环 15 问076个主流的工业3D管道设计软件08基于大语言模型（LLM）的合成数据生成、策展和评估的综述09(欧拉)openEuler系统添加网卡文件配置流程、(欧拉)openEuler系统手动配置ipv6地址流程、(欧拉)openEuler系统网络管理说明10树莓派 5 AI 套件（Hailo-8L）使用教程