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

2024-04-29 09:04
文章标签 java 模板 模块 项目 开发 spring 搭建 工程 团队 boot3

本文主要是介绍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多模块项目工程搭建基础搭建到这里就结束了。任何问题评论区或私信讨论，欢迎指正。

这篇关于spring boot3多模块项目工程搭建-上（团队开发模板）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/945664。

相关文章

Java实现检查多个时间段是否有重合

Java实现检查多个时间段是否有重合

《Java实现检查多个时间段是否有重合》这篇文章主要为大家详细介绍了如何使用Java实现检查多个时间段是否有重合,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录流程概述步骤详解China编程步骤1：定义时间段类步骤2：添加时间段步骤3：检查时间段是否有重合步骤4：输出结果示例代码结语作
阅读更多...
Java中String字符串使用避坑指南

Java中String字符串使用避坑指南

《Java中String字符串使用避坑指南》Java中的String字符串是我们日常编程中用得最多的类之一,看似简单的String使用,却隐藏着不少“坑”,如果不注意,可能会导致性能问题、意外的错误容... 目录8个避坑点如下：1. 字符串的不可变性：每次修改都创建新对象2. 使用 == 比较字符串，陷阱满
阅读更多...
Java判断多个时间段是否重合的方法小结

Java判断多个时间段是否重合的方法小结

《Java判断多个时间段是否重合的方法小结》这篇文章主要为大家详细介绍了Java中判断多个时间段是否重合的方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录判断多个时间段是否有间隔判断时间段集合是否与某时间段重合判断多个时间段是否有间隔实体类内容public class D
阅读更多...
IDEA编译报错“java: 常量字符串过长”的原因及解决方法

IDEA编译报错“java: 常量字符串过长”的原因及解决方法

《IDEA编译报错“java:常量字符串过长”的原因及解决方法》今天在开发过程中,由于尝试将一个文件的Base64字符串设置为常量,结果导致IDEA编译的时候出现了如下报错java:常量字符串过长,... 目录一、问题描述二、问题原因2.1 理论角度2.2 源码角度三、解决方案解决方案①：StringBui
阅读更多...
Java覆盖第三方jar包中的某一个类的实现方法

Java覆盖第三方jar包中的某一个类的实现方法

《Java覆盖第三方jar包中的某一个类的实现方法》在我们日常的开发中,经常需要使用第三方的jar包,有时候我们会发现第三方的jar包中的某一个类有问题,或者我们需要定制化修改其中的逻辑,那么应该如何... 目录一、需求描述二、示例描述三、操作步骤四、验证结果五、实现原理一、需求描述需求描述如下：需要在
阅读更多...
Java中ArrayList和LinkedList有什么区别举例详解

Java中ArrayList和LinkedList有什么区别举例详解

《Java中ArrayList和LinkedList有什么区别举例详解》：本文主要介绍Java中ArrayList和LinkedList区别的相关资料,包括数据结构特性、核心操作性能、内存与GC影... 目录一、底层数据结构二、核心操作性能对比三、内存与 GC 影响四、扩容机制五、线程安全与并发方案六、工程
阅读更多...
部署Vue项目到服务器后404错误的原因及解决方案

部署Vue项目到服务器后404错误的原因及解决方案

《部署Vue项目到服务器后404错误的原因及解决方案》文章介绍了Vue项目部署步骤以及404错误的解决方案,部署步骤包括构建项目、上传文件、配置Web服务器、重启Nginx和访问域名,404错误通常是... 目录一、vue项目部署步骤二、404错误原因及解决方案错误场景原因分析解决方案一、Vue项目部署步骤
阅读更多...
JavaScript中的reduce方法执行过程、使用场景及进阶用法

JavaScript中的reduce方法执行过程、使用场景及进阶用法

《JavaScript中的reduce方法执行过程、使用场景及进阶用法》：本文主要介绍JavaScript中的reduce方法执行过程、使用场景及进阶用法的相关资料,reduce是JavaScri... 目录1. 什么是reduce2. reduce语法2.1 语法2.2 参数说明3. reduce执行过程
阅读更多...
如何使用Java实现请求deepseek

如何使用Java实现请求deepseek

《如何使用Java实现请求deepseek》这篇文章主要为大家详细介绍了如何使用Java实现请求deepseek功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1.deepseek的api创建2.Java实现请求deepseek2.1 pom文件2.2 json转化文件2.2
阅读更多...
Java调用DeepSeek API的最佳实践及详细代码示例

Java调用DeepSeek API的最佳实践及详细代码示例

《Java调用DeepSeekAPI的最佳实践及详细代码示例》：本文主要介绍如何使用Java调用DeepSeekAPI,包括获取API密钥、添加HTTP客户端依赖、创建HTTP请求、处理响应、... 目录1. 获取API密钥2. 添加HTTP客户端依赖3. 创建HTTP请求4. 处理响应5. 错误处理6.
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2