SpringBoot开发——Maven多模块工程最佳实践及详细示例

devtools/2024/11/27 3:26:58/

文章目录

  • 一、前言
  • 二、Maven多模块工程的最佳实践
    • 1、项目结构清晰
    • 2、依赖管理统一
    • 3、插件配置统一
    • 4、版本控制一致
    • 5、模块间通信简化
  • 三、详细示例
    • 1、项目结构
    • 2、父模块(parent)的pom.xml文件
    • 3、子模块(module-api)的pom.xml文件
    • 4、模块间依赖示例
  • 四、关于${project.version}

一、前言

在大型软件开发项目中,项目模块的划分和管理至关重要。Maven多模块项目架构是一种高效的项目组织方式,通过将项目划分为多个模块,每个模块负责一个特定的功能,可以提高项目的可维护性和可扩展性。本文将详细介绍Maven多模块工程组织的最佳实践,并给出一个详细示例。

二、Maven多模块工程的最佳实践

1、项目结构清晰

  • 项目应该按照功能、业务或技术划分模块,每个模块应该有明确的职责和边界,避免功能交叉或耦合过度。
  • 项目根目录下通常包含一个父模块(parent),管理整个项目的构建、依赖和版本控制,以及多个子模块(module),每个子模块负责一个具体的功能。

2、依赖管理统一

  • 在父模块的pom.xml文件中,通过<dependencyManagement>标签统一声明所有子模块需要的依赖及其版本号,子模块通过继承父模块来简化依赖配置。
  • 子模块可以通过<dependencies>标签添加自己特有的依赖,无需重复声明版本号。

3、插件配置统一

  • 父模块统一管理构建插件及其配置,确保所有子模块使用相同的构建流程。
  • 子模块可以根据需要添加额外的插件或覆盖父模块的插件配置。

4、版本控制一致

  • 父模块中定义项目的全局版本号,子模块继承父模块的版本号,确保整个项目的一致性。
  • 通过<properties>标签定义项目属性,如Java版本Spring版本等,子模块可以直接引用这些属性。

5、模块间通信简化

  • 使用Maven的模块间依赖机制,子模块可以直接引用其他子模块的代码和资源,简化模块间的通信和协作。
  • 通过合理定义和使用模块间的依赖关系,确保模块间的正确交互和协作。

三、详细示例

假设我们有一个多模块项目,包含以下模块:

  • parent(父模块)
  • module-api(API模块)
  • module-service(服务模块)
  • module-web(Web模块)

1、项目结构

项目结构如下:

my-multimodule-project/
|-- parent/
|   |-- pom.xml
|-- module-api/
|   |-- pom.xml
|-- module-service/
|   |-- pom.xml
|-- module-web/|-- pom.xml

2、父模块(parent)的pom.xml文件

  • 在父模块的pom.xml文件中,定义groupIdartifactIdversion
  • 使用<packaging>pom</packaging>来指定这是一个聚合项目(即多模块项目)。
  • <modules>标签中列出所有子模块。
<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><groupId>com.example</groupId><artifactId>my-multimodule-project</artifactId><version>1.0-SNAPSHOT</version><packaging>pom</packaging><modules><module>module-api</module><module>module-service</module><module>module-web</module></modules><properties><java.version>1.8</java.version><spring.version>5.3.10</spring.version></properties><dependencyManagement><dependencies><dependency><groupId>org.springframework</groupId><artifactId>spring-core</artifactId><version>${spring.version}</version></dependency><!-- 其他依赖 --></dependencies></dependencyManagement><build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.8.1</version><configuration><source>${java.version}</source><target>${java.version}</target></configuration></plugin><!-- 其他插件 --></plugins></build>
</project>

3、子模块(module-api)的pom.xml文件

  • 在每个子模块的pom.xml文件中,使用<parent>标签来指定父模块。
  • <parent>标签中,不需要重复定义groupIdversion,因为Maven会自动从父模块中继承这些值。
  • 只需要指定父模块的groupIdartifactIdrelativePath(如果父模块不在默认位置)。
<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><artifactId>module-api</artifactId><packaging>jar</packaging><parent><groupId>com.example</groupId><artifactId>my-multimodule-project</artifactId><version>1.0-SNAPSHOT</version><!-- 如果父模块不在默认位置,可以指定relativePath -->  <!-- <relativePath>../parent/pom.xml</relativePath> -->  </parent><dependencies><dependency><groupId>org.springframework</groupId><artifactId>spring-core</artifactId></dependency><!-- 其他依赖 --></dependencies>
</project>

4、模块间依赖示例

假设module-service模块依赖于module-api模块,可以在module-servicepom.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.example</groupId>  <artifactId>my-multimodule-project</artifactId>  <version>1.0-SNAPSHOT</version>  <!-- 如果父模块不在默认位置,可以指定relativePath -->  <!-- <relativePath>../parent/pom.xml</relativePath> -->  </parent>  <artifactId>module-service</artifactId>  <packaging>jar</packaging>  <!-- 子模块特有的配置,如依赖、插件等 -->  <dependencies>  <dependency>  <groupId>com.example</groupId>  <artifactId>module-api</artifactId>  <version>${project.version}</version> <!-- 使用${project.version}来引用父模块的version -->  </dependency>  <!-- 这里可以添加其他依赖 -->  </dependencies>  
</project>

