目录
- Springboot多模块项目搭建
- 创建maven父工程
- 创建子模块
- 创建web模块
- 添加模块依赖关系
- 多模块启动配置文件管理
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属性
4.刚才创建时选择的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
创建dao模块
创建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模块:
存放项目的数据模型,如常量、枚举、业务数据模型等;
多模块启动配置文件管理
多模块化后,想让每个模块的配置文件独立管理,整合的时候再合并各个不同的模块的配置,需要先在每个模块下面创建一个配置文件,文件的命名格式必须是application-xxx.yml,启动层模块想引用下层模块的配置时需要在配置文件中添加spring.profiles.include: xxx 或者spring.profiles.active: xxx (xxx为子模块配置文件的后缀标识名)配置项显示引用所需要的配置文件。注意启动层模块的配置文件名必须是application.yml或者application.properties,不能带上-xxx的后缀,不然导致spring.profiles.active的配置失效,从而无法加载子模块的配置。例如启动层是web层,web层的配置文件命名为application.yml,如果命名是application-web.yml会导致子模块的配置无法加载。
ConfigFileApplicationListener 子模块配置加载类源码说明如下,默认是从加载application.properties或application.yml这两个配置文件中加载其它配置文件的配置,所以启动层模块的配置文件名必须是application.properties或application.yml。
到此这篇关于IDEA2022搭建Spring Cloud多模块项目的文章就介绍到这了,更多相关Spring Cloud多模块项目内容请搜索自由互联以前的文章或继续浏览下面的相关文章希望大家以后多多支持自由互联!