Spring Boot项目中怎么构建多模块的应用

news2024/9/16 11:02:30

在大型项目开发中，将项目分解为多个模块不仅可以增强代码的可维护性，还能提高开发效率。Spring Boot 提供了对多模块项目的良好支持，使得我们可以轻松地构建复杂的企业级应用程序。在这篇文章中，我们将深入探讨如何在Spring Boot项目中构建多模块的应用，包括多模块的原理、项目结构以及代码示例。

为了有效管理多个模块间的依赖版本，通常推荐使用BOM（Bill of Materials）。本文将详细介绍如何在Spring Boot项目中构建多模块应用，并使用子模块BOM来集中管理依赖版本。

一、为什么要使用多模块结构？

在一个多模块项目中，通常有一个主模块（也称为父模块），它包含多个子模块和一个bom模块。父模块负责管理子模块和插件配置。每个子模块都可以独立开发和测试，并且能够与其他模块协同工作。bom模块用来统一管理项目依赖版本。

多模块项目的核心优势包括：

  • 分而治之：将大项目拆分为多个模块，减少模块之间的耦合，提高可维护性。
  • 独立开发：各模块可以独立开发和测试，便于团队协作。
  • 重用性：模块可以在其他项目中复用，提高开发效率。

二、项目结构

一个典型的多模块项目结构如下：

