SSM(十) 项目重构-互联网项目的Maven结构

简介:

前言

很久没有更新博客了,之前定下周更逐渐成了月更。怎么感觉像我追过的一部动漫。 这个博文其实很早就想写了。 之前所有的代码都是在一个模块里面进行开发,这和maven的理念是完全不相符的,最近硬是抽了一个时间来对项目的结构进行了一次重构。

前言

很久没有更新博客了,之前定下周更逐渐成了月更。怎么感觉像我追过的一部动漫。 这个博文其实很早就想写了。 之前所有的代码都是在一个模块里面进行开发,这和maven的理念是完全不相符的,最近硬是抽了一个时间来对项目的结构进行了一次重构。

互联网项目的maven.jpg

先来看看这次重构之后的目录结构

1.jpg

为什么需要分模块

至于为什么要分模块呢?

我们设想一个这样的场景: 在现在的互联网开发中,会把一个很大的系统拆分成各个子系统用于降低他们之间的耦合度。

在一个子项目中通常都会为APIWEBService等模块。 而且当项目够大时,这些通常都不是一个人能完成的工作,需要一个团队来各司其职。

想象一下:当之前所有的项目都在一个模块的时候,A改动了API,需要Deploy代码。而B也改动了service的代码,但并没有完全做完。所以A在提交build的时候就会报错

而且在整个项目足够大的时候,这个build的时间也是很影响效率的。

但让我将各个模块之间分开之后效果就不一样了。我修改了API我就只需要管我的就行,不需要整个项目进行build

而且当有其他项目需要依赖我这个API的时候也只需要依赖API即可,不用整个项目都依赖过去。

各个模块的作用

来看下这次我所分的模块。

ROOT

这是整个项目的根节点。 先看一下其中的pom.xml


   
   
  1. <groupId>com.crossoverJie</groupId> 
  2.     <artifactId>SSM</artifactId> 
  3.     <packaging>pom</packaging> 
  4.     <version>2.0.0</version> 
  5.  
  6.     <modules> 
  7.         <module>SSM-API</module> 
  8.         <module>SSM-BOOT</module> 
  9.         <module>SSM-SERVICE</module> 
  10.         <module>SSM-WEB</module> 
  11.     </modules> 
  12.  
  13.     <properties> 
  14.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 
  15.         <spring.version>4.1.4.RELEASE</spring.version> 
  16.         <jackson.version>2.5.0</jackson.version> 
  17.         <lucene.version>6.0.1</lucene.version> 
  18.     </properties> 
  19.  
  20.  
  21.     <dependencyManagement> 
  22.  
  23.         <dependencies> 
  24.             <dependency> 
  25.                 <groupId>com.crossoverJie</groupId> 
  26.                 <artifactId>SSM-API</artifactId> 
  27.                 <version>2.0.0</version> 
  28.             </dependency> 
  29.          </dependencies> 
  30.     </dependencyManagement> 

我截取了其中比较重点的配置。

由于这是父节点,所以我的packag类型使用的是pom。 其中分别有着四个子模块。

其中重点看下<dependencyManagement>这个标签。 如果使用的是IDEA这个开发工具的话是可以看到如下图:

2.jpg

标红的有一个向下的箭头,点一下就可以进入子模块中相同的依赖。 这样子模块就不需要配置具体的版本了,统一由父模块来进行维护,对之后的版本升级也带来了好处。

SSM-API

接下来看下API这个模块:

通常这个模块都是用于定义外部接口的,以及改接口所依赖的一些DTO类。 一般这个模块都是拿来给其他项目进行依赖,并和本项目进行数据交互的。

SSM-BOOT

BOOT这个模块比较特殊。 可以看到这里没有任何代码,只有一个rpc的配置文件。 通常这个模块是用于给我们内部项目进行依赖的,并不像上面的API模块一样给其他部门或者是项目进行依赖的。

因为在我们的RPC调用的时候,用dubbo来举例,是需要配置所依赖的consumer

但如果是我们自己内部调用的话我们就可以把需要调用自己的dubbo服务提供者配置在这里,这样的话我们自己调用就只需要依赖这个BOOT就可以进行调用了。

哦对了,BOOT同时还会依赖API,这样才实现了只依赖BOOT就可以调用自己内部的dubbo服务了。 如下所示:


   
   
  1. <dependencies> 
  2.         <dependency> 
  3.             <groupId>junit</groupId> 
  4.             <artifactId>junit</artifactId> 
  5.             <scope>test</scope> 
  6.         </dependency> 
  7.  
  8.         <dependency> 
  9.             <groupId>com.crossoverJie</groupId> 
  10.             <artifactId>SSM-API</artifactId> 
  11.         </dependency> 
  12.  
  13.     </dependencies> 

