Spring Cloud工程模块划分

Stella981
• 阅读 760

Spring Cloud工程模块划分


现在网络上都在讲Spring Cloud的各个组件,但当我们自己也把Spring Cloud引入进来的时候,却发现第一个要解决的问题是:

工程的模块如何划分

在之前我写过一篇重构购物车的过程的文章,下面就以这个购物车工程,来说明当时我是如何思考和如何做的。


工程要分几个模块


API模块


当时的购物车工程是基于Spring Cloud搭建的,并对外暴露Resful接口。那么第一个要思考的问题是,调用方如何使用购物车的微服务接口呢。有一种方式是由服务提供方生成一个SDK包,调用方引入SDK直接使用。这种方式目前应该是主流的做法,我个人也比较推崇这种方式。

因此,在工程里,我们应该有个API工程,这个工程定义了所有的微服务接口,然后可以使用一些构建工具,生成一个SDK包。

shopcart-api

这个API工程只有两样东西,一个是微服务接口,另外一个是DTO对象。可以用package来区分。

shopcart-api
     api  //包名
     dto  //包名

API包里可以用interface定义出所有的微服务接口。

public interface ShopCartApi {
    @RequestMapping(value = "/addToCart", method = RequestMethod.POST)
    ResponseDTO addToCart(@RequestBody(required = false) AddToCartDTO request) throws Exception;
    
    //其他接口
}

至于DTO,是用于网络传输的对象。当我们想提供微服务接口的时候,首先要考虑的就是入参和出参。一般来说可以用DTO来表示的,所有DTO对象都必须以DTO结尾。这些DTO会以SDK包的形式,被调用方使用,调用方也必须将自己的业务数据封装成DTO入参,然后才能调用后端的微服务接口。

后面我们只需要使用Maven或者Gradle,构建一个SDK包出来即可。如果是使用Maven,那么组合使用

mvn clean install
mvn clean deploy

就可以生成SDK包,并且上传到公司的Maven私服上了。


server工程


server工程用于存放controller的,是实际对外的resful微服务接口。

shopcart-server

server工程必须依赖api工程,并去实现API工程定义的微服务接口。

@RestController
public class ShopCartController implements ShopCartApi {
    @Override
    public ResponseDTO addSkuToShopCart(@RequestBody AddToCartDTO request) throws Exception {
        return null;
    }
}

这里的ShopCartApi就是之前在API工程里面定义的interface。那么server工程里的微服务接口可以直接去实现复杂的业务逻辑吗?还是说再抽取一个模块出来,专门用于实现业务逻辑呢?有一些公司,直接就在server工程里实现复杂的业务逻辑,然后用一个service包,将业务逻辑servce类放入进去。理由是,再抽取一个service模块用处不大呀,又无需用它来单独build一个包,供外部使用。其实这样做也没啥问题,但是通常来说,业务逻辑实现类,最好还是单独抽取成一个模块,除了层次清晰一些之外,业务逻辑实现类还有另外一些职责,就是【稳定】【灵活】【通用】【易于测试】,是需要精心设计的,建议别跟controller混在一个模块里。

随着业务不断的增多,server工程里的controller接口会不断的增多和变化,但是经过精心设计的业务逻辑层,却未必。


service工程


shopcart-service

如上所说,建议再建立一个service工程,将核心的业务逻辑封装起来。service层对外暴露的对象是业务对象,统一以BO结尾。这里就会有个问题,server工程调用完service层的接口,获取到BO对象后,需要转换成DTO对象。不过现在已经有非常成熟性能又好的映射工具了。orika就是其中的佼佼者。


模块之间的依赖


server工程依赖api工程和service工程。


需要再搞个domain模块吗


我理解的domain也属于业务逻辑的一部分,我个人是不太喜欢再搞个domain模块的,直接将domain放置在service模块里即可。


客户端如何调用服务端


在Spring Cloud里,可以借助feign

@FeignClient(value = "xxxxx",path = "/yyyyy")
public interface ShopCartClient extends ShopCartApi {
    
}

这里的ShopCartApi就是购物车工程中api模块的接口类。想要调用购物车的接口,直接使用ShopCartClient类即可。


使用领域驱动设计来划分模块


也有些公司,使用领域驱动设计来划分模块,这块我目前还不太熟悉,不过看起来挺高大上的,也希望网友在文章的评论里,多多发表意见。


原文链接


Spring Cloud工程模块划分

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
3个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Stella981 Stella981
3年前
Python之time模块的时间戳、时间字符串格式化与转换
Python处理时间和时间戳的内置模块就有time,和datetime两个,本文先说time模块。关于时间戳的几个概念时间戳,根据1970年1月1日00:00:00开始按秒计算的偏移量。时间元组(struct_time),包含9个元素。 time.struct_time(tm_y
Easter79 Easter79
3年前
Twitter的分布式自增ID算法snowflake (Java版)
概述分布式系统中,有一些需要使用全局唯一ID的场景,这种时候为了防止ID冲突可以使用36位的UUID,但是UUID有一些缺点,首先他相对比较长,另外UUID一般是无序的。有些时候我们希望能使用一种简单一些的ID,并且希望ID能够按照时间有序生成。而twitter的snowflake解决了这种需求,最初Twitter把存储系统从MySQL迁移
Wesley13 Wesley13
3年前
Java日期时间API系列36
  十二时辰,古代劳动人民把一昼夜划分成十二个时段,每一个时段叫一个时辰。二十四小时和十二时辰对照表:时辰时间24时制子时深夜11:00凌晨01:0023:0001:00丑时上午01:00上午03:0001:0003:00寅时上午03:00上午0
Wesley13 Wesley13
3年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
9个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这