Maven的聚合和继承

在这个技术飞速发展的时代，各类用户对软件的要求越来越高，软件本身也变得越来越复杂。因此，软件设计人员往往会采用各种方式对软件划分模块，以得到更清晰的设计及更高的重用性。当把Maven应用到实际项目中的时候，也需要将项目分成不同的模块。
Maven的聚合特性能够把项目的各个模块聚合在一起构建，而Maven的继承特性则能帮助抽取各模块相同的依赖和插件等配置，在简化POM的同时，还能促进各个模块配置的一致性。

1、聚合

1.1 项目准备

首先，在IDEA中，新建一个MavenMultiTest工程，位于目录/Users/chengxia/Developer/Java/MavenMultiTest/，然后将工程自带的同名module删除。然后，分别新建如下两个Module

1.1.1 module1

新建如下module1，位于目录/Users/chengxia/Developer/Java/MavenMultiTest/module1，结构如下图：

Module1

module1/pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
<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.lfqy.maventest</groupId>
    <artifactId>module1</artifactId>
    <version>1.0-SNAPSHOT</version>


</project>

com.lfqy.maventest.module1.HelloWorld1：

package com.lfqy.maventest.module1;

/**
 * Created by chengxia on 2019/9/18.
 */
public class HelloWorld1 {
    public static void main(String []args){
        System.out.println("Hello World!");
        for(String arg : args){
            System.out.println("Hello, " + arg + "!");
        }
        System.out.println("Hello World!");
    }
}

这样创建完成之后，通过命令行，切换到目录/Users/chengxia/Developer/Java/MavenMultiTest/module1，执行编译命令：

$ mvn compile
[INFO] Scanning for projects...
[INFO] 
[INFO] ---------------------< com.lfqy.maventest:module1 >---------------------
[INFO] Building module1 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ module1 ---
[WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] Copying 0 resource
[INFO] 
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ module1 ---
[INFO] Nothing to compile - all classes are up to date
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.062 s
[INFO] Finished at: 2019-09-18T08:04:07+08:00
[INFO] ------------------------------------------------------------------------
$

接下来也可以通过maven运行其中的带main函数的类。
如果不像main函数传入参数，可以执行：

$ mvn exec:java -Dexec.mainClass="com.lfqy.maventest.module1.HelloWorld1"
[INFO] Scanning for projects...
[INFO] 
[INFO] ---------------------< com.lfqy.maventest:module1 >---------------------
[INFO] Building module1 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- exec-maven-plugin:1.6.0:java (default-cli) @ module1 ---
Hello World!
Hello World!
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.007 s
[INFO] Finished at: 2019-09-18T08:06:14+08:00
[INFO] ------------------------------------------------------------------------
$

向main函数传入两个参数，执行：

$ mvn exec:java -Dexec.mainClass="com.lfqy.maventest.module1.HelloWorld1" -Dexec.args="Qiuqiu Paopao"
[INFO] Scanning for projects...
[INFO] 
[INFO] ---------------------< com.lfqy.maventest:module1 >---------------------
[INFO] Building module1 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- exec-maven-plugin:1.6.0:java (default-cli) @ module1 ---
Hello World!
Hello, Qiuqiu!
Hello, Paopao!
Hello World!
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  0.911 s
[INFO] Finished at: 2019-09-18T08:07:33+08:00
[INFO] ------------------------------------------------------------------------
$

1.1.2 module2

新建如下module2，位于目录/Users/chengxia/Developer/Java/MavenMultiTest/module2，结构如下图：

Module2

module2/pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
<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.lfqy.maventest</groupId>
    <artifactId>module2</artifactId>
    <version>1.0-SNAPSHOT</version>


</project>

com.lfqy.maventest.module2.HelloWorld2：

package com.lfqy.maventest.module2;

/**
 * Created by chengxia on 2019/9/18.
 */
public class HelloWorld2 {
    public static void main(String []args){
        System.out.println("Hello Universe!");
        for(String arg : args){
            System.out.println("Hello, " + arg + "!");
        }
        System.out.println("Hello Universe!");
    }
}

编译之后执行如下：

$ mvn exec:java -Dexec.mainClass="com.lfqy.maventest.module2.HelloWorld2" -Dexec.args="Qiuqiu Paopao"
[INFO] Scanning for projects...
[INFO] 
[INFO] ---------------------< com.lfqy.maventest:module2 >---------------------
[INFO] Building module2 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- exec-maven-plugin:1.6.0:java (default-cli) @ module2 ---
Hello Universe!
Hello, Qiuqiu!
Hello, Paopao!
Hello Universe!
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  0.896 s
[INFO] Finished at: 2019-09-18T08:36:48+08:00
[INFO] ------------------------------------------------------------------------
$

1.2 聚合配置

接下来，我们新建一个聚合项目module-aggregator，这个module的目录位于/Users/chengxia/Developer/Java/MavenMultiTest/。
一般来说，module所在的目录应该和artifactid一致，不过这不是maven的强制要求。
目录结构如下：

