Erlo

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

时间:2019-05-29   阅读:1841次   来源:博客园
页面报错
赞2

 一、为什么要用Maven多模块

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

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

这样整个项目的框架就清晰了.

 

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

  1. 这个应用可能需要有一个前台和一个后台管理端,你发现大部分dao,一些service,和大部分util是在两个应用中可。这样的问题,你一周内遇到了好几次。
  2. pom.xml中的依赖列表越来越长以重用的,但是,由于目前只有一个项目(WAR),你不得不新建一个项目依赖这个WAR,这变得非常的恶心,因为在Maven中配置对WAR的依赖远不如依赖JAR那样简单明了,而且你根本不需要org.xxx.app.web。有人修改了dao,提交到svn并且不小心导致build失败了,你在编写service的代码,发现编译不过,只能等那人把dao修复了,你才能继续进行,很多人都在修改,到后来你根本就不清楚哪个依赖是谁需要的,渐渐的,很多不必要的依赖被引入。甚至出现了一个依赖有多个版本存在。
  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)   

 

上述简单示意图中,有一个父项目(app-xxx)聚合很多子项目(app-util, app-dao, app-service, app-web)。每个项目,不管是父子,都含有一个pom.xml文件。而且要注意的是,小括号中标出了每个项目的打包类型。父项目是pom,也只能是pom。子项目有jar,或者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>

    <!--modules子模块-->
    <modules>
        <module>mtz-common</module>
    </modules>

    <!--定义属性值-->
    <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,得到如下结果,则表示创建成功完成。

 

评论留言

还没有评论留言,赶紧来抢楼吧~~

吐槽小黑屋()

* 这里是“吐槽小黑屋”,所有人可看,只保留当天信息。

  • Erlo吐槽

    Erlo.vip2020-10-26 03:35:16Hello、欢迎使用吐槽小黑屋,这就是个吐槽的地方。
  • 返回顶部