在上面的示例中,module-apimodule-service子模块都通过<parent>标签继承了父模块my-multimodule-projectgroupIdversion。这样,你就不需要在每个子模块中重复这些值了。通过上述配置,我们实现了一个清晰、可维护的Maven多模块项目结构。每个模块都有明确的职责和边界,依赖关系通过父模块统一管理,插件配置和版本控制也保持一致。这种项目组织方式有助于提高开发效率,降低维护成本,并方便后续扩展和升级。

四、关于${project.version}

Maven项目中,${project.version} 是一个内置的Maven属性,它代表了当前项目的版本号。这个属性是在Maven解析pom.xml文件时自动设置的,因此你不需要手动定义它。

当你使用${project.version}时,Maven会用当前项目的版本号来替换这个占位符。这个版本号通常是在项目的pom.xml文件的<version>标签中定义的。

在多模块项目中,如果子模块通过<parent>标签继承了父模块的版本号,那么子模块中的${project.version}将会解析为父模块中定义的版本号(前提是子模块没有覆盖这个版本号)。这是因为Maven在解析子模块的pom.xml时,会首先解析父模块的pom.xml,并将父模块中的信息(包括版本号)传递给子模块。

举个例子,如果你有一个父模块parent-pom,它的版本号是1.0.0,并且有一个子模块child-module,子模块的pom.xml中通过<parent>标签继承了父模块的版本号,那么在子模块的pom.xml中使用${project.version}时,它会被解析为1.0.0。

需要注意的是,虽然${project.version}在大多数情况下都很有用,但在某些情况下(比如父模块和子模块需要不同的版本号时),你可能需要在子模块中显式地定义版本号,而不是使用继承的版本号。此外,如果你在一个模块中引用了另一个模块作为依赖,并且希望确保它们使用相同的版本号,那么使用${project.version}是一个很好的做法,因为它可以确保版本的一致性。


http://www.ppmy.cn/devtools/137290.html

相关文章

html渲染优先级

HTML元素的渲染优先级通常由以下因素决定&#xff1a; 1.显示方式&#xff1a;块级元素比如 <div> 会自动开始一个新行&#xff0c;而内联元素比如 <span> 则不会。 可编辑性&#xff1a;某些元素默认是不可编辑的&#xff0c;而其他元素可能是可编辑的&#xff…

Redis Key 命名规范文档

开发过程中为确保 Redis 键名的一致性、可读性和易维护性&#xff0c;本规范旨在指导开发团队在使用 Redis 时设计合理的键名格式。 1. 命名格式 采用 模块:子模块:业务描述:标识 的分层格式&#xff0c;明确数据来源和用途。 层次清晰&#xff1a;从全局到具体逐步细化。唯一…

【Vue3 for beginner】普通插槽、具名插槽、作用域插槽

&#x1f308;Don’t worry , just coding! 内耗与overthinking只会削弱你的精力&#xff0c;虚度你的光阴&#xff0c;每天迈出一小步&#xff0c;回头时发现已经走了很远。 &#x1f4d7;插槽 在 Vue 3 中&#xff0c;插槽&#xff08;Slots&#xff09;是一个强大的功能&am…

【软考速通笔记】系统架构设计师③——信息安全技术基础知识

文章目录 一、前言二、信息安全基础知识2.1 信息安全的基本要求2.2 信息安全的范围2.3 网络安全表现2.4 安全措施包括 三、信息安全系统的组成框架3.1 技术体系&#xff1a;3.2 组织机构体系&#xff1a;3.3 管理体系 四、信息加解密技术4.1 对称密钥加密算法4.2 非对称密钥加密…

【强化学习的数学原理】第02课-贝尔曼公式-笔记

学习资料&#xff1a;bilibili 西湖大学赵世钰老师的【强化学习的数学原理】课程。链接&#xff1a;强化学习的数学原理 西湖大学 赵世钰 文章目录 一、为什么return重要&#xff1f;如何计算return&#xff1f;二、state value的定义三、Bellman公式的详细推导四、公式向量形式…

node.js fluent-ffmpeg 桌面推流

1&#xff0c;安装fluent-ffmpeg&#xff0c;npm install fluent-ffmpeg 2&#xff0c;推流代码&#xff1a; //stream.js const ffmpeg require(fluent-ffmpeg); const rtmpUrl "rtmp://localhost:1935/live/desktop"; //ffmpeg -f gdigrab -i desktop -vcode…

Axure PR 9 二级滑动选择器 设计交互

​大家好&#xff0c;我是大明同学。 这期内容&#xff0c;我们来探讨Axure中二级滑动选择器设计与交互技巧。 二级滑动选择器 创建滑动选择器所需的元件 1.在元件库中拖出两个中继器元件。 2.选中中继器元件&#xff0c;样式窗格中分别命名&#xff0c;“左边&#xff0c;…

裸金属服务器能够帮助企业解决哪些问题?

随着网络科技的快速发展&#xff0c;企业业务也在不断的进行扩张和复杂化&#xff0c;传统的服务已经无法满足企业对于高性能和高稳定性的需求&#xff0c;而裸金属服务器则能够帮助企业来解决这一问题&#xff0c;下面我们就来具体看一下吧&#xff01; 裸金属服务器能够允许应…