如何构建多模块的SpringBoot项目

经过阅读本文你将了解到：如何将已有SpringBoot项目改为多模块 & 如何新构建多模块SpringBoot项目 如下示例基于我正在使用的order(订单服务)进行演示，不管你用的是什么项目，原理都是同样的，这里不要纠结使用的是什么服务。 

修改最外层pom文件

最外层pom文件是用来管理其余子模块的父级pom，重点将<packaging>节点修改成pom，修改前<packaging>多是jar或war

这里修改为pom是由于打包时，父pom是依赖于子pom进行打包的，父pom会经过<modules>节点将全部的子pom模块引入而且进行管理

<packaging>pom</packaging>

 

建立多模块

假设你已经设计好子模块的拆分原则，这里开始基于你本身的设计进行子模块的建立

例如：我将order项目拆分红三个不通的子模块，即common、client、server，每一个模块负责的事情是不一样的

第一步：右键项目名称，选择New->Module

第二步：在弹出的New Module窗口选择Maven

第三步：点击Next，并输入子模块的ArtifactId，如：common、client、server等，而后点击Next

第四步：检查并确认子模块名称及路径是否正确，若是正确则点击Finish

至此，common模块就建立成功了，你会发现order根目录下多了一个common子模块

转移代码

建立了common模块后，若是有须要移动至common子模块下的代码，则根据原来的代码目录结构，在common-src-main-java下建立相同的目录结构便可

例如：我项将ProductInfoOutput移动到common子模块下，原来ProductInfoOutput的保路经为com.imooc.order.common，那么我须要在common-src-main-java下建立com.imooc.order.common包，并将ProductInfoOutput拽进去

补充说明：我在建立com.imooc.order.common包时遇到了一个问题，就是右键java文件夹而后选New->Package并建立com.imooc.order.common时，建立出来的包路径时没有层次结构的，也就是说IDEA单纯的为我建立了一个名为com.imooc.order.common的文件夹

经研究发现，是视图的问题，将左上角的Project改为Project Files，而后按照上面的方式建立便可

 在转移test目录下的代码时，一样须要注意test目录下的包结构要与转移前的结构一致，这里以server模块为例，由于common下的test目录没有代码

 当咱们建立好多有的子模块后，观察最外层的父级pom文件内容，发现父级pom已经将咱们建立的子模块做为modules引入进来了

 

修改子模块pom文件

当咱们建立好多个子模块后，子模块间可能会存在依赖关系，例如个人server模块会依赖common模块下的ProductInfoOutput类

那么我须要在server模块的pom文件中将common模块引入

其余模块间的依赖引用同理

修改完子pom的依赖关系后，必定要刷新pom文件，否则依赖不会生效

配置打包插件

SpringBoot项目通常都会打成jar包部署，因此须要在pom中引入spring-boot-maven-plugin的maven插件

例如：我如今要打包order项目，此时个人SpringBoot运行主类在server模块下，那么我就须要以server模块为主要的打包对象

由于打包时，maven插件会去找SpringBoot的启动类，若是没有启动类会打包失败

那么，此时我就须要在server模块的pom中增长spring-boot-maven-plugin的相关配置

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

 

 注意：在最外层的父级pom中若是一样存在spring-boot-maven-plugin的配置，记得必定要删除掉

打包并运行服务

在maven窗口一次执行Lifecycle下的clean和install（若是你会maven命令，也能够用命令操做）

能够看到，这几个模块都是SUCCESS，说明构建成功了

那咱们要的能够运行的jar文件在server模块的target目录下，咱们找到它

最后放到服务器上运行这个jar包

使用命令：nohuo java -jar order-server-0.0.1-SNAPSHOT.jar > order.log 2>&1 &

能够看到，项目已经成功启动了，端口号为默认的8080

至此，构建多模块的SpringBoot项目就已经告一段落了