微服务工程文档规范

微服务工程介绍

工作中人员流动难以避免，为了保证服务的可传承以及新员工的上手速度，特总结了此文档规范。

微服务介绍微服务介绍主要包括：

• 这个微服务是做什么的，负责哪些业务，在整个系统中所处的位置
• 微服务的坐标 （maven ）
• 微服务的主要负责人

微服务的基本结构（架构）

1. 技术架构图
   描述出当前微服务使用的中间件，如mongo、redis 等，开发框架，如 Springboot 、feign 等

2. 业务架构图

   1. 列出有哪些业务功能模块
   2. 列出服务使用方，数据的入口、出口

开发方式

描述出新增一些内容的修改方式，比如新增一个资源应该怎么改，修改某一个资源应该怎么改。
包括以下内容

1. 代码中关键的包职责，代码规范中的不在描述，新增的包需要描述清楚
2. 代码中关键的类职责，只需要知道类名，做什么即可，细节不在描述
   3.1 一些关键接口在处理那一类逻辑的时候要实现这个接口，具体的方法在类的注释中即可
   3.2 列出常用的到的一些常量类，工具类等

3. 代码中用到的一些约定

   1. 命名规则
   2. 特殊的开发分支规范（如mgcard 项目）
   3. 通过aop 实现的一些逻辑，描述出切面规则

例如： 对于column 、resource 来说 新模块的添加方式，需要具体到某一个类，某一个接口，分别实现哪些方法
对于bmw、alchmyfurnace 来说，需要描述出如何添加一个converter、添加一个接口的流程

---

• 分类： 架构设计
• 标签： 无标签