Maven聚合

当我们需要使用java做一个电商网站,涉及到:pc端网站、h5微站、移动端接口部分,可以使用Mavn中的聚合来实现。整个电商我们可以作为一个大的系统,上面的pc端、h5微站、api接口、后台系统、bi系统、监控系统都可以作为里面的一个具体比较大一个模块。

Maven聚合可以使用一个Maven项目来管理其他Maven构件模块。实现这个功能pom文件中需要加入如下配置:

<modules>

<module>模块1</module>

<module>模块2</module>

<module>模块n</module>

</modules>

<package>pom</package>

项目中执行任何 mvn 命令,都会 modules 中包含的所有模块执行同样的命令,而被包含的模块不需要做任何特殊的配置,正常的maven项目就行。注意上面的 module 元素,这部分是被聚合的模块 pom.xml 所在目录的相对路径。package的值必须为pom。

创建Maven项目,配置好Maven环境。

删除上面红色标记的无用文件。在pom文件加入如下配置:

<packaging>pom</packaging>

创建maven-pc端模块

鼠标右键选中项目,点击File-->New-->Module

点击Next,配置parent为none,输入名称maven-pc,如下图:

点击Finish,完成创建。如下图

查看原来的mavenTogether项目pom文件是否增加了内容,可能是IDEA版本问题,我的没有增加,添加如下内容:

<modules>

<module>maven-pc</module>

</modules>

同样的方法创建mavn-h5模块和maven-api模块,最终结构如下图:(maven-h5少了一个字符,不必介意,不影响结果)

在mavenTogether项目目录下执行mvn package感受一下效果,如下图:

可以看到在mavenTogether项目目录下执行mvn命令,各个模块下也都执行了相应的命令。

pom.xml中的 module 元素的值为被聚合的模块pom.xml所在的目录路径,可以是相对路径,也可以是绝对路径,有兴趣的朋友可以尝试一下。

Maven继承

大家可以看到上文几个项目的groupId、version 都是一样的,如果都进行web开发,每个pom文件都要添加相应的依赖构件。这样配置显然是比较麻烦的,可以通过maven继承更简单的进行配置,把公共的依赖构件提取出来,使模块pom也可以引用。

实现步骤

1、创建一个父maven项目,创建过程和Maven聚合创建主maven项目一样。

2、创建模块项目和maven聚合也类似,只有一个不一样的地方就是parent选择父项目。

创建完模块项目,pom文件自动增加了parent元素并且groupId、version 都没有了,这个 pom.xml 继承了 父项目pom.xml 中的内容,他们的 groupId、version 都是一样的,子构件可以从父pom.xml中继承这些内容,所以如果是一样的情况,可以不写。父项目pom文件增加了modules元素。

3、将依赖信息放在父项目pom.xml中,检查package元素内容是不是pom。

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-web</artifactId>

<version>5.2.1.RELEASE</version>

</dependency>

<dependency>

<groupId>org.mybatis</groupId>

<artifactId>mybatis-spring</artifactId>

<version>2.0.3</version>

</dependency>


分别在父项目目录和模块项目目录下运行mvn dependency:tree查看构件依赖情况,看看输出是否相同,如果相同说明模块项目继承了父项目构件。

relativePath元素

上面父构件和子构件的目录结构刚好符合父子关系,如果父构件和子构件的目录不是父子关系,位于同等级别的目录或者位于更复杂的目录的时候,此时我们需要在子 pom.xml 的 parent 元素中使用 relativePath 元素来指定父 pom.xml 相对路径位置,默认是 ../pom.xml ,表示父pom.xml位于子pom.xml的上一级目录,我们的模块刚好符合这种关系,所以这个值省略了。

正确的设置 relativePath 是非常重要的,子模块中执行 mvn 命令的时候,会去找父pom.xml 的配置,会先通过 relativePath 指定的路径去找,如果找不到,会尝试通过坐标在本地仓库进行查找,如果本地找不到,会去远程仓库找,如果远程仓库也没有,会报错。

可以继承的元素:

  • groupId:项目组ID,项目坐标的核心元素

  • version:项目版本,项目坐标的核心元素

  • description:项目的描述信息

  • organization:项目的组织信息

  • inceptionYear:项目的创始年份

  • url:项目的url地址

  • developers:项目的开发者信息

  • contributors:项目的贡献者信息

  • distributionManagement:项目的部署配置信息

  • issueManagement:项目的缺陷跟踪系统信息

  • ciManagement:项目的持续集成系统信息

  • scm:项目的版本控制系统信息

  • mailingLists:项目的邮件列表信息

  • properties:自定义的maven属性配置信息

  • dependencyManagement:项目的依赖管理配置

  • repositories:项目的仓库配置

  • build:包括项目的源码目录配置、输出目录配置、插件管理配置等信息

  • reporting:包括项目的报告输出目录配置、报告插件配置等信息