SSM-SERVICE

SERVICE模块就比较好理解了。 是处理具体业务逻辑的地方,也是对之前的API的实现。

通常这也是一个web模块,所以我的pom类型是WAR

SSM-WEB

其实WEB模块和SERVICE模块有点重合了。通常来说这个模块一般在一个对外提供http访问接口的项目中。

这里只是为了展示项目结构,所以也写在了这里。

他的作用和service差不多,都是WAR的类型。

总结

这次没有实现什么特别的功能,只是对一些还没有接触过这种项目结构开发的童鞋能起到一些引导作用。

具体源码还请关注我的github

项目地址:https://github.com/crossoverJie/SSM.git

个人博客地址:http://crossoverjie.top

GitHub地址:https://github.com/crossoverJie

先来看看这次重构之后的目录结构

1.jpg

为什么需要分模块

至于为什么要分模块呢?

我们设想一个这样的场景: 在现在的互联网开发中,会把一个很大的系统拆分成各个子系统用于降低他们之间的耦合度。

在一个子项目中通常都会为APIWEBService等模块。 而且当项目够大时,这些通常都不是一个人能完成的工作,需要一个团队来各司其职。

想象一下:当之前所有的项目都在一个模块的时候,A改动了API,需要Deploy代码。而B也改动了service的代码,但并没有完全做完。所以A在提交build的时候就会报错

而且在整个项目足够大的时候,这个build的时间也是很影响效率的。

但让我将各个模块之间分开之后效果就不一样了。我修改了API我就只需要管我的就行,不需要整个项目进行build

而且当有其他项目需要依赖我这个API的时候也只需要依赖API即可,不用整个项目都依赖过去。

各个模块的作用

来看下这次我所分的模块。

ROOT

这是整个项目的根节点。 先看一下其中的pom.xml

<groupId>com.crossoverJie</groupId>     <artifactId>SSM</artifactId>     <packaging>pom</packaging>     <version>2.0.0</version>      <modules>         <module>SSM-API</module>         <module>SSM-BOOT</module>         <module>SSM-SERVICE</module>         <module>SSM-WEB</module>     </modules>      <properties>         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>         <spring.version>4.1.4.RELEASE</spring.version>         <jackson.version>2.5.0</jackson.version>         <lucene.version>6.0.1</lucene.version>     </properties>       <dependencyManagement>          <dependencies>             <dependency>                 <groupId>com.crossoverJie</groupId>                 <artifactId>SSM-API</artifactId>                 <version>2.0.0</version>             </dependency>          </dependencies>     </dependencyManagement> 

我截取了其中比较重点的配置。

由于这是父节点,所以我的packag类型使用的是pom。 其中分别有着四个子模块。

其中重点看下<dependencyManagement>这个标签。 如果使用的是IDEA这个开发工具的话是可以看到如下图:

2.jpg

标红的有一个向下的箭头,点一下就可以进入子模块中相同的依赖。 这样子模块就不需要配置具体的版本了,统一由父模块来进行维护,对之后的版本升级也带来了好处。

SSM-API

接下来看下API这个模块:

通常这个模块都是用于定义外部接口的,以及改接口所依赖的一些DTO类。 一般这个模块都是拿来给其他项目进行依赖,并和本项目进行数据交互的。

SSM-BOOT

BOOT这个模块比较特殊。 可以看到这里没有任何代码,只有一个rpc的配置文件。 通常这个模块是用于给我们内部项目进行依赖的,并不像上面的API模块一样给其他部门或者是项目进行依赖的。

因为在我们的RPC调用的时候,用dubbo来举例,是需要配置所依赖的consumer

但如果是我们自己内部调用的话我们就可以把需要调用自己的dubbo服务提供者配置在这里,这样的话我们自己调用就只需要依赖这个BOOT就可以进行调用了。

哦对了,BOOT同时还会依赖API,这样才实现了只依赖BOOT就可以调用自己内部的dubbo服务了。 如下所示:

    <dependencies>         <dependency>             <groupId>junit</groupId>             <artifactId>junit</artifactId>             <scope>test</scope>         </dependency>          <dependency>             <groupId>com.crossoverJie</groupId>             <artifactId>SSM-API</artifactId>         </dependency>      </dependencies> 

SSM-SERVICE

SERVICE模块就比较好理解了。 是处理具体业务逻辑的地方,也是对之前的API的实现。

