Maven 多模块父子工程 (含Spring Boot示例)

阅读目录

回到顶部

 一、为什么要用 Maven 多模块

假设有这样一个项目,很常见的 Java Web 应用。在这个应用中,我们分了几层:

  • Dao
  • Service
  • Web

对应的,在一个项目中,我们会看到一些包名:

  • org.xx.app.dao
  • org.xx.app.service
  • org.xx.app.web
  • org.xx.app.util

但随着项目的进行,你可能会遇到如下问题:

  1. 这个应用可能需要有一个前台和一个后台管理端,你发现大部分 dao,一些 service,和大部分 util 是在两个应用中可。
  2. pom.xml 中的依赖列表越来越长以重用的,但是,由于目前只有一个项目,你不得不新建一个项目依赖这个 WAR.
  3. build 整个项目的时间越来越长,尽管你只是一直在 web 层工作,但你不得不 build 整个项目。
  4. 某个模块,比如 util,你只想让一些经验丰富的人来维护,可是,现在这种情况,每个开发者都能修改,这导致关键模块的代码质量不能达到你的要求。

我们会发现,其实这里实际上没有遵守一个设计模式原则:“高内聚,低耦合”。虽然我们通过包名划分了层次,并且你还会说,这些包的依赖都是单向的,没有包的环依赖。这很好,但还不够,因为就构建层次来说,所有东西都被耦合在一起了。因此我们需要使用 Maven 划分模块。

 

一个简单的 Maven 模块结构是这样的:

 

---- app-xxx

             |-- pom.xml (pom)

             |

             |-- app-util

             |        |-- pom.xml (jar)

             |

             |-- app-dao

             |        |-- pom.xml (jar)

             |

             |-- app-service

             |        |-- pom.xml (jar)

             |

             |-- app-web

                      |-- pom.xml (war)   

 

回到顶部

 二、 Maven 创建多模块聚合项目

1.1 创建父工程

1. 以 IDEA 为示例 (Eclipse 大同小异) 选择 New--Project

 

 

2. 在弹出界面选择 Maven, 选择 JDK,-->next

 

 3. 输入 GroupId 和 ArtifactId , -->next

 

4. 输入完整项目名,和项目保存在本地的路径 ->finish

5. 完成之后我们得到一个新建的 maven 工程作为我们的父工程,然后删掉目录下的整个 src, 得到如下目录

 

1.2 Spring Boot 父工程

  1. Spring boot 在创建单应用项目的时候,有默认的 <parent> 依赖;我们在自定义父工程项目时,如果直接以 Spring boot 的 parent 作为项目的 <parent> 父依赖管理的话,子项目会由于存在两个 parent 而报错,无法导入依赖。
    解决方案如下:
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-dependencies</artifactId>
    <version>${spring.boot.version}</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

使用 spring-boot-dependencies 依赖对 springboot 的依赖包进行统一管理。

 

  1. 对于 Spring Boot 项目,maven 父工程项 pom.xml 我们需要做的处理
     <modelVersion>4.0.0</modelVersion>
    <!-- 基本信息 -->
    <groupId>com.tan</groupId>
    <artifactId>mtz-manager</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>

    <name>mtz-manager</name>
    <description>mtz-manager 管理系统</description>

    <!-- 定义属性值 -->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring.boot.version>2.1.1.RELEASE</spring.boot.version>
    </properties>

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

            <!-- SpringBoot 的依赖配置 -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring.boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

        </dependencies>
    </dependencyManagement>

    <!-- 编译管理 jdk 版本和字符集编码 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                    <encoding>${project.build.sourceEncoding}</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <!--Maven 远程仓库设置 非必要,可以删除 -->
    <repositories>
        <repository>
            <id>public</id>
            <name>aliyun nexus</name>
            <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
            <releases>
                <enabled>true</enabled>
            </releases>
        </repository>
    </repositories>

    <!--Maven 远程插件库设置 非必要,可以删除 -->
    <pluginRepositories>
        <pluginRepository>
            <id>public</id>
            <name>aliyun nexus</name>
            <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </pluginRepository>
    </pluginRepositories>


 

 

到这里父工程创建完成。

2.1 创建子工程

1. 创建子工程,我们先选中父工程目录,然后 New-->Model ,在弹出界面直接 -->Next

 

3. 下一步到这个页面我们填写子工程名称,然后 -->Next

 

 4. 根据情况修改以下属性值,然后点击 --->finish

5. 完成之后我们子工程就创建成功了,可以看到如下的目录结构

 

并且父工程的 pom 会自动生成 Modules 标签及内容,这样就创建了一个有聚合关系的工程了。

 

 完了之后,我们打开 Maven 视图,点击一下父工程 test 看看是否存在错误, 如看到以下打印,则表示子工程创建成功。

 

 

2.2 创建 Spring Boot 子工程

第一步:按照 2.1 创建完毕子工程。

第二部:我们以 2.1 创建的子工程后按照以下进行修改。

 

新建一个 mtz-admin 模块,以 mtz-admin 为例, 此模块为 web 模块

1.mtz-admin 创建之后,修改 mtz-admin 的 pom.xml 添加以下内容

     <dependencies>
        <!-- SpringBoot Web 容器 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

 

2。分别添加 application.yml 和 Application.java

 

 

3. 完了之后我们得到一个 Spring Boot 应用,启动Application,得到如下结果,则表示创建成功完成。