从代码组织看团队治理之案例一

阿里云产品限时红包,最高 ¥1888 元,立即领取

微服务代码组织

这是一张打满马赛克的图。

嗯,把你的思绪拉回来先。我来介绍下团队的一些简单背景。

我们部门在基于 spring cloud 做微服务的实践。业务上在公司内部相对独立,部门内部有几个团队负责不同的项目。在部门内部希望生产的代码等可以跨几个团队共用,以满足不同项目快速开发的需求。

开头的图片展示的是其中一个团队目前代码的组织方式。

  • xxxx-yyyy-config 项目是分布式配置中心。
  • xxxx-yyyy-zuul 项目是 API 网关。
  • xxxx-yyyy-eureka 项目是服务注册中心。
  • xxxx-yyyy-fileupload、xxxx-yyyy-workflow 等是提供特定功能的微服务。
  • xxxx-yyyy-common 项目,从命名上来看,是一个提供公共功能的服务。在其中 xxxx.yyyy.common.feign 包下聚合了其他微服务所实现能力的声明。

在一个团队内部,这样的设计具有一定的合理性。

将这个团队作为一个内聚的单元,通过 common 项目来聚合内部各个微服务提供的能力,统一暴露,很好的使用了一个外观模式。外部不必关心内部实现细节,只需专注在接口上。对内部来讲,各个服务的能力汇总到 common 中,便于管理。

但是,请回顾一下之前我提到的团队的背景。这个团队只是部门中的一个,其生产的代码需要能在部门中共享与复用。

这时的 common 项目却对部门其他团队关上了门。纵然这个团队生产的多数代码可以通过复制的形式减少其他团队的工作量,但由于 common 包含了众多这个团队业务本身的东西,在其他团队中使用时必定需要做较大的调整。

是时候打破 common 这扇门了,让门内已有的微服务走入到其他团队中。那该怎么做呢?

每个微服务对外声明自己的能力,不聚合在 common 中。每个微服务独立维护。内部负责实现自己对外声明的能力,外部使用微服务声明能力的接口。调整一下代码的组织,实例如下:

1
2
3
|- xxx-yyy-zzz                       // 主项目
|- xxx-yyy-zzz-api // 子项目,负责声明微服务提供的能力,Feign 接口
|- xxx-yyy-zzz-service // 实现微服务对外承诺的能力

如上面代码块中的显示,api 子项目负责声明微服务提供的能力,以 Feign 接口的形式暴露,可以独立打包为 jar,并需要的项目引用。service 子项目负责实现微服务声明的能力。

这样,每个微服务成为高内聚的单元,可以供其他团队复用。微服务的维护人员,不必局限在原来小团队中,而是放眼整个部门,同时专注维护微服务本身。在团队治理上,也打破了原来几个团队之间的无形屏障。