通常这也是一个web模块,所以我的pom类型是WAR

SSM-WEB

其实WEB模块和SERVICE模块有点重合了。通常来说这个模块一般在一个对外提供http访问接口的项目中。

这里只是为了展示项目结构,所以也写在了这里。

他的作用和service差不多,都是WAR的类型。

总结

这次没有实现什么特别的功能,只是对一些还没有接触过这种项目结构开发的童鞋能起到一些引导作用。


作者:crossoverJie

来源:51CTO

相关文章
|
5月前
|
Java 区块链 Maven
关于引入maven项目后出现‘parent.relativePath’ of POM错误时的解决方法
关于引入maven项目后出现‘parent.relativePath’ of POM错误时的解决方法
502 3
|
4月前
|
Java jenkins 应用服务中间件
结合Jenkins与Tomcat,实施Maven项目的自动构建和部署流程。
任何项目构建和部署的自动化流程,总离不开对各个环节精细把控与密切配合。涉及到源代码管理、构建工具、持续集成服务器以及最终的运行时环境的协调。通过上述简洁实用的步骤,可以实现Maven项目从源代码到运行状态的无缝过渡,进而提升软件开发的效率与质量。
302 0
|
Java Maven 开发者
maven项目中官方setting.xml文件
`settings.xml` 是 Maven 的配置文件,用于定义用户或全局级别的构建行为。它包含本地仓库路径、网络代理、服务器认证、仓库镜像及构建配置文件等设置,帮助开发者根据环境定制 Maven 行为,提升构建效率与灵活性。
980 0
|
7月前
|
Java 测试技术 项目管理
【JavaEE】从 0 到 1 掌握 Maven 构建 Java 项目核心技巧 解锁 Java 项目高效管理实用实例
本文从Maven基础概念讲起,涵盖安装配置、核心概念(如POM与依赖管理)及优化技巧。结合Java Web项目实例,演示如何用Maven构建和管理项目,解决常见问题,助你高效掌握这一强大工具,提升Java开发与项目管理能力。适合初学者及进阶开发者学习。资源链接:[点此获取](https://pan.quark.cn/s/14fcf913bae6)。
259 6
|
XML Java 测试技术
从零开始学 Maven:简化 Java 项目的构建与管理
Maven 是一个由 Apache 软件基金会开发的项目管理和构建自动化工具。它主要用在 Java 项目中,但也可以用于其他类型的项目。
634 1
从零开始学 Maven:简化 Java 项目的构建与管理
|
Java Maven
解决idea每次新建maven项目都需要重新配置maven的问题
解决idea每次新建maven项目都需要重新配置maven的问题
504 1
|
Java 关系型数据库 MySQL
Maven——创建 Spring Boot项目
Maven 是一个项目管理工具,通过配置 `pom.xml` 文件自动获取所需的 jar 包,简化了项目的构建和管理过程。其核心功能包括项目构建和依赖管理,支持创建、编译、测试、打包和发布项目。Maven 仓库分为本地仓库和远程仓库,远程仓库包括中央仓库、私服和其他公共库。此外,文档还介绍了如何创建第一个 SpringBoot 项目并实现简单的 HTTP 请求响应。
995 1
Maven——创建 Spring Boot项目
|
Java 关系型数据库 MySQL
如何使用 maven 创建一个 Spring Boot项目
Maven 是一个强大的项目管理工具,通过配置 `pom.xml` 文件自动获取所需的 jar 包,提高开发效率。其核心功能包括项目构建和依赖管理。项目构建支持编译、测试、打包和发布等流程,而依赖管理则通过中央仓库、本地仓库和私有服务器获取和管理项目依赖。示例中展示了如何创建第一个 SpringBoot 项目并实现简单接口。
405 1
如何使用 maven 创建一个 Spring Boot项目
|
Java Maven Kotlin
idea maven创建kotlin项目
本文介绍了在IntelliJ IDEA中使用Maven创建Kotlin项目的步骤,包括在`pom.xml`文件中添加Maven中央仓库、配置`kotlin-maven-plugin`插件、指定源目录、添加测试插件和执行插件,以及添加Kotlin测试依赖和标准库依赖。文中还提到了如何通过更换镜像或使用代理来解决依赖下载速度慢的问题,并展示了运行示例代码的截图。
759 4
idea maven创建kotlin项目
|
Java Maven Android开发
eclipse创建maven项目
本文介绍了在Eclipse中创建Maven项目的步骤,包括打开Eclipse、选择Java项目、完成项目创建以及自动下载插件的过程。
346 2
eclipse创建maven项目

推荐镜像

更多