spring boot3多模块项目工程搭建-上（团队开发模板）

⛰️个人主页:     蒾酒

🔥系列专栏：《spring boot实战》

目录

写在前面

多模块结构优缺点

模块介绍

Common 模块：

API 模块：

Web 模块：

Service 模块：

DAO 模块：

搭建步骤

1.创建 父Maven 项目

2.添加各模块

3.配置父项目构建

4.配置Web模块构建

5.配置Service模块构建

6.配置DAO模块构建

7.配置API模块构建

8.配置Common模块构建

9.启动类位置修改

10.编写测试接口

11.打包测试

 12.启动项目测试接口

写在最后 

写在前面

本文介绍了springboot开发后端服务，多模块项目工程搭建。坚持看完相信对你有帮助。

同时欢迎订阅springboot系列专栏，持续分享spring boot的使用经验。

多模块结构优缺点

多模块项目将代码分成多个子模块，每个模块可以单独构建和管理。通常适用于大型项目或团队，以及那些希望将不同的功能或服务进行解耦的场景。

优点

  • 模块化：代码解耦，每个模块负责特定的功能，易于维护。
  • 团队协作：不同的团队可以在不同的模块上工作，减少冲突。
  • 重用性：可以将模块打包成共享库，供其他项目使用。

缺点

  • 复杂性：项目结构更复杂，构建和部署过程可能需要更多配置。
  • 管理难度：需要更多的协调和沟通，以确保模块之间的兼容性。

模块介绍

  1. Common 模块：

    • 职责：Common 模块通常包含各种通用的工具类、常量定义、异常类等。
    • 功能：
      • 存放通用的工具方法，如日期处理、字符串处理等。
      • 存放常量定义，如错误码、常量字符串、数据对象等。
      • 定义通用的异常类，如自定义的业务异常。

  2. API 模块：

    •  职责：API 模块用于定义应用程序的外部接口，通常是 RESTful API 或 GraphQL 接口。
    • 功能：
      • 定义接口的请求和响应对象。
      • 定义接口的路径、请求方法和参数。
      • 提供接口文档和描述。 

  3. Web 模块：

    • 职责：Web 模块负责处理 HTTP 请求，将请求转发给 Service 模块处理，并返回响应给客户端。
    • 功能：
      • 处理请求参数的验证和转换。
      • 调用 Service 模块提供的服务进行业务逻辑处理。
      • 构建响应并返回给客户端。

  4. Service 模块：

    • 职责：Service 模块包含应用程序的业务逻辑，负责处理业务规则和数据处理。
    • 功能：
      • 实现应用程序的业务逻辑。
      • 调用 DAO 模块提供的数据访问接口进行数据库操作。
      • 处理事务管理。

  5. DAO 模块：

    • 职责：DAO 模块负责与数据库进行交互，执行数据访问操作。
    • 功能：
      • 提供数据访问对象（DAO）接口，定义对数据库的增删改查操作。
      • 实现 DAO 接口，执行 SQL 查询和更新操作。
      • 处理数据库连接和资源管理。

搭建步骤

1.创建 父Maven 项目

父工程在 Maven 项目中扮演着组织和管理子模块的角色。它通常是一个空的 POM（Project Object Model）文件，用于定义项目的基本信息和管理子模块的依赖关系。父工程可以统一管理子模块的版本号、依赖项和插件配置，从而简化项目的构建和维护过程。同时，父工程也可以提供一些公共的配置和资源，供子模块共享使用。

父项目不放任何代码用不到的文件全部删除

2.添加各模块

在项目中创建各个模块的子目录，如Common、API、Web、Service和DAO。

Common模块

任何依赖都先不用选，后续统一在pom.xml导入

删除无用文件：只保留src、.gitignore、pom.xml

src/main/java/·····内的启动类删除，src/test/java/····内的测试类删除

API模块、Web模块、Service模块和DAO模块

添加方法跟Common模块一样、依次添加即可。

仅web模块要保留启动类和测试类

添加完成如图：

删除无用文件如图：

3.配置父项目构建

在项目的根目录下的 pom.xml 文件中配置 Maven 构建，指定各个模块的依赖关系和构建顺序。

父项目pom.xml:

需要清理无用配置

设置打包方式为pom

导入子模块

完整pom.xml如下：