Aggregation

由于这是一个专为聚合而存在的项目，所以，其中没有任何代码，只需要关注其pom配置。
pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
<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.lfqy.maventest</groupId>
    <artifactId>module-aggregator</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>Module Aggregator</name><!-- 一个更易辨识的别名 -->
    <packaging>pom</packaging><!-- packaging默认值是jar，对于聚合项目，其值必须为POM。否则无法构建-->
    <modules>
        <module>module1</module>
        <module>module2</module>
    </modules>

</project>

这里需要注意modules标签下的module配置，其中的内容是目录名，不是子模块的artifactid。因此，如果子模块不在聚合模块的根目录下，而是和聚合模块是平行目录，这里需要配置成../module1和../module2。
最后，在目录/Users/chengxia/Developer/Java/MavenMultiTest/下执行构件命令，可以实现这两个项目的共同构建：

$ mvn compile
[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO] 
[INFO] module1                                                            [jar]
[INFO] module2                                                            [jar]
[INFO] Module Aggregator                                                  [pom]
[INFO] 
[INFO] ---------------------< com.lfqy.maventest:module1 >---------------------
[INFO] Building module1 1.0-SNAPSHOT                                      [1/3]
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ module1 ---
[WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] Copying 0 resource
[INFO] 
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ module1 ---
[INFO] Changes detected - recompiling the module!
[WARNING] File encoding has not been set, using platform encoding UTF-8, i.e. build is platform dependent!
[INFO] Compiling 1 source file to /Users/chengxia/Developer/Java/MavenMultiTest/module1/target/classes
[INFO] 
[INFO] ---------------------< com.lfqy.maventest:module2 >---------------------
[INFO] Building module2 1.0-SNAPSHOT                                      [2/3]
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ module2 ---
[WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] Copying 0 resource
[INFO] 
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ module2 ---
[INFO] Changes detected - recompiling the module!
[WARNING] File encoding has not been set, using platform encoding UTF-8, i.e. build is platform dependent!
[INFO] Compiling 1 source file to /Users/chengxia/Developer/Java/MavenMultiTest/module2/target/classes
[INFO] 
[INFO] ----------------< com.lfqy.maventest:module-aggregator >----------------
[INFO] Building Module Aggregator 1.0-SNAPSHOT                            [3/3]
[INFO] --------------------------------[ pom ]---------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for Module Aggregator 1.0-SNAPSHOT:
[INFO] 
[INFO] module1 ............................................ SUCCESS [  1.707 s]
[INFO] module2 ............................................ SUCCESS [  0.078 s]
[INFO] Module Aggregator .................................. SUCCESS [  0.002 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.930 s
[INFO] Finished at: 2019-09-18T08:59:54+08:00
[INFO] ------------------------------------------------------------------------
$

PS：至于如何看构建、清理等mvn操作是否成功，除了看控制台的输出之外，可以在IDEA中看target目录：构建成功之后，target目录生成，清理成功之后target目录消失。

由于前面建立的聚合项目，纯粹是为了聚合两个项目，实现它们的共同构建。所以，可以将这个项目中的src等代码相关的目录删除，不会影响构建。删除之后的目录结构如下：

Aggregation without src

2、继承

在前面例子的基础上，创建一个新模块module-parent作为module1和module2模块的父模块，这样，通过继承，可以将module1和module2中的一些配置抽象到父模块中，避免重复配置，方便管理。项目结构如下：

Inheritance

module-parent/pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
<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.lfqy.maventest</groupId>
    <artifactId>module-parent</artifactId>
    <version>1.0-SNAPSHOT</version>
    <!-- 作为父模块，打包方式也必须是pom -->
    <packaging>pom</packaging>
    <name>Module Parent</name>


</project>

注意，父模块的打包方式也必须是pom。
修改module1的pom文件，让它继承父模块的配置。
module1/pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
<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.lfqy.maventest</groupId>
        <artifactId>module-parent</artifactId>
        <version>1.0-SNAPSHOT</version>
        <!-- 配置父模块pom文件的位置，默认是../pom.xml -->
        <relativePath>../module-parent/pom.xml</relativePath>
    </parent>

    <artifactId>module1</artifactId>
    <!-- 注释掉如下的groupid和version定义，让其从父模块继承 -->
    <!--<groupId>com.lfqy.maventest</groupId>-->
    <!--<version>1.0-SNAPSHOT</version>-->
    <name>Module 1</name>


</project>

对于module2，也做类似的修改。
module2/pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
<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.lfqy.maventest</groupId>
        <artifactId>module-parent</artifactId>
        <version>1.0-SNAPSHOT</version>
        <!-- 配置父模块pom文件的位置，默认是../pom.xml -->
        <relativePath>../module-parent/pom.xml</relativePath>
    </parent>

    <artifactId>module2</artifactId>
    <!-- 注释掉如下的groupid和version定义，让其从父模块继承 -->
    <!--<groupId>com.lfqy.maventest</groupId>-->
    <!--<version>1.0-SNAPSHOT</version>-->
    <name>Module 2</name>

</project>

执行这一步，就基本完成了。可以将两个子模块单独构件，也可以通过前面创建的聚合项目一起构建。
我们也可以将这个父项目也添加到前面的聚合项目中，这样父项目也可以一起构件。修改聚合项目的pom配置文件如下。
pom.xml(目录/Users/chengxia/Developer/Java/MavenMultiTest/pom.xml)：

<?xml version="1.0" encoding="UTF-8"?>
<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.lfqy.maventest</groupId>
    <artifactId>module-aggregator</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>Module Aggregator</name><!-- 一个更易辨识的别名 -->
    <packaging>pom</packaging><!-- packaging默认值是jar，对于聚合项目，其值必须为POM。否则无法构建-->
    <modules>
        <module>module1</module>
        <module>module2</module>
        <module>module-parent</module>
    </modules>

</project>

这样，在聚合项目的根目录执行构件，输出如下。

$ mvn compile
[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO] 
[INFO] Module Parent                                                      [pom]
[INFO] Module 1                                                           [jar]
[INFO] Module 2                                                           [jar]
[INFO] Module Aggregator                                                  [pom]
[INFO] 
[INFO] ------------------< com.lfqy.maventest:module-parent >------------------
[INFO] Building Module Parent 1.0-SNAPSHOT                                [1/4]
[INFO] --------------------------------[ pom ]---------------------------------
[INFO] 
[INFO] ---------------------< com.lfqy.maventest:module1 >---------------------
[INFO] Building Module 1 1.0-SNAPSHOT                                     [2/4]
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ module1 ---
[WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] Copying 0 resource
[INFO] 
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ module1 ---
[INFO] Changes detected - recompiling the module!
[WARNING] File encoding has not been set, using platform encoding UTF-8, i.e. build is platform dependent!
[INFO] Compiling 1 source file to /Users/chengxia/Developer/Java/MavenMultiTest/module1/target/classes
[INFO] 
[INFO] ---------------------< com.lfqy.maventest:module2 >---------------------
[INFO] Building Module 2 1.0-SNAPSHOT                                     [3/4]
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ module2 ---
[WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] Copying 0 resource
[INFO] 
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ module2 ---
[INFO] Changes detected - recompiling the module!
[WARNING] File encoding has not been set, using platform encoding UTF-8, i.e. build is platform dependent!
[INFO] Compiling 1 source file to /Users/chengxia/Developer/Java/MavenMultiTest/module2/target/classes
[INFO] 
[INFO] ----------------< com.lfqy.maventest:module-aggregator >----------------
[INFO] Building Module Aggregator 1.0-SNAPSHOT                            [4/4]
[INFO] --------------------------------[ pom ]---------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for Module Aggregator 1.0-SNAPSHOT:
[INFO] 
[INFO] Module Parent ...................................... SUCCESS [  0.008 s]
[INFO] Module 1 ........................................... SUCCESS [  1.404 s]
[INFO] Module 2 ........................................... SUCCESS [  0.077 s]
[INFO] Module Aggregator .................................. SUCCESS [  0.001 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.680 s
[INFO] Finished at: 2019-09-19T08:37:49+08:00
[INFO] ------------------------------------------------------------------------
$

但是，由于这里父项目中实际上没有需要构件的代码，所以这一步只是演示，意义不大。

3、反应堆和构建顺序

在一个多模块的Maven项目中，反应堆(Reactor)是指所有模块组成的一个构建结构。对于单模块的项目，反应堆就是该模块本身，但对于多模块项目来说，反应堆就包含了各模块之间继承与依赖的关系，从而能够自动计算出合理的模块构建顺序。
构建顺序是这样形成的：Maven按序读取POM，如果该POM没有依赖模块，那么就构建该模块，否则就先构建其依赖模块，如果该依赖还依赖于其他模块，则进一步先构建依赖的依赖。该例中，module1它依赖于module-parent模块，必须先构建module-parent，然后再构建module1，然后到module2的时候，由于其依赖模块已经被构建，因此直接构建它。
模块间的依赖关系会将反应堆构成一个有向非循环图(Directed Acyclic Graph, DAG)，各个模块是该图的节点，依赖关系构成了有向边。这个图不允许出现循环，因此，当出现模块A依赖于B，而B又依赖于A的情况时，Maven就会报错。

参考资料

《Maven实战》徐晓斌
使用Maven运行Java main的3种方式

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 216,324评论 6赞 498
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 92,356评论 3赞 392
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 162,328评论 0赞 353
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 58,147评论 1赞 292
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 67,160评论 6赞 388
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 51,115评论 1赞 296
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 40,025评论 3赞 417
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 38,867评论 0赞 274
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 45,307评论 1赞 310
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 37,528评论 2赞 332
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 39,688评论 1赞 348
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 35,409评论 5赞 343
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 41,001评论 3赞 325
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 31,657评论 0赞 22
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,811评论 1赞 268
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 47,685评论 2赞 368
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 44,573评论 2赞 353