微服务规约

概述

一个微服务平台由多个模块组成,我们经过长期实践总结出一套各模块的命名规范。

微服务架构

架构

工程目录

工程结构

模块名称说明
macula-samples-parent父工程,定义maven依赖
macula-samples-gateway微服务网关
macula-samples-admin-bff管理控制台的API,聚合微服务层的接口,不会作为微服务给其他模块访问
macula-samples-openapi给第三方平台访问的开放API
macula-samples-xxx-bff其他前端的API层,不同前端不同的BFF模块
macula-samples-basic微服务模块,用于基础的服务,可选项
macula-samples-thirdparty微服务模块,用于集中访问第三方系统,防腐
macula-samples-[service1]…具体各个业务的微服务模块,按照领域命名
macula-samples-api微服务模块的对外SDK,其中定义了其他模块访问该模块的接口以及POJO类。
macula-samples-basic-apibasic模块的sdk
macula-samples-[service1]-api[service1]模块的sdk