依赖管理(dependencyManagement)

如果我们在新增一个子构件,都会默认从父构件中继承依赖的一批构建,可能某个子项目只是想使用父pom.xml中一个构件,但是上面的继承关系却把所有的依赖都给传递到子构件中了,可以使用 dependencyManagement 元素来解决这个问题。

maven提供的dependencyManagement元素既能让子模块继承到父模块的依赖配置,又能保证子模块依赖使用的灵活性,在dependencyManagement元素下声明的依赖不会引入实际的依赖,他只是声明了这些依赖,不过它可以对 dependencies 中使用的依赖起到一些约束作用。

在父项项目pom中把依赖都放入dependencyManagement元素下。

<dependencyManagement>

<dependencies>

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-web</artifactId>

<version>5.2.1.RELEASE</version>

</dependency>

<dependency>

<groupId>org.mybatis</groupId>

<artifactId>mybatis-spring</artifactId>

<version>2.0.3</version>

</dependency>

</dependencies>

</dependencyManagement>

在父项目目录运行mvn dependency:tree命令,可以发现父子构件中都看不到依赖的jar包了,说明父pom.xml中dependencyManagement这些依赖的构建没有被子模块依赖进去。

子模块项目如果想使用依赖需要在pom中 dependencies元素 引用这些依赖。

<dependencies>

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-web</artifactId>

</dependency>

<dependency>

<groupId>org.mybatis</groupId>

<artifactId>mybatis-spring</artifactId>

</dependency>

</dependencies>

再次在父项目目录运行mvn dependency:tree命令,发现子模块可以看到依赖关系了。

dependencyManagement不会引入实际的依赖,只有在子类中使用 dependency 来引入父dependencyManagement 声明的依赖之后,依赖的构建才会被真正的引入。

使用dependencyManagement来解决继承的问题,子pom.xml中只用写 groupId,artifactId 就可以了,其他信息都会从父 dependencyManagement 中声明的依赖关系中传递过来,通常我们使用这种方式将所有依赖的构建在父pom.xml中定义好,子构件中只需要通过 groupId,artifactId 就可以引入依赖的构建,而不需要写 version ,可以很好的确保多个子项目中依赖构件的版本的一致性,对应依赖构件版本的升级也非常方便,只需要在父pom.xml中修改一下就可以了。

单继承问题

Maven是单继承的,如果我们想使用另外一个项目中声明的依赖,可以使用import导入另一个项目的依赖。

创建maven项目maven-demo,在pom文件中添加依赖。

在项目目录下运行mvn install 下载依赖到本地仓库。

在父项目pom中dependencyManagement元素下加入如下内容:

<dependency>

<groupId>com.example</groupId>

<artifactId>maven-demo</artifactId>

<version>1.0-SNAPSHOT</version>

<type>pom</type>

<scope>import</scope>

</dependency>

上面有两个关键元素:type的值必须是pom,scope元素的值必须是import。

在子模块项目pom文件dependencies元素中加入如下内容:

<dependency>

<groupId>com.alibaba</groupId>

<artifactId>fastjson</artifactId>

</dependency>

这时该子模块就可以使用引用的依赖了,如下图:

其实只要将两段内容加入pom文件中,都可以把依赖导入进来,正常使用依赖包。

插件管理(pluginManagement)

父pom中可以在pluginManagement元素中声明插件的配置信息,但是子pom.xml中不会引入此插件的配置信息,只有在子pom.xml中使用 plugins->plugin 元素正在引入这些声明的插件的时候,插件才会起效,子插件中只需要写 groupId、artifactId ,其他信息都可以从父构件中传递过来。

在父项目pom中加入如下内容:

<build>

<pluginManagement>

<plugins>

<plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-clean-plugin</artifactId>

<version>3.1.0</version>

</plugin>

</plugins>

</pluginManagement>

</build>

子模块pom中加入如下内容:

<build>

<plugins>

<plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-clean-plugin</artifactId>

</plugin>

</plugins>

</build>


可以在项目目录运行mvn clean命令进行验证一下。

聚合与继承的关系

聚合主要是为了方便多模块快速构建,而继承主要是为了重用相同的配置。对于聚合来说,聚合模块是知道被聚合模块的存在的,而被聚合模块是感知不到聚合模块的存在。对于继承来说,父构件是感知不到子构件的存在,而子构件需要使用 parent 来引用父构件。

两者的共同点是,聚合模块和继承中的父模块的package属性都必须是pom类型的,同时,聚合模块和父模块中的除了pom.xml,一般都是没有什么内容的。实际使用是,我们经常将聚合和继承一起使用,能同时使用到两者的优点。

举报/反馈

程序猿小董

3876获赞 670粉丝
软件工程师的日常生活
科技领域爱好者
关注
0
0
收藏
分享