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

本文主要是介绍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>依赖；
2. 我们在自定义父工程项目时，如果直接以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我们需要做的处理

<?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>org.example</groupId>
    <artifactId>dong-manager</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>common</module>
        <module>web</module>
    </modules>

    <name>dong-manager</name>
    <description>dong-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>


</project>
到这里父工程创建完成。

2.1 创建子工程

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

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

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

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

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

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

2.2 创建Spring Boot子工程

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

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

common,core 都属于maven工程，web模块是web工程，因此：

新建web模块，以web为例, 此模块为web模块

1.web创建之后，需要修改web的pom.xml添加以下web引用内容

<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，得到如下结果，则表示创建成功完成。

1、在搭建SpringBoot框架时碰到的问题。

** WARNING ** : Your ApplicationContext is unlikely to start due to a @ComponentScan of the default package.

警告：你的应用上下文可能没有启动，因为你将注解添加到了默认的package上面了。下面的堆栈信息中也有一句话包括了这个意思。

......This can also happen if you are @ComponentScanning a springframework package (e.g. if you put a @ComponentScan in the default package by mistake)。

（启动的时候还有其他的错误，这里只摘录跟这个相关的错误。）

2、我的工程是这样的：

3、原因解析

我并没有使用@ComponentScanning注解，这里为什么会蹦出个这样的注解呢？

SpringBoot在编写启动类（Main方法所在的类）的时候如果不使用@ComponentScan指明对象扫描范围，默认指扫描当前启动类所在的包里的对象。

（注意：我在编写Main方法的时候并没有加@ComponentScan注解，因而，他会扫描Application所在的包里的对象）
如果当前启动类没有包，则在启动时会报错：Your ApplicationContext is unlikely to start due to a @ComponentScan of the default package错误。

一开始我的Application类放在Java目录下，是启动不了的，所以：

（注意：写在java文件夹下的Application类，是不从属于任何一个包的，因而启动类没有包）

4、解决办法

方法一、将Application建在其他的包下面

方法二、在Application类上面加@ComponentScan注解，指定要扫描的包

这篇关于Maven 多模块父子工程 (含Spring Boot示例)的文章就介绍到这儿，希望我们推荐的文章对大家有所帮助，也希望大家多多支持为之网！