maven pom的继承功能的使用, 详解

介绍

继承这个功能我在maven的官方文档中并没有看到它的具体使用场景,只是简单的介绍了它的使用方法.
pom的继承和类的继承在概念上来讲其实是一样的,子pom可以继承父pom的信息,也就是将子pom的部分代码抽取,然后集中到父pom中.
所以继承可以消除重复代码,降低pom复杂度,降低理解和管理工程的难度. 我们可以将该功能用在工程的多模块管理上.

继承的使用方法(例子来自maven官方文档)

父pom

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
</project>

子pom

<project>
  <parent>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
    <relativePath>[父pom之于子pom的相对路径]</relativePath>
  </parent>
  <modelVersion>4.0.0</modelVersion>
  <artifactId>my-module</artifactId>
</project>

当父pom在子pom的上一级目录时,比如像下面这样,relativePath该标签可以省略

.
|-- my-module
| `-- pom.xml
`-- pom.xml

注:我在查询资料的时候,有个博客中说在继承中父pom需要将packaging标签修改为pom,我认为是不用的.
在官方文档中也没有说需要这样,只是在聚合功能,聚合+继承功能时需要修改packaging标签为pom. 不过我并没有对此进行验证, 大家可以自己验证一下.

子pom将会继承的信息

子pom将会继承父pom如下信息:
dependencies (依赖)
developers and contributors (开发人员和贡献值)
plugin lists (including reports) (插件列表包括报告)
plugin executions with matching ids (插件执行和匹配的ids)
plugin configuration (插件配置)
resources (资源)

详细的继承信息在这里就不写了, 我贴几条别人写的链接吧
Maven工程的POM继承
Maven POM元素继承
maven的聚合和继承详解

dependencyManagement 和 pluginManagement

通过继承功能我们可以将所有子模块中需要用到的依赖包,插件等都集中到父pom统一管理.
这样可以避免不同的子模块依赖不同版本的jar包,插件.如果需要进行版本升级也可以很方便的进行,不需要一个个去修改pom.
继承功能会继承父pom的所有依赖和插件,但有时候并不是每个子pom都需要,只是部分子pom需要,那我们将所有依赖和插件都扔到子pom中就不合适,
对于这种情况maven提供了dependencyManagement标签用于管理依赖,pluginManagement用于管理插件

dependencyManagement的使用方法

dependencyManagement标签中的依赖不会直接添加到子pom, 如果子pom需要使用该依赖, 就需要在子pom中进行声明,
这样做虽然没有消除多少重复代码, 但可以统一管理jar包的版本, 降低管理复杂度.

使用方法如下:
父pom

<project>

    ...

    <dependencyManagement>
        <dependencies>
            <dependency>
                ...
            </dependency>

            ...

        </dependencies>
    </dependencyManagement>
</project>

子pom直接在project下的dependencies标签中添加即可,不用指定版本

<project>

    ...

    <dependencies>

        ...

        <dependency>
            <groupId>[groupId]</groupId>
            <artifactId>[artifactId]</artifactId>
        </dependency>
           
    </dependencies>

</project>

pluginManagement的使用方法

pluginManagement用法和上面的差别不大
父pom

<build>

    ...

    <pluginManagement>
        <plugins>

            ...

            <plugin>
                ...
            </plugin>
        </plugins>
    </pluginManagement>
</build>

子pom

<build>

    ...

    <plugins>

        ...

        <plugin>
            <groupId>[groupId]</groupId>
            <artifactId>[artifactId]</artifactId>
        </plugin>
    </plugins>
</build>

参考资料

Maven POM元素继承
maven的聚合和继承详解

maven pom官方文档
maven pom中文文档

注解

该博客只是为了学习新知识和梳理知识,如有错漏,还请大家指正.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

友情链接更多精彩内容