IDEA2022搭建Spring Cloud多模块项目

Springboot多模块项目搭建

创建maven父工程

注意：创建父模块选用Spring Initializr的方式创建，让父模块继承springboot的maven配置，之后的所有子模块都通过maven的方式创建，子模块继承父模块就会间接继承springboot相关的配置，web,api模块再另外添加spring-boot-starter-web,spring-boot-starter-tomcat相关的依赖。网上有很多教程父模块都是通过maven的方式创建的，然后子模块是通过Spring Initalizr方式创建，这种方式父模块无法管理子模块的依赖仲裁，需要每个子模块自行管理，就失去了父模块的用处了。

1. idea -> file -> new -> project，选择Spring Initializr，填写相关的Group,Artifact,Package name 等信息，点击Next；
   JDK版本可以根据需要选择高一些的版本，我是由于需要兼容线上的老版本系统，所以沿用JDK1.8的版本
   

2. 根据需要选取初始化需要加载的依赖，我添加了Cloud Bootstrap，可以自动生成Spring Cloud依赖管理包，直接点解Create
   

3. 删除生成后的src目录，pom.xml中添加pom属性
   
   刚才创建时选择的Cloud Bootstrap 会在pom文件中自动生成spring-cloud 相关的依赖配置，spring-cloud-dependencies 是一个依赖管理器的pom文件，是对spring cloud版本的依赖管理
   

创建子模块

使用maven方式创建api,biz,core,dao,integration,common,model 相关模块，创建内部依赖模块是使用maven的方式创建，便于总模块管理子模块的依赖仲裁；

点击项目根目录，右键 new -> module，选用maven的方式新建模块，Archetype可以选择quickstart，分别添加api,biz,core,dao,integration,common,model 这些模块。直接点击Create

创建web模块

web模块可以采用Spring Initializr的方式创建，可以自动初始化web相关的pom包和springboot的启动类，之后再修改web模块的pom文件的标签为当前父工程的配置即可；

1. 点击项目根目录，右键 new -> module，选用Spring Initializr的方式新建web模块，点击Next
   

2. 根据自己的需要勾选所需的依赖，我选择了Spring Boot DevTools 和 Spring Web，点击Create
   

3. 修改web模块的pom文件的，将spring-boot-starter-parent 替换为父工程的pom配置
   

4. 在父工程的pom文件中新增web模块的module依赖
   

创建完之后的工程目录结构如图：

添加模块依赖关系

创建完所有模块之后，自行在各个模块的pom 文件中添加模块依赖配置，推荐模块依赖关系如下图：

模块职责&关系说明

• web模块：
  HTTP，HTTPS请求入口层，只负责对访问控制进行转发、参数转换，不编写复杂的业务逻辑，返回的结果数据用XxxVO模型封装，最终返回给前端的数据用BizResult封装；
• biz模块：
  负责业务逻辑处理，biz层通常提供业务具体处理流程相关的服务；
• core模块：
  负责对dao层返回的DO或integration层返回的外部系统模型进行转换、解析、业务逻辑处理。core层通常提供的是通用的服务；
• api模块：
  负责对其它微服务系统提供接口，不允许抛异常，返回的结果统一使用BizResult封装；
• dao模块：
  只负责MySQL数据库的对接操作，返回XxxDO对象；
• integration模块：
  负责外部系统的对接，如其他内部微服务应用、微信接入、支付宝接入等，直接返回外部系统的领域模型，上层自行绝对是否需要再做进一步封装；
• common模块：
  存放项目里面所有模块公用的组件，有些组件如果只是某个模块里面自己使用不要放在common下面，可以在本模块下建立utils包，例如：ResponseUtil之类只有web层才会使用到的工具类；
• model模块：
  存放项目的数据模型，如常量、枚举、业务数据模型等；

编码规范

包名命名规范

web
 |- com.xxx.web.interceptor
 |- com.xxx.web.controller
 |- com.xxx.web.websocket
 |- com.xxx.web.vo
biz
 |- com.xxx.biz.manager
 |- com.xxx.biz.processor
 |- com.xxx.biz.job
core
 |- com.xxx.core.service
 |- com.xxx.core.service.impl
 |- com.xxx.core.handler
model
 |- com.xxx.model.biz
 |- com.xxx.model.core
 |- com.xxx.model.common
 |- com.xxx.model.integration
 |- com.xxx.model.dto
 |- com.xxx.model.vo
 |- com.xxx.model.exception
 |- com.xxx.model.constants
 |- com.xxx.model.enums
dao
 |- com.xxx.dao.dao
 |- com.xxx.dao.dataobject
 |- com.xxx.dao.mapper
integration
 |- com.xxx.integration.client
 |- com.xxx.integration.client.impl
common
 |- com.xxx.common.utils

方法命名

1. 获取单个对象的方法，web/service层用get做前缀，dao层用select做前缀；
2. 获取多个对象的方法，web/service层用list做前缀，dao层用select做前缀；
3. 获取统计数据的方法都用count做前缀；
4. 插入的方法web/service层用save/add/create做前缀，dao层用insert做前缀；
5. 删除的方法web/service层用remove做前缀，dao层用delete做前缀；
6. 修改的方法都用update做前缀；

领域模型命名

1. 数据对象：XxxDO，xxx为数据库表名，每张表都要创建一个DO模型；
2. 领域模型：Xxx，Xxx即为该领域模型的名称。所有领域模型对象之间的互相转换都禁止使用org.springframework.beans.BeanUtils，必须挨个属性进行设置，防止领域模型数据结构发生变更无法互相感知。
   表示状态信息的字段必须用枚举类或者常亮定义具体的属性值，禁止在代码中硬编码写死；
3. 业务传输参数（集成领域模型对象，或者由多个领域模型对象组装成的对象）：XxxDTO，Xxx为业务领域相关的名称。仅在biz和web层中使用。
4. 展示对象：web层返回给前端的数据一律使用XxxVO封装，禁止使用Map。
5. 查询参数：biz和core层使用XxxQuery，dao层使用XxxDAOQuery，入参超过三个，就要用对象封装起来；

spring事务规范
声明式事务和编程式事务的比较：

1. 声明式事务是接口维度的，使用简单是要加上@Transactional的注解即可，但整个接口的代码都会进入数据库的事务中；
2. 编程式事务比较灵活，可以自己指定加事务的代码块，细化事务的代码块，提升数据库事务的效率，降低发生死锁的可能性，但对代码有一定的侵入性，可以封装一个事务模板用于统一处理；
3. 事务嵌套时编程式事务可制定事务的传播行为，来定制化事务的提交；
   场景：A类调用B类，B类调用C类，如果C类处理失败，要不能影响A类和B类的事务提交。声明式事务只要有一环的处理失败，所有数据都会回滚，使用编程式事务就能定制事务的事务的传播行为来完成该要求。该场景的需求一般较少会遇到，通常使用事务都是要求所有的数据要保持一致性；

总结：不推荐使用声明式事务，建议统一使用编程式事务。并且事务中只能包含数据库数据操作相关的代码，不能包含较多的业务处理逻辑，外部系统调用等耗时较长的代码；

事务模板代码实现：
Templates

import com.insigma.traffic.road.detection.model.exception.BizSystemException;
import com.insigma.tr