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

开发 项目管理
这个博文其实很早就想写了。 之前所有的代码都是在一个模块里面进行开发,这和maven的理念是完全不相符的,最近硬是抽了一个时间来对项目的结构进行了一次重构。

前言

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

前言

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

[[184668]]

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

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的类型。

总结

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

具体源码还请关注我的github

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

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

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

责任编辑:张燕妮 来源: 开源中国社区
相关推荐

2021-01-14 11:05:41

项目配置属性

2011-06-03 09:59:52

移动互联网项目合作峰会移动互联网即将召开

2015-06-24 15:35:54

2015-12-14 17:50:09

ENI经济和信息化网

2017-07-07 16:07:41

2018-01-15 14:42:51

大数据互联网微信

2012-12-31 12:45:15

2012移动互联网

2010-08-31 11:31:21

2017-03-15 09:00:22

互联网易货郎零售

2015-05-28 16:11:07

互联网+

2014-01-15 14:35:35

云计算

2021-07-12 08:53:21

互联网 行业数据

2009-12-07 09:32:40

2015-10-08 15:20:34

互联网物联网

2014-10-21 17:43:57

2015-05-21 18:33:01

微软奥的斯

2016-07-18 18:47:07

互联网+

2022-02-28 08:23:02

开源项目重构

2015-10-30 17:50:18

互联网金融

2018-08-15 09:02:59

产业互联网工业互联网物联网
点赞
收藏

51CTO技术栈公众号