<?xml version="1.0" encoding="UTF-8"?>
<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 https://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.2.5</version>
        <relativePath/>
    </parent>
    <groupId>com.mijiu</groupId>
    <artifactId>springboot-modules-template</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-modules-template</name>
    <description>springboot-modules-template</description>
    <properties>
        <java.version>17</java.version>
    </properties>

    <!--设置打包方式为pom-->
    <packaging>pom</packaging>

    <!--子模块-->
    <modules>
        <module>common</module>
        <module>api</module>
        <module>service</module>
        <module>dao</module>
        <module>web</module>
    </modules>

   <!--依赖的子模块-->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.mijiu</groupId>
                <artifactId>common</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
            <dependency>
                <groupId>com.mijiu</groupId>
                <artifactId>api</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
            <dependency>
                <groupId>com.mijiu</groupId>
                <artifactId>service</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
            <dependency>
                <groupId>com.mijiu</groupId>
                <artifactId>dao</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
            <dependency>
                <groupId>com.mijiu</groupId>
                <artifactId>web</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

4.配置Web模块构建

  • web模块继承父项目
  • web模块依赖service模块
  • web模块需要spring boot web组件

pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <!-- 继承父包 -->
    <parent>
        <groupId>com.mijiu</groupId>
        <artifactId>springboot-modules-template</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>


    <artifactId>web</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>web</name>
    <description>web</description>
    <properties>
        <java.version>17</java.version>
    </properties>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- 引入service模块 -->
        <dependency>
            <groupId>com.mijiu</groupId>
            <artifactId>service</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

5.配置Service模块构建

  • service模块继承父项目
  • service模块依赖dao模块

pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!-- 继承父包 -->
    <parent>
        <groupId>com.mijiu</groupId>
        <artifactId>springboot-modules-template</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <artifactId>service</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>service</name>
    <description>service</description>
    <properties>
        <java.version>17</java.version>
    </properties>

    <dependencies>
        <!-- 引入dao模块 -->
        <dependency>
            <groupId>com.mijiu</groupId>
            <artifactId>dao</artifactId>
        </dependency>
    </dependencies>
    
</project>

6.配置DAO模块构建

  • dao模块继承父项目
  • dao模块依赖common模块
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!-- 继承父包 -->
    <parent>
        <groupId>com.mijiu</groupId>
        <artifactId>springboot-modules-template</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <artifactId>dao</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>dao</name>
    <description>dao</description>
    <properties>
        <java.version>17</java.version>
    </properties>

    <dependencies>
        <!-- 引入common模块 -->
        <dependency>
            <groupId>com.mijiu</groupId>
            <artifactId>common</artifactId>
        </dependency>
    </dependencies>

</project>

7.配置API模块构建

  • api模块继承父项目
  • api模块依赖common模块
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!-- 继承父包 -->
    <parent>
        <groupId>com.mijiu</groupId>
        <artifactId>springboot-modules-template</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <artifactId>api</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>API</name>
    <description>API</description>
    <properties>
        <java.version>17</java.version>
    </properties>

    <dependencies>
        <!-- 引入common模块 -->
        <dependency>
            <groupId>com.mijiu</groupId>
            <artifactId>common</artifactId>
        </dependency>
    </dependencies>

</project>

 

8.配置Common模块构建

  • common模块继承父项目
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!-- 继承父包 -->
    <parent>
        <groupId>com.mijiu</groupId>
        <artifactId>springboot-modules-template</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <artifactId>common</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>common</name>
    <description>common</description>
    <properties>
        <java.version>17</java.version>
    </properties>

    <dependencies>

    </dependencies>



</project>

9.启动类位置修改

再次强调只有web模块保留启动类和测试类！

原位置

修改后

10.编写测试接口

package com.mijiu.web;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    @RequestMapping("/hello")
    public String hello() {
        return "Hello World!";
    }
}

11.打包测试

在此之前一定保证仅web模块保留启动类和测试类，其他模块一律删除。

打包成功

 12.启动项目测试接口

在web模块的启动类启动项目

启动成功

测试接口

写在最后 

spring boot3多模块项目工程搭建基础搭建到这里就结束了。任何问题评论区或私信讨论，欢迎指正。

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

JavaWeb_请求响应_简单参数实体参数

JavaWeb_请求响应_简单参数实体参数

一、SpringBoot方式接收携带简单参数的请求 简单参数&#xff1a;参数名与形参变量名相同&#xff0c;定义形参即可接收参数。并且在接收过程中&#xff0c;会进行自动的类型转换。 启动应用程序后&#xff0c;在postman中进行测试&#xff1a; 请求成功&#xff0c;响应回了O…
阅读更多...
Flask教程3：jinja2模板引擎

Flask教程3：jinja2模板引擎

