Idea创建SpringBoot多模块项目
前言
随着项目的复杂度增高,代码也逐渐开始臃肿,工具类的配置、脚手架代码和业务代码耦合,在多端的情况下,需要拆分出像PC后端,APP后端接口的服务,其中有很多相同的方法和逻辑。衍生出了以下几个问题:
不同业务间代码耦合,难以区分并定位问题上手难度增加,代码阅读成本高责任界定不明确不能很好地提取出某项功能
若把项目进行拆分,可以很好地解决以上问题,随之带来的就是项目复杂度的上升,今天就来理一理多模块。
什么是多模块
假设我们现在有一个商城的项目,随着业务的发展,开发了商品、库存、订单、购物车等等功能,在Controller
层中会越来越多,其中的Service
互相依赖,以一个强耦合的形式存在,以至于后期若需要提取商品相关的方法,耦合度太高无法提取。
我们可以定义一个维度,以此来划分模块,例如上述商城、可以划分成商品、库存和订单模块。也可以目录结构分层,Controller
层,只不过没人这样做。这样就引申出了下一个问题拆分策略
。
下图为谷粒商城项目:
拆分策略
按职责划分
project module-controllermodule-servicemodule-daomodule-mappermodule-entity按照功能拆分(常用)
project module-ordermodule-cartmodule-paymodule-product推荐使用按照功能去拆分,不管是后期维护定位问题或者是改造升级成微服务都是有帮助的。
依赖设计
在maven
中存在继承关系,子模块能够继承父pom
的一些配置,我们可以通过父类进行通用内容的配置。例如统一版本管理,若需要升级某个jar包,可以及时找到相应的版本进行修改,并且可以通过继承的关系,使使用到的地方同步升级版本。
若需要在某个包中单独使用其他版本的依赖时,只需要在需要更改的pom中添加上相应的版本号,maven会自动根据优先级使用自定义的版本依赖。
除此之外,合理利用依赖,可以是一些公共方法进行公用,例如实体类、redis/mybatis/mq等配置,在公共模块中进行配置,业务模块如有需要进行引入。
eg:
demo-project demo-common-dependeniesdemo-common-framworkdemo-common-moduledemo-server demo-project:总项目,把其他模块加入module中,这里不添加实际依赖demo-common-dependenies:整个项目的依赖和版本号,使用dependencyManagement包裹demo-common-framwork:项目的工具配置,例如redis、mybatis等demo-common-module:项目实体类demo-server:业务代码
在这种分层中,server可以是多个,来模拟多端。也可以设计成多个子模块,每个模块根据功能进行划分。
总而言之,目的都是提高复用率,避免重复性设置,公用一套配置,若有特殊需要可以通过配置进行灵活修改即可。
pom
1.demo-project
把其他的module加入pom中,定义依赖版本
<modules><module>sc-common-dependencies</module><module>sc-common-framework</module><module>sc-common-module</module><module>sc-server</module></modules><properties><revision>0.0.1-SNAPSHOT</revision></properties><dependencyManagement><dependencies><dependency><groupId>top.somliy</groupId><artifactId>common-dependencies</artifactId><version>${revision}</version><type>pom</type><scope>import</scope></dependency></dependencies></dependencyManagement>
2.demo-common-dependenies
整个项目的版本依赖
<properties><revision>0.0.1-SNAPSHOT</revision><!-- springboot --><spring.boot.version>2.6.10</spring.boot.version><!-- 工具类--><lombok.version>1.18.20</lombok.version><hutool.version>5.8.5</hutool.version></properties><!-- 父类定义版本号 --><dependencyManagement><dependencies><!-- Spring 核心 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId><version>${spring.boot.version}</version></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><version>${spring.boot.version}</version></dependency><!-- 工具类--><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>${lombok.version}</version></dependency><dependency><groupId>cn.hutool</groupId><artifactId>hutool-all</artifactId><version>${hutool.version}</version></dependency></dependencies></dependencyManagement>
3.demo-common-framwork
这里是对系统的一些配置和增强,只需引入一下依赖即可,不需要指定版本号
<parent><groupId>top.somliy.boot</groupId><artifactId>sc-boot</artifactId><version>${revision}</version></parent> <dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId></dependency></dependencies>
4.demo-common-module
系统一些实体,公共的内容存放
<parent><groupId>top.somliy.boot</groupId><artifactId>sc-boot</artifactId><version>${revision}</version></parent><dependencies><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></dependency></dependencies>
5.demo-server
业务系统
<parent><groupId>top.somliy.boot</groupId><artifactId>sc-boot</artifactId><version>${revision}</version></parent><dependencies><dependency><groupId>top.somliy.boot</groupId><artifactId>sc-common-module</artifactId><version>${revision}</version></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency></dependencies>
搭建多模块项目
环境:idea .1.3
首先创建一个Spring项目
环境:idea .1.3
1.新建一个项目
2.删除无用的文件
3.基于主项目创建子模块
创建的参数与创建SpringBoot一致即可