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