文章目录 模板的导入与使用 模板的导入与使用 Flask通过render_template来实现模板的渲染&#xff0c;要使用这个方法&#xff0c;我们需要导入from flask import rander_template&#xff0c;模板中注释需放在{# #}中 模板的第一个参数为指定的模板文件名称&#xff0c;如自定…
阅读更多...
微信小程序生成二维码加密（CryptoJS4.0加密PHP8.0解密）AES方式加密

微信小程序生成二维码加密（CryptoJS4.0加密PHP8.0解密）AES方式加密

1、小程序创建 crypto-js.js和crypto.js两个文件&#xff08;点击文件即可&#xff09; 2、小程序js页面引入 var crypto require(../../utils/crypto.js);//注意路径是否正确3、使用 let data {id: that.data.id,name: dx}console.log(JSON.stringify(data))console.log(&…
阅读更多...
【论文阅读】Learning Texture Transformer Network for Image Super-Resolution

【论文阅读】Learning Texture Transformer Network for Image Super-Resolution

Learning Texture Transformer Network for Image Super-Resolution 论文地址Abstract1. 简介2.相关工作2.1单图像超分辨率2.2 Reference-based Image Super-Resolution 3. 方法3.1. Texture TransformerLearnable Texture Extractor 可学习的纹理提取器。Relevance Embedding.…
阅读更多...
【八股】AQS，ReentrantLock实现原理

【八股】AQS，ReentrantLock实现原理

AQS 概念 AQS 的全称是 AbstractQueuedSynchronized &#xff08;抽象队列同步器&#xff09;&#xff0c;在java.util.concurrent.locks包下面。 AQS是一个抽象类&#xff0c;主要用来构建锁和同步器&#xff0c;比如ReentrantLock, Semaphore, CountDownLatch&#xff0c;里…
阅读更多...
Leetcode—163. 缺失的区间【简单】Plus

Leetcode—163. 缺失的区间【简单】Plus

2024每日刷题&#xff08;126&#xff09; Leetcode—163. 缺失的区间 实现代码 class Solution { public:vector<vector<int>> findMissingRanges(vector<int>& nums, int lower, int upper) {int n nums.size();vector<vector<int>> an…
阅读更多...
基于遗传优化模糊控制器的水箱水位控制系统simulink建模与仿真

基于遗传优化模糊控制器的水箱水位控制系统simulink建模与仿真

目录 1.课题概述 2.系统仿真结果 3.核心程序与模型 4.系统原理简介 4.1 模糊控制器原理 4.2 遗传算法原理 4.3 遗传优化模糊控制器的工作流程 5.完整工程文件 1.课题概述 基于遗传优化模糊控制器的水箱水位控制系统simulink建模与仿真。对比模糊控制器和基于遗传优化的…
阅读更多...
Python基础详解一

Python基础详解一

一&#xff0c;print打印 print("hello word") print(hello word) 双引号和单引号都可以 二&#xff0c;数据类型 Python中常用的有6种值的类型 输出类型信息 print(type(11)) print(type("22")) print(type(22.2)) <class int> <class str&…
阅读更多...
飞书API（7）：MySQL 入库通用版本

飞书API（7）：MySQL 入库通用版本

一、引入 在上一篇介绍了如何使用 pandas 处理飞书接口返回的数据&#xff0c;并将处理好的数据入库。最终的代码拓展性太差&#xff0c;本篇来探讨下如何使得上一篇的最终代码拓展性更好&#xff01;为什么上一篇的代码拓展性太差呢&#xff1f;我总结了几点&#xff1a; 列…
阅读更多...
深入理解 Java 并发：AbstractQueuedSynchronizer 源码分析

深入理解 Java 并发：AbstractQueuedSynchronizer 源码分析

序言 在多线程编程中&#xff0c;同步机制是保障线程安全和协调线程之间操作顺序的重要手段。AQS 作为 Java 中同步机制的基础框架&#xff0c;为开发者提供了一个灵活且高效的同步工具。本文将通过对 AQS 源码的分析&#xff0c;解读 AQS 的核心实现原理&#xff0c;并深入探…
阅读更多...
wireshark的安装使用及相关UDP、TCP、 ARP

wireshark的安装使用及相关UDP、TCP、 ARP

初步了解&#xff1a; 进入wireshark后如图&#xff1a; 从图中可以看到很多网络连接在操作的时候我们需要监测哪些 我们可以直接在本地的运行框中输入ipconfig来查看 如图&#xff1a; 从以上图片中我们可以清楚地看到哪些网络连接已经连接的我们只需要按需监测他们即可 但…
阅读更多...
【LinuxC语言】信号集与sigprocmask

