欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

如何构建多模块的SpringBoot项目

程序员文章站 2022-04-09 07:50:52
通过阅读本文你将了解到:如何将已有SpringBoot项目改成多模块 & 如何新构建多模块SpringBoot项目 以下示例基于我正在使用的order(订单服务)进行演示,无论你用的是什么项目,原理都是一样的,这里不要纠结使用的是什么服务。 修改最外层pom文件 最外层pom文件是用来管理其他子模块 ......
  通过阅读本文你将了解到:如何将已有springboot项目改成多模块 & 如何新构建多模块springboot项目 以下示例基于我正在使用的order(订单服务)进行演示,无论你用的是什么项目,原理都是一样的,这里不要纠结使用的是什么服务。 

修改最外层pom文件

最外层pom文件是用来管理其他子模块的父级pom,重点将<packaging>节点修改为pom,修改前<packaging>可能是jar或war

这里修改成pom是因为打包时,父pom是依赖于子pom进行打包的,父pom会通过<modules>节点将所有的子pom模块引入并且进行管理

如何构建多模块的SpringBoot项目

<packaging>pom</packaging>

 

创建多模块

假设你已经设计好子模块的拆分原则,这里开始基于你自己的设计进行子模块的创建

例如:我将order项目拆分成三个不通的子模块,即common、client、server,每个模块负责的事情是不同的

第一步:右键项目名称,选择new->module

如何构建多模块的SpringBoot项目

第二步:在弹出的new module窗口选择maven

如何构建多模块的SpringBoot项目

第三步:点击next,并输入子模块的artifactid,如:common、client、server等,然后点击next

如何构建多模块的SpringBoot项目

第四步:检查并确认子模块名称及路径是否正确,如果正确则点击finish

如何构建多模块的SpringBoot项目

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

如何构建多模块的SpringBoot项目

转移代码

创建了common模块后,如果有需要移动至common子模块下的代码,则根据原来的代码目录结构,在common-src-main-java下创建相同的目录结构即可

例如:我项将productinfooutput移动到common子模块下,原来productinfooutput的保路经为com.imooc.order.common,那么我需要在common-src-main-java下创建com.imooc.order.common包,并将productinfooutput拽进去

如何构建多模块的SpringBoot项目

补充说明:我在创建com.imooc.order.common包时遇到了一个问题,就是右键java文件夹然后选new->package并创建com.imooc.order.common时,创建出来的包路径时没有层次结构的,也就是说idea单纯的为我创建了一个名为com.imooc.order.common的文件夹

经研究发现,是视图的问题,将左上角的project改成project files,然后按照上面的方式创建即可

如何构建多模块的SpringBoot项目

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

如何构建多模块的SpringBoot项目

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

如何构建多模块的SpringBoot项目

 

修改子模块pom文件

当我们创建好多个子模块后,子模块间可能会存在依赖关系,例如我的server模块会依赖common模块下的productinfooutput类

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

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

如何构建多模块的SpringBoot项目

修改完子pom的依赖关系后,一定要刷新pom文件,不然依赖不会生效

配置打包插件

springboot项目一般都会打成jar包部署,所以需要在pom中引入spring-boot-maven-plugin的maven插件

例如:我现在要打包order项目,此时我的springboot运行主类在server模块下,那么我就需要以server模块为主要的打包对象

因为打包时,maven插件会去找springboot的启动类,如果没有启动类会打包失败

如何构建多模块的SpringBoot项目

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

如何构建多模块的SpringBoot项目

    <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命令,也可以用命令操作)

如何构建多模块的SpringBoot项目

可以看到,这几个模块都是success,说明构建成功了

那我们要的可以运行的jar文件在server模块的target目录下,我们找到它

如何构建多模块的SpringBoot项目

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

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

如何构建多模块的SpringBoot项目

可以看到,项目已经成功启动了,端口号为默认的8080

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