my-spring-boot-app/
|-- pom.xml                 # 父项目pom文件
|-- bom/                    # BOM模块
|   |-- pom.xml             # BOM模块pom文件
|-- common/                 # 公共模块
|   |-- cache/                  # 缓存组件
|       |-- pom.xml             # 缓存组件pom文件
|       `-- src/main/java/      # 缓存组件Java源码
|   |-- pom.xml             # 公共模块pom文件
|-- business/               # 业务模块
|   |-- order/                  # 订单模块
|       |-- pom.xml             # 订单模块pom文件
|       `-- src/main/java/      # 订单模块java源码
|   |-- trade/                   # 交易模块
|       |-- pom.xml             # 交易模块pom文件
|       `-- src/main/java/      # 交易模块Java源码  
|   |-- pom.xml             # 业务模块pom文件
  • my-spring-boot-app/: 主模块，用于管理子模块。
  • common/, business/: 子模块，以及子模块下的子模块各自独立进行开发和维护。
  • bom/: bom模块，用于统一管理项目的依赖包和插件版本。

三、构建多模块项目

1. 创建主模块

首先，创建一个Maven项目作为主模块。在主模块的pom.xml中，我们需要声明该项目是一个父模块，并列出所有的子模块。

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.nft</groupId>
        <artifactId>nft-bom</artifactId>
        <version>${revision}</version>
        <relativePath>./nft-bom/pom.xml</relativePath>
    </parent>

    <artifactId>nft</artifactId>
    <packaging>pom</packaging>
    <description>NFT System</description>

    <properties>
        <revision>1.0.0-SNAPSHOT</revision>
    </properties>

    <modules>
        <module>nft-bom</module>
        <module>nft-business</module>
        <module>nft-common</module>
    </modules>

</project>
 2. 创建子模块

接下来，创建子模块。在每个子模块中，pom.xml文件需要继承主模块的配置：

2.1.创建子模块common及其子模块
  • 创建common模块
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.nft</groupId>
        <artifactId>nft</artifactId>
        <version>${revision}</version>
    </parent>

    <groupId>com.nft.common</groupId>
    <artifactId>nft-common</artifactId>
    <packaging>pom</packaging>
    <description>Nft Common Modules</description>

    <modules>
        <module>nft-cache</module>
    </modules>

</project>
  • 创建comon的子模块cache
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.nft.common</groupId>
        <artifactId>nft-common</artifactId>
        <version>${revision}</version>
    </parent>

    <artifactId>nft-cache</artifactId>
    <description>nft cache module</description>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-cache</artifactId>
        </dependency>

        <dependency>
            <groupId>org.hibernate.orm</groupId>
            <artifactId>hibernate-jcache</artifactId>
        </dependency>

        <dependency>
            <groupId>org.redisson</groupId>
            <artifactId>redisson</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

        <dependency>
            <groupId>tech.jhipster</groupId>
            <artifactId>jhipster-framework</artifactId>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </dependency>

    </dependencies>
</project>
2.2.创建子模块business及其子模块
  • 创建business模块
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.nft</groupId>
        <artifactId>nft</artifactId>
        <version>${revision}</version>
    </parent>

    <groupId>com.nft.business</groupId>
    <artifactId>nft-business</artifactId>
    <packaging>pom</packaging>
    <description>Nft Business Modules</description>

    <modules>
        <module>nft-order</module>
        <module>nft-trade</module>
    </modules>

</project>
  • 创建business的子模块order
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.nft.business</groupId>
        <artifactId>nft-business</artifactId>
        <version>${revision}</version>
    </parent>

    <artifactId>nft-order</artifactId>
    <description>Nft Order Modules</description>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-undertow</artifactId>
        </dependency>

        <dependency>
            <groupId>com.nft.common</groupId>
            <artifactId>nft-cache</artifactId>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>
  • 创建business的子模块trade
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.nft.business</groupId>
        <artifactId>nft-business</artifactId>
        <version>${revision}</version>
    </parent>

    <artifactId>nft-trade</artifactId>
    <description>Nft Trade Modules</description>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-undertow</artifactId>
        </dependency>

    </dependencies>
</project>
3. 配置子模块之间的依赖 

如果模块之间有依赖关系，例如nft-order依赖于nft-cache，可以在nft-order的pom.xml中添加依赖：

<!--版本在bom中配置-->
<dependency>
    <groupId>com.nft.common</groupId>
    <artifactId>nft-cache</artifactId>
</dependency>
4.在子模块中创建BOM来管理依赖和插件版本

接下来，我们在 my-spring-boot-app 项目中创建 bom 子模块，用来管理所有子模块的依赖和插件版本。

创建 bom 模块的 pom.xml：

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.3.3</version>
        <relativePath/>
        <!-- lookup parent from repository -->
    </parent>

    <groupId>com.nft</groupId>
    <artifactId>nft-bom</artifactId>
    <version>${revision}</version>
    <packaging>pom</packaging>
    <description>Bill of materials for nft modules</description>

    <properties>
        <nft.version>1.0.0-SNAPSHOT</nft.version>
        <java.version>21</java.version>

        <spring-boot.version>3.3.3</spring-boot.version>
        <jhipster-framework.version>8.7.0</jhipster-framework.version>
        <redisson.version>3.35.0</redisson.version>

        <!-- plugin versions -->
        <flatten-maven-plugin.version>1.6.0</flatten-maven-plugin.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
                <version>${spring-boot.version}</version>
                <exclusions>
                    <exclusion>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-tomcat</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>

            <dependency>
                <groupId>org.redisson</groupId>
                <artifactId>redisson</artifactId>
                <version>${redisson.version}</version>
            </dependency>

            <dependency>
                <groupId>tech.jhipster</groupId>
                <artifactId>jhipster-framework</artifactId>
                <version>${jhipster-framework.version}</version>
            </dependency>

            <dependency>
                <groupId>com.nft.common</groupId>
                <artifactId>nft-cache</artifactId>
                <version>${revision}</version>
            </dependency>

            <!-- fix vulnerable -->
            <dependency>
                <groupId>io.undertow</groupId>
                <artifactId>undertow-core</artifactId>
                <version>2.3.17.Final</version>
            </dependency>

        </dependencies>
    </dependencyManagement>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.codehaus.mojo</groupId>
                    <artifactId>flatten-maven-plugin</artifactId>
                    <version>${flatten-maven-plugin.version}</version>
                </plugin>
            </plugins>

        </pluginManagement>

        <plugins>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>flatten-maven-plugin</artifactId>
                <configuration>
                    <updatePomFile>true</updatePomFile>
                    <flattenMode>oss</flattenMode>
                </configuration>
                <executions>
                    <execution>
                        <id>flatten</id>
                        <phase>process-resources</phase>
                        <goals>
                            <goal>flatten</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>flatten.clean</id>
                        <phase>clean</phase>
                        <goals>
                            <goal>clean</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>
 5. 编写代码

在各自的src/main/java目录下，编写模块对应的代码。例如在nft-order中编写一个简单的Spring Boot应用：

package com.spring.nft.order;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class OrderServiceApplication {

    public static void main(String[] args) {
        SpringApplication.run(OrderServiceApplication.class, args);
    }

}

其他模块可以编写类似的代码。子模块中的类可以互相调用，从而实现模块之间的协作。

6. 构建和运行项目 

在主模块的根目录下，运行以下命令构建整个项目：

mvn clean install

构建完成后，可以运行各个子模块的Spring Boot应用：

mvn spring-boot:run -pl nft-order

四、使用BOM管理的好处

通过在 bom 子模块中集中管理依赖和插件版本，父模块和子模块的 pom.xml 将变得更加简洁和可维护。

  • 统一依赖版本：通过BOM模块集中管理依赖和插件版本，避免了多个子模块中手动管理版本的一致性问题。
  • 减少冗余配置：子模块只需声明依赖，而不需要关注具体的版本号，所有版本管理集中在一个地方。

五、总结

通过本文的介绍，我们了解了如何在Spring Boot项目中构建多模块应用，并且通过实际的示例展示了如何配置和使用多模块结构。在实际开发中，根据项目的需求，合理设计模块结构，不仅可以提高开发效率，还能有效地管理项目的复杂性。

使用子模块BOM来管理多模块项目的依赖和插件版本，是一种高效且可维护的方案。通过这种方式，可以将所有版本信息集中在一个地方，使得整个项目的依赖和插件管理变得更加简洁和一致。在复杂项目中，这种方法能够有效地减少版本冲突和管理成本。

希望本文能帮助你在实际项目中更加灵活和有效地使用Spring Boot多模块结构。如果你有任何问题或建议，欢迎在评论区留言讨论。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/2117096.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

数据结构(2):LinkedList和链表[1]

数据结构(2):LinkedList和链表[1]

下面我们来介绍一种新的数据结构&#xff0c;链表。 我们曾经讨论过顺序表。它的数据存储在物理和逻辑上都是有逻辑的。而我们今天要学习的链表&#xff0c;则在物理结构上非连续存储&#xff0c;逻辑上连续。 1.链表的认识 链表由一个一个的节点组成。 我们可以想象一列火…
阅读更多...
乐鑫安全制造全流程

乐鑫安全制造全流程

主要参考资料&#xff1a; 【乐鑫全球开发者大会】DevCon24 #10 &#xff5c;乐鑫安全制造全流程 乐鑫官方文档Flash加密: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/security/flash-encryption.html 【ESP32S3】使用 Flash 下载工具完成 Flash 加密功能…
阅读更多...
C++ | Leetcode C++题解之第394题字符串解码

C++ | Leetcode C++题解之第394题字符串解码

题目&#xff1a; 题解&#xff1a; class Solution { public:string src; size_t ptr;int getDigits() {int ret 0;while (ptr < src.size() && isdigit(src[ptr])) {ret ret * 10 src[ptr] - 0;}return ret;}string getString() {if (ptr src.size() || src[…
阅读更多...
C语言 | Leetcode C语言题解之第393题UTF-8编码验证

C语言 | Leetcode C语言题解之第393题UTF-8编码验证

题目&#xff1a; 题解&#xff1a; static const int MASK1 1 << 7; static const int MASK2 (1 << 7) (1 << 6);bool isValid(int num) {return (num & MASK2) MASK1; }int getBytes(int num) {if ((num & MASK1) 0) {return 1;}int n 0;in…
阅读更多...
windows电脑自动倒计时关机

windows电脑自动倒计时关机

今天聊一聊其他的。我时不时的有一个需求&#xff0c;是关于在windows电脑上定时关机。 不知道怎么地&#xff0c;我好几次都忘了这个自动定时关机的终端命令&#xff0c;于是每一次都要去网上查。 1.鼠标右击【开始菜单】选择【运行】或在键盘上按【 WinR】快捷键打开运行窗口…
阅读更多...
【变化检测】基于STANet建筑物(LEVIR-CD)变化检测实战及ONNX推理

【变化检测】基于STANet建筑物(LEVIR-CD)变化检测实战及ONNX推理

主要内容如下&#xff1a; 1、LEVIR-CD数据集介绍及下载 2、运行环境安装 3、STANet模型训练与预测 4、Onnx运行及可视化 运行环境&#xff1a;Python3.8&#xff0c;torch1.12.0cu113 likyoo变化检测源码&#xff1a;https://github.com/likyoo/open-cd 使用情况&#xff1a…
阅读更多...
力扣周赛：第414场周赛

力扣周赛：第414场周赛

&#x1f468;‍&#x1f393;作者简介&#xff1a;爱好技术和算法的研究生 &#x1f30c;上期文章&#xff1a;[首期文章] &#x1f4da;订阅专栏&#xff1a;力扣周赛 希望文章对你们有所帮助 本科打ACM所以用的都是C&#xff0c;未来走的是Java&#xff0c;所以现在敲算法还…
阅读更多...
探索未来住宿新体验：酒店智能开关引领的智慧生活

探索未来住宿新体验：酒店智能开关引领的智慧生活

酒店智能开关作为智慧酒店的重要组成部分&#xff0c;正悄然改变着我们的旅行住宿方式&#xff0c;让每一次入住都成为一场科技与舒适的完美邂逅。 智能开关&#xff1a;重新定义酒店房间的每一个角落 传统酒店中&#xff0c;房间的灯光、空调、窗帘等设备的控制往往依赖于手动…
阅读更多...
LCD字符图片显示——FPGA学习笔记11

LCD字符图片显示——FPGA学习笔记11

一、字模显示原理 字模数据&#xff1a;将这个0/1矩阵按照屏幕扫描的顺序以字节的形式体现。 取模软件设计&#xff1a; 点阵数要按照实际情况填写 二、实验任务 本节的实验任务是通过开发板上的RGB TFT-LCD接口&#xff0c;在RGB LCD液晶屏的左上角位置从上到下依次显示图片以…
阅读更多...
【数据结构】希尔排序（缩小增量排序）

【数据结构】希尔排序（缩小增量排序）

目录 一、基本思想 1.1 引入希尔排序的原因 1.2 基本思想 二、思路分析 三、gap分组问题 四、代码实现 4.1 代码一&#xff08;升序&#xff09; 4.2 代码二&#xff08;升序&#xff09; 五、易错提醒 六、时间复杂度分析 七、排序小tips 一、基本思想 1.1 引入希尔…
阅读更多...
Vue3：＜Teleport＞传送门组件的使用和注意事项

Vue3：＜Teleport＞传送门组件的使用和注意事项

你好&#xff0c;我是沐爸&#xff0c;欢迎点赞、收藏、评论和关注。 Vue3 引入了一个新的内置组件 <Teleport>&#xff0c;它允许你将子组件树渲染到 DOM 中的另一个位置&#xff0c;而不是在父组件的模板中直接渲染。这对于需要跳出当前组件的 DOM 层级结构进行渲染的…
阅读更多...
15.1 JDBC数据库编程1

15.1 JDBC数据库编程1

目录 15 引言 15.1.1 数据库语言SQL 15.2 JDBC体系结构 15.2.1 JDBC访问数据库 15.2.2 JDBC API介绍 15 引言 数据库系统&#xff08;database system,DBS&#xff09;由一个互相关联的数据集合和一组用以访问这些数据的程序组成。这个数据集合通常称为数据库。 …
阅读更多...
音频-语言大模型原理

音频-语言大模型原理

重磅推荐专栏： 《大模型AIGC》 《课程大纲》 《知识星球》 本专栏致力于探索和讨论当今最前沿的技术趋势和应用领域，包括但不限于ChatGPT和Stable Diffusion等。我们将深入研究大型模型的开发和应用，以及与之相关的人工智能生成内容（AIGC）技术。通过深入的技术解析和实践经…
阅读更多...
YOLOv8改进实战 | 注意力篇 | CloFormer: 注意力机制与卷积的完美融合CloAtention，即插即用

YOLOv8改进实战 | 注意力篇 | CloFormer: 注意力机制与卷积的完美融合CloAtention，即插即用

YOLOv8专栏导航：点击此处跳转 前言 YOLOv8 是由 YOLOv5 的发布者 Ultralytics 发布的最新版本的 YOLO。它可用于对象检测、分割、分类任务以及大型数据集的学习，并且可以在包括 CPU 和 GPU 在内的各种硬件上执行。 YOLOv8 是一种尖端的、最先进的 (SOTA) 模型，它建立在以前…
阅读更多...
(C++) 6大作用域

(C++) 6大作用域

文章目录 &#x1f365;前言&#x1f365;C 6大作用域&#x1f41f;块&#x1f41f;名字空间&#x1f41f;类&#x1f41f;函数参数&#x1f41f;枚举&#x1f41f;模板参数 ⭐END&#x1f31f;交流方式 &#x1f365;前言 在 C core guidelines 中有一个准则&#xff1a; ES.…
阅读更多...
深入探索Unity协程：揭开CSharp迭代器背后的神秘面纱

深入探索Unity协程：揭开CSharp迭代器背后的神秘面纱

协程是一种特殊类型的迭代器方法&#xff0c;允许你在多个帧之间分段执行代码。可以用来处理时间延迟、异步操作和顺序执行的任务&#xff0c;而不阻塞主线程。Unity协程的实现依赖于C#语言提供的迭代器相关的语言特性&#xff0c;所以想要弄清楚Unity协程的底层原理&#xff0…
阅读更多...
web群集--nginx配置文件location匹配符的优先级顺序详解及验证

web群集--nginx配置文件location匹配符的优先级顺序详解及验证

文章目录 前言优先级顺序优先级顺序(详解)1. 精确匹配&#xff08;Exact Match&#xff09;2. 正则表达式匹配&#xff08;Regex Match&#xff09;3. 前缀匹配&#xff08;Prefix Match&#xff09; 匹配规则的综合应用验证优先级 前言 location的作用 在 NGINX 中&#xff0…
阅读更多...
Idea Mac代码调试常用快捷键～

Idea Mac代码调试常用快捷键～

Mac截图 commandShift4 idea英文大写转小写 commandShiftU 功能&#xff1a;查看类的实现和继承父类的方法 快捷键 fncommandF12 鼠标点击打开 功能&#xff1a;查看当前方法的上游方法 选中方法&#xff0c;controloptionH 功能&#xff1a;CommandB是查看本类的方法 功能&…
阅读更多...
Matlab simulink建模与仿真 第十一章（端口及子系统库）【下】

Matlab simulink建模与仿真 第十一章（端口及子系统库）【下】

参考视频&#xff1a;simulink1.1simulink简介_哔哩哔哩_bilibili 八、触发使能子系统 1、Enabled and Triggered Subsystem触发使能子系统概述 触发使能子系统其实是触发子系统和使能子系统二者的结合&#xff0c;当触发端口传来触发信号时&#xff0c;使能端口的输入需要大…
阅读更多...
TitleBar：打造高效Android标题栏的新选择

TitleBar：打造高效Android标题栏的新选择

在Android应用开发中&#xff0c;标题栏是用户界面的重要组成部分。一个好的标题栏不仅能够提升应用的专业感&#xff0c;还能增强用户体验。然而&#xff0c;传统的标题栏实现方式往往存在代码冗余、样式不统一、性能开销大等问题。今天&#xff0c;我们将介绍一个名为TitleBa…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023