【LinuxC语言】信号集与sigprocmask

文章目录 前言一、信号集1.1 操作信号集相关的函数1.2 信号屏蔽字1.3 sigprocmask1.4 示例代码 总结 前言 在Linux C编程中&#xff0c;信号是一种重要的进程间通信机制&#xff0c;用于通知进程发生了特定的事件。然而&#xff0c;程序在执行过程中可能会收到各种各样的信号&…
阅读更多...
银河麒麟桌面版开机后网络无法自动链接 麒麟系统开机没有连接ens33

银河麒麟桌面版开机后网络无法自动链接 麒麟系统开机没有连接ens33

1.每次虚拟机开机启动麒麟操作系统&#xff0c;都要输入账号&#xff0c;密码。 进入点击这个ens33 内网才连接 2. 如何开机就脸上呢&#xff1f; 2.1. 进入 cd /etc/sysconfig/network-scripts 2.2 修改参数 onbootyes 改为yes 2.3 重启即可 a. 直接重启机器查看是否正常&…
阅读更多...
软件工程习题答案2024最新版

软件工程习题答案2024最新版

习题一答案 一、选择题 软件的主要特性是(A B C)。 A) **无形 **B) 高成本 C) **包括程序和文档 ** D) 可独立构成计算机系统 软件工程三要素是(B)。 A) 技术、方法和工具 B) 方法、工具和过程 C) 方法、对象和类 D) 过程、模型、方法 包含风险分析的软件工程模型是(A)…
阅读更多...
Reactor模型详解

Reactor模型详解

目录 1.概述 2.Single Reactor 3.muduo库的Multiple Reactors模型如下 1.概述 维基百科对Reactor模型的解释 The reactor design pattern is an event handling pattern for handling service requests delivered concurrently to a service handler by one or more inputs.…
阅读更多...
【Java基础】三大特性——封装

【Java基础】三大特性——封装

封装 只对外提供有用的属性和行为 方法的封装 外界不会用到的方法 class MyMath {//private私有 封装函数&#xff1a;只对外提供有用的属性和行为private void toAny(int num,int base,int offSet){……}public void toHex( int num){toAny( num,15,4);}…… } class Demo…
阅读更多...
GNU Radio创建FFT、IFFT C++ OOT块

GNU Radio创建FFT、IFFT C++ OOT块

文章目录 前言一、GNU Radio官方FFT弊端二、创建自定义的 C OOT 块1、创建 OOT 模块2、创建 OOT 块3、修改 C 和 CMAKE 文件4、编译及安装 OOT 块 三、测试1、grc 图2、运行结果①、时域波形对比②、频谱图对比 四、资源自取 前言 GNU Radio 自带的 FFT 模块使用起来不是很方便…
阅读更多...
新型直膨式光伏光热热泵/动力热管复合循环系统

新型直膨式光伏光热热泵/动力热管复合循环系统

太阳能光伏光热热泵&#xff08;即PVT热泵&#xff09;技术是建筑领域内实现碳中和的有效技术手段&#xff0c;该技术具有优越的热电冷联产能力。然而&#xff0c;现有的PVT热泵在良好的室外工况下能耗较高。为了解决这一问题&#xff0c;本文提出了一种新型的DX-PVT热泵/动力热…
阅读更多...
书接上文，助力智能化诊断高质提效，基于轻量级CNN模型MobileNet开发构建人体手骨X光骨骼骨龄分析识别系统

书接上文，助力智能化诊断高质提效，基于轻量级CNN模型MobileNet开发构建人体手骨X光骨骼骨龄分析识别系统

骨龄是骨骼年龄的简称&#xff0c;需要借助于骨骼在X光摄像中的特定图像来确定。通常要拍摄左手手腕部位的X光片&#xff0c;医生通过X光片观察来确定骨龄。这在临床上是一件非常消耗精力和时间的一项放射临床工作。写一个骨龄可能要10多分钟去完成。如果一天要写几十个骨龄&am…
阅读更多...
10G MAC层设计系列-（4）MAC TX模块

10G MAC层设计系列-（4）MAC TX模块

一、前言 MAC TX模块就是要将IP层传输过来的数据封装前导码、MAC地址、帧类型以及进行CRC校验&#xff0c;并与CRC值一块组成以太网帧。 二、模块设计 首先对输入的数据进行缓存&#xff0c;原因是在之后要进行封装MAC帧头&#xff0c;所以需要控制数据流的流动 FIFO_DATA_6…
阅读更多...
最新文章

Copyright @ 2022~2023