Spring Boot多模块项目的创建和配置(Maven工程多模块)

简介: Spring Boot多模块项目的创建和配置(Maven工程多模块)

在进行分布式系统开发时,我们通常会创建多个模块的工程项目。即每一个功能就是一个Spring Boot工程,作为一个个模块,然后这些模块都会有一个父模块,父模块通常没有代码只有一个pom.xml

今天就来分享一下Spring Boot如何创建一个多模块项目,以创建一个两个子模块的工程为例。

1,创建父模块

在IDEA中,创建一个Spring Boot项目,但是不勾选任何依赖:

网络异常,图片无法展示
|

网络异常,图片无法展示
|

创建好之后,将父模块中除了pom.xml文件之外的全部文件删除:

网络异常,图片无法展示
|

因为父模块只是做一个模块和依赖管理的作用,因此不需要代码。

然后修改这个父模块的pom.xml文件,首先把节点、节点和全部删除:

网络异常,图片无法展示
|

然后修改版本号为自己定义的(方便后续子模块指定父模块):

网络异常,图片无法展示
|

然后修改父模块打包方式为pom,在其中加入如下语句即可:

<packaging>pom</packaging>

网络异常,图片无法展示
|

好的,到这里父模块修改就完成了!

2,创建子模块

在左边项目树中父模块位置右键新建Spring Boot工程:

网络异常,图片无法展示
|

网络异常,图片无法展示
|

网络异常,图片无法展示
|

然后把子模块不需要的文件也删掉(只留pom.xmlsrc文件夹):

网络异常,图片无法展示
|

修改该子模块的pom.xml文件,首先把子模块中的工件坐标改成和上述父模块一致:

网络异常,图片无法展示
|

网络异常,图片无法展示
|

然后删除子模块的groupId节点,因为通常子模块继承父模块,子模块的组id是和父模块的一致的:

网络异常,图片无法展示
|

ok,到此子模块创建并配置完成!此时这个子模块(工件名module-one)就继承了刚刚的父模块。

然后以这个步骤再创建一个子模块module-two

网络异常,图片无法展示
|

最后整个工程就创建完成了!总共两个子模块。

3,在父模块中指定子模块

回到父模块的pom.xml文件,添加modules节点,在其中加入module节点以指定子模块:

网络异常,图片无法展示
|

需要注意的是,module节点中的内容是子模块工程的文件夹名!所以通常规范起见子模块工程的文件夹名通常和它的组件名一致。

网络异常,图片无法展示
|

然后在父模块文件夹中执行mvn clean package试试:

网络异常,图片无法展示
|

可以看见构建打包成功,以及每个模块的构建时间。

到此,多模块项目就创建完成了!

4,子模块之间的互相引用

在多模块项目中,子模块的互相引用也很方便。

比如说上述module-one要调用module-two中的类,就直接把module-two的工件坐标加入到module-onepom.xml的依赖部分即可!

网络异常,图片无法展示
|

更新一下Maven工程,就可以在module-one中调用module-two的类了!

不过这个时候运行工程是没有任何问题的,但是打包会出错:虽然module-one依赖了module-two,但是仍然会在打包module-one的时候,提示找不到module-two中的类。

网络异常,图片无法展示
|

这是由于Spring Boot打包的模式问题,我们打开被依赖模块module-twopom.xml文件找到最下面节点中,在spring-boot-maven-plugin插件部分中加入下面配置:

<classifier>exec</classifier>

最终如下:

网络异常,图片无法展示
|

这个时候对父模块打包,就成功了!

网络异常,图片无法展示
|

5,依赖管理

多模块项目中模块变多了,依赖管理不当也会导致很多莫名其妙的问题。但是如果对每个模块分别管理依赖及其版本,会相当麻烦。

(1) 共用的依赖

假设上述module-onemodule-two都需要依赖fastjson2,我们平常并不会依次在module-onemodule-two中分别单独加入其依赖,而是直接在父模块pom.xml中指定,和平时一样,在父模块的pom.xmldependencis节点中加入即可:

网络异常,图片无法展示
|

这样,子模块中即使是不加入fastjson2依赖,也可以使用这个库了!因为子模块除了可以使用自己的依赖之外,还会向上查找父模块的依赖,也就是说,父模块的依赖是向下继承的,因此对于所有模块都要使用的依赖,我们可以写在父模块中。

所以,两个模块都依赖于Spring Web话,也可以将两个模块的Spring Web依赖移至父模块。

所以说父模块和子模块中,依赖也有着继承的关系!事实上,父模块的properties也是向下继承的。

(2) 依赖版本管理

假如现在module-one依赖于okhttps4.0.0版本,而module-two依赖于commons-io2.11.0版本,显然这时我们不适合再在父模块中加入了,还是各自加入对应依赖。

网络异常,图片无法展示
|

目前因为只有两个模块,这么做看起来很合理。但是假设现在又多了module-threemodule-four等等,它们也是分别依赖于okhttpscommons-io,那么我们又要分别在这两个模块中分别单独加入依赖。

摸块 依赖
module-onemodule-three okhttps
module-twomodule-four commons-io

可能一开始没有问题,但是后面模块依赖版本需要更新,但是一个个地更新难免会有疏漏,导致部分模块虽然依赖一样但是版本不一致,最后整个系统也出现了莫名其妙地错误,还难以排查。

就假设后面你把module-oneokhttps更新到了4.0.1版本,但是module-threeokhttps仍然是4.0.0版本,这样整个系统就可能出现问题甚至无法启动。

尤其是模块变成十几个甚至上百个了,一个个地手动修改是几乎不可能的,要如何让每个模块使用的依赖版本统一呢?

这时,我们就要借助dependencyManagement标签了!

dependencyManagement用于管理依赖的版本,我们在父模块的pom.xml加入这个标签:

<dependencyManagement><dependencies><dependency><groupId>cn.zhxu</groupId><artifactId>okhttps</artifactId><version>4.0.0</version></dependency><dependency><groupId>commons-io</groupId><artifactId>commons-io</artifactId><version>2.11.0</version></dependency></dependencies></dependencyManagement>

然后,在子模块中,就可以把对应的依赖版本去掉了!

网络异常,图片无法展示
|

可见这里,子模块中只需要引入对应依赖,而不需要指定版本了!因为子模块会向上查找父模块中dependencyManagement标签中对应依赖的版本

这样,就起到了统一管理版本的作用,只需要在父模块的dependencyManagement中修改对应依赖版本,子模块中对应依赖都会相应地使用这个版本。

dependencyManagement的注意事项:

  • dependencyManagement仅用于管理版本,而不会为自己以及子模块导入依赖,因此在dependencyManagement中声明依赖后,对应的子模块仍然需要在dependencies中加入依赖
  • pom.xmldependencyManagementdependencies同级,并且dependencyManagement中也需要有一个dependencies
  • dependencyManagement不仅可以管理子模块的依赖版本,也可以管理自身的依赖版本
  • 若不想让某个子模块使用父模块dependencyManagement的版本,那就在这个子模块的dependencies中声明对应版本

(3) 总结

总而言之,对于所有子模块都共用的依赖,我们只需在父模块的dependencies中引入这个依赖即可,而不需要再在子模块pom.xml中引入。

而对于不是所有子模块都需要的依赖,而是部分子模块需要的,又要统一版本管理,这时除了在需要这个依赖的子模块中引入依赖之外,还需要在父模块中的dependencyManagement声明这个依赖及其版本,这时,可以去掉子模块中对应依赖的版本号,使其遵循父模块中声明的版本。

示例仓库地址:

目录
打赏
0
0
0
0
59
分享
相关文章
|
12天前
|
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的配置
本文介绍了在Spring Boot中配置Swagger2的方法。通过创建一个配置类,添加`@Configuration`和`@EnableSwagger2`注解,使用Docket对象定义API文档的详细信息,包括标题、描述、版本和包路径等。配置完成后,访问`localhost:8080/swagger-ui.html`即可查看接口文档。文中还提示了可能因浏览器缓存导致的问题及解决方法。
50 0
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的配置
微服务——SpringBoot使用归纳——Spring Boot事务配置管理——Spring Boot 事务配置
本文介绍了 Spring Boot 中的事务配置与使用方法。首先需要导入 MySQL 依赖,Spring Boot 会自动注入 `DataSourceTransactionManager`,无需额外配置即可通过 `@Transactional` 注解实现事务管理。接着通过创建一个用户插入功能的示例,展示了如何在 Service 层手动抛出异常以测试事务回滚机制。测试结果表明,数据库中未新增记录,证明事务已成功回滚。此过程简单高效,适合日常开发需求。
45 0
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——MyBatis 介绍和配置
本文介绍了Spring Boot集成MyBatis的方法,重点讲解基于注解的方式。首先简述MyBatis作为持久层框架的特点,接着说明集成时的依赖导入,包括`mybatis-spring-boot-starter`和MySQL连接器。随后详细展示了`properties.yml`配置文件的内容,涵盖数据库连接、驼峰命名规范及Mapper文件路径等关键设置,帮助开发者快速上手Spring Boot与MyBatis的整合开发。
59 0
微服务——SpringBoot使用归纳——Spring Boot集成Thymeleaf模板引擎——依赖导入和Thymeleaf相关配置
在Spring Boot中使用Thymeleaf模板,需引入依赖`spring-boot-starter-thymeleaf`,并在HTML页面标签中声明`xmlns:th=&quot;http://www.thymeleaf.org&quot;`。此外,Thymeleaf默认开启页面缓存,开发时建议关闭缓存以实时查看更新效果,配置方式为`spring.thymeleaf.cache: false`。这可避免因缓存导致页面未及时刷新的问题。
32 0
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——指定项目配置文件
在实际项目中,开发环境和生产环境的配置往往不同。为简化配置切换,可通过创建 `application-dev.yml` 和 `application-pro.yml` 分别管理开发与生产环境配置,如设置不同端口(8001/8002)。在 `application.yml` 中使用 `spring.profiles.active` 指定加载的配置文件,实现环境快速切换。本节还介绍了通过配置类读取参数的方法,适用于微服务场景,提升代码可维护性。课程源码可从 [Gitee](https://gitee.com/eson15/springboot_study) 下载。
34 0
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(八)Config服务配置+bus消息总线+stream消息驱动+Sleuth链路追踪
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(八)Config服务配置+bus消息总线+stream消息驱动+Sleuth链路追踪
1161 0
【Spring学习笔记 五】Spring注解及Java类配置开发
【Spring学习笔记 五】Spring注解及Java类配置开发
114 0
spring学习笔记(22)声明式事务配置,readOnly无效写无异常
<div class="markdown_views"> <p>在上一节内容中,我们使用了编程式方法来配置事务,这样的优点是我们对每个方法的控制性很强,比如我需要用到什么事务,在什么位置如果出现异常需要回滚等,可以进行非常细粒度的配置。但在实际开发中,我们可能并不需要这样细粒度的配置。另一方面,如果我们的项目很大,service层方法很多,单独为每个方法配置事务也是一件很繁琐的
1701 0
spring学习笔记(23)基于tx/aop配置切面增强事务
<div class="markdown_views"> <p>在上一篇文章中,我们使用了声明式事务来配置事务,使事务配置从service逻辑处理中解耦出来。但它还存在一些缺点: <br> 1. 我们只针对方法名的特定进行拦截,但无法利用方法签名的其它信息定位,如修饰符、返回值、方法入参、异常类型等。如果我们需要为同名不同参的同载方法配置不同事务就会出问题了。 <br> 2.
2295 0

推荐镜像

更多