基于消息队列实战部分内容，完成消息队列架构设计文档

【作业要求】1）基于模块 3 第 5 课备选架构 2“自研集群 + MySQL 存储”写出完整的架构设计文档 2）注意不是备选架构文档，而是最终落地的详细架构设计文档 3）细节部分自己尽量想一下实现方案，如果想不出来可以留着

【提示】

1. 架构设计文档是完整的文档（Word 或者语雀文档之类的都可以），而不是 PPT

2. 架构文档涵盖的内容请参考模块 3 第 4 课，详细架构设计主要内容参考模块 3 第 6 课

3. 课程 PPT 上的一些文字可以直接拷贝到文档中

4. 架构文档模板可以参考： https://xie.infoq.cn/article/a1c01e8f55c81b36a787f9f5b
   

前言

本文是游戏业务线消息队列中间件详细架构设计文档，用于指导消息队列后续的开发、测试和运维。

词汇表

Reactor: 网络编程模式

Netty: 开源的网络编程框架

1. 业务背景

[必选，从以下常见的角度来回答，你准备构建或者重构系统的目的和所处的位置是什么，可以是 1 个角度，也可以是多个角度，一般挑选重点的 3 个目的就差不多了：1.解决什么问题；2.带来什么价值；3.实现什么目标；4.完成什么任务；5.处于什么地位。

]

[样例：

随着前浪微博业务的不断发展，业务上拆分的子系统越来越多，目前系统间的调用都是同步调用，由此带来几个明显的系统问题：

• 性能问题：当用户发布了一条微博后，微博发布子系统需要同步调用“统计子系统”“审核子系统”“奖励子系统”等共 8 个子系统，性能很低。

• 耦合问题：当新增一个子系统时，例如如果要增加“广告子系统”，那么广告子系统需要开发新的接口给微博发布子系统调用。

• 效率问题：每个子系统提供的接口参数和实现都有一些细微的差别，导致每次都需要重新设计接口和联调接口，开发团队和测试团队花费了许多重复工作量。

基于以上背景，我们需要引入消息队列进行系统解耦，将目前的同步调用改为异步通知。

]

游戏业务发展很快，系统也越来越多，系统间协作的效率很低，例如：

【新版本发布了】

1. 游戏厂家更新游戏版本后，运营人员获取最新的游戏包，更新版本信息，然后上传包

到包管理系统打测试包，运营人员进行基本测试。运营子系统通知论坛有新的包将要

发布，进行预热；

2. 测试完成后，运营管理子系统要通知包管理系统进行打包；

3. 游戏准点正式发布的时候，运营子系统要通知 App、Web 站点等即时更新到新版本。

【玩家充钱了】

1. 玩家进行充值，充值完成后充值子系统通知 VIP 子系统；

2. VIP 子系统判断玩家等级，达到 VIP 后，等级子系统要通知福利子系统进行奖品发

放，要通知客服子系统安排专属服务人员，要通知商品子系统进行商品打折处理……

等级子系统的开发人员也是不胜其烦。

基于以上背景，我们需要引入消息队列进行系统解耦，将目前的同步调用改为异步通知。

[技巧：使用系统边界黑盒图来描述系统与外界的边界和交互关系]

2. 约束和限制

[必选，列出明确的约束和限制，常见的约束和限制有：1.投资方的成本要求；2. 监管方的监管要求；3. 技术选型的硬性要求；4. 项目时间要求；5. 质量要求]

[样例：

1.必须在 2021.06.30 号完成

2.成本不能超过 1000 万

3.数据库采用 Oracle

4.质量标准符合 ISO9001-XXXX 标准

]

[技巧：约束和限制越多越好]

1. 使用 Java 进行开发；

2. 开发平台是 Linux，数据库是 MySQL；

3. 投入人力 6 人，开发时间 3 个月；

3. 总体架构

[必选，描述经过备选架构决策后定下来的架构方案，这一章主要是描述架构的 3R：Rank、Role、Relation]

[技巧：1. 系统边界白盒图描述系统内的角色与外界的交互(Rank + Role + 外部 Relation)；2. 系统架构图来描述内部的 Role + 内部 Relation]

[注意：不建议一张图同时描述系统架构的 3R 以及与外界的交互，因为图太复杂，画系统边界白盒图的时候，系统内部的 Relation 可以不画]

系统边界白盒图

内部 Relation

3.1 架构分析

[可选，这部分主要是架构复杂度的分析，基本上从备选架构文档中提炼关键内容过来即可]

[样例：

3.1.1 高可用

对于微博子系统来说，如果消息丢了，导致没有审核，然后触犯了国家法律法规，则是非常严重的事情；对于等级子系统来说，如果用户达到相应等级后，系统没有给他奖品和专属服务，则 VIP 用户会很不满意，导致用户流失从而损失收入，虽然也比较关键，但没有审核子系统丢消息那么严重。

综合来看，消息队列需要高可用性，包括消息写入、消息存储、消息读取都需要保证高可用性。

]

[技巧：常见的复杂度都要覆盖到，即使分析后不涉及也要描述，避免评审的时候被人认为遗漏了关键点]

高可用：游戏版本发布和 VIP 充值，都是高优先级业务，需要保障可用性，如果消息丢了，对游戏上线发布，以及 VIP 用户的体验影响较大，导致用户流失而损失收入，因此优先级最高；

可维护性： 各种维护操作要方便，例如收发消息情况、权限控制、上下线等；

成本：开发投入人力和时间不能太长；

高性能：不需要，游戏新版本发布和 VIP 充值的消息并不多；

可扩展： 不需要，消息队列的功能基本明确，无需扩展。

3.2 总体架构

[必选，描述总体架构设计]

[样例：此处省略架构图，文字描述样例：

1）采用数据分散集群的架构，集群中的服务器进行分组，每个分组存储一部分消息数据。

2）每个分组包含一台主 MySQL 和一台备 MySQL，分组内主备数据复制，分组间数据不同步。

3）正常情况下，分组内的主服务器对外提供消息写入和消息读取服务，备服务器不对外提供服务；主服务 4）器宕机的情况下，备服务器对外提供消息读取的服务。

5）客户端采取轮询的策略写入和读取消息。

]

[技巧：

1.用系统架构图来描述架构，如果是前端或者客户端，用前端架构图或客户端架构图来描述架构

2.基于架构图中的内容，使用文字描述 Role、Relation 的基本内容，文档目录可以自由调整

]

【客户端 Role 设计】

1. 客户端采用 Java 语言开发，基于 Netty 实现与服务端交互

【服务器 Role 设计】

1. 服务器基于 Netty 开发，采用 Reactor 网络模型

2. 两台服务器组成一个 sharding，整个系统可以多个 sharding，每个

sharding 包含一主一从两台服务器（可以对比 MongoDB shard）

3. 主服务器提供消息读写操作，从服务器只提供消息读取操作

4. 服务器基于 ZooKeeper 进行主从切换

【客户端和服务器的 Relation 设计】

1. 客户端与服务端采用 TCP 连接，采用 Json 传递数据

2. 为了兼容非 Java 系统，服务端同时提供 HTTP 接口

【MySQL 的 Role 和 Relation 设计】

1. 采用 MySQL 主从同步

2. 每个消息队列对应一个表

3. 消息表最多存储 30 天内的消息，过期的自动清除

4. 直接用 MySQL 的主从复制来实现数据复制

服务器资源：

3 组 sharding，共 12 台服务器。

其中每组 sharding 包括：1 对主备消息队列服务器，1 对主备 MySQL 服务器。

【qisk：Role 和 Relation 还需要细化】

4. 详细设计

[必选，描述核心场景或者流程的实现机制]

4.1 核心功能

[必选，描述核心场景或者流程的实现机制，对应 4R 架构中的 Rule，每个核心场景一个小节]

[样例：

4.1.1 消息发送流程

4.1.2 消息消费流程

]

[技巧：使用系统序列图来描述 Rule，跟项目开发中写设计文档一样的写法]

4.1.1 消息发送流程

1. 消息队列系统设计两个角色：生产者和消费者，每个角色都有唯一的名称。

2. 消息队列系统提供 SDK 供各业务系统调用，SDK 从配置中读取所有消息队列系统的服务器信息，SDK 采取轮询算法发起消息写入请求给主服务器。

3. 如果某个主服务器无响应或者返回错误，SDK 将发起请求发送到下一台主服务，相当于在客户端实现了分片的功能

4.1.2 消息消费流程

1. 消息队列系统提供 SDK 供各业务系统调用，SDK 从配置中读取所有消息队列系统的服务器信息，轮流向所有服务器发起消息读取请求。

2. 消息队列服务器需要记录每个消费者的消费状态，即当前消费者已经读取到了哪条消息，当收到消息读取请求时，返回下一条未被读取的消息给消费者。

3. 默认情况下主服务器提供读写服务，当主服务器挂掉后，从服务器提供读消息服务

4.1.3 服务器主从切换

1. 同一组的主从服务器配置相同的 group 名称，在 ZooKeeper 建立对应的 PERSISENT 节点

2. 主从服务器启动后，在 ZooKeeper 对应的 group 节点下建立 EPHEMERAL 节点，名称分为为 master 和 slave

3. 从服务器 watch 主服务器的 master 节点状态，当 master 节点超时被删除后，从服务器接管读消息，收到客户端 SDK 的读消息请求后返回消息，收到客户端 SDK 的写请求直接拒绝。

4.2 关键设计

[必选，描述系统的一些关键设计点是如何实现和取舍的]

[样例（如果你有兴趣，可以对比一下 kafka 的文档：Kafka design）：

1）消息发送可靠性

业务服务器中嵌入消息队列系统提供的 SDK，SDK 支持轮询发送消息，当某个分组的主服务器无法发送消息时，SDK 挑选下一个分组主服务器重发消息，依次尝试所有主服务器直到发送成功；如果全部主服务器都无法发送，SDK 可以缓存消息，也可以直接丢弃消息，具体策略可以在启动 SDK 的时候通过配置指定。

如果 SDK 缓存了一些消息未发送，此时恰好业务服务器又重启，则所有缓存的消息将永久丢失，这种情况 SDK 不做处理，业务方需要针对某些非常关键的消息自己实现永久存储的功能。

2）消息存储可靠性

消息存储在 MySQL 中，每个分组有一主一备两台 MySQL 服务器，MySQL 服务器之间复制消息以保证消息存储高可用。如果主备间出现复制延迟，恰好此时 MySQL 主服务器宕机导致数据无法恢复，则部分消息会永久丢失，这种情况不做针对性设计，DBA 需要对主备间的复制延迟进行监控，当复制延迟超过 30 秒的时候需要及时告警并进行处理。

3）消息如何存储

每个消息队列对应一个 MySQL 表，消息队列名就是表名，表结构设计为……(此处请自行补充）

]

[技巧：常见的关键设计点包括高性能、高可用、可扩展、安全等]

3）消息如何存储

每个消息队列对应一个 MySQL 表，消息队列名就是表名，表结构设计为 Key-Value 键值对，以及该消息的生产者和消费者标识。字段设计考虑时，需要增加键值对的状态（已读取，未读取），标记下一个需要读取的键值对，以及键值对创建，读取的时间。并定期将已读取记录，存入备份表中。

4）消息读取可靠性

业务服务器中嵌入消息队列系统提供的 SDK，SDK 支持从主服务器中读取消息，当某个分组的主服务器无法发送消息时，SDK 挑选下一个分组主服务器读取消息，依次尝试所有主服务器直到读区成功。

当服务器向业务服务器回应消息后，设置消息的状态，并标识出下一个需要读取的消息。

如果消息一直未被读取如何处理呢？30 天后自动清除。

4.3 设计规范

[必选，描述 Role 和 Relation 相关的开发框架、连接协议、数据包格式等]

[样例：

1）消息队列服务器使用 Spring Boot + Netty 开发

2）MySQL 使用 Innodb 存储引擎

3）TCP 包的结构设计……（此处省略，请自行补充）

]

[技巧：如果某个规范涉及内容比较多，请独立章节描述，例如数据包格式定义]

没有相关经验，这里先不补充。

5. 质量设计

[必选，描述和质量相关的设计，包括：可测试性、可维护性、可观测性、成本等设计]

[样例：

5.1 消息队列管理后台

5.2 成本

]

[技巧：如果某个维度不涉及，也请在文档中说明，避免评审的时候被认为考虑不周全]

5.1 使用消息队列管理后台实现可维护性和可观测性：

可维护性：

（1）对消息队列服务器的状态进行管理和监测，使用配置表，管理消息队列服务器；

（2）对 MySQL 数据库服务器进行管理和检测；

（3）对消息队列进行权限管理。

可观测性：

（1）对每个消息队列中的消息数据，读写频率，流量等进行控制和监测。

5.2 成本：

一台消息队列管理后台服务器 + 一台 MySQL 数据库服务器；

6. 演进规划

[必选，可以是演进规划，也可以是项目计划，需要描述每个里程碑或者版本具体要实现的能力]

[样例：

6.1 消息队列一期

6.2 消息队列二期

]

[技巧：开发阶段快速迭代，小步快跑，但要基本完善后才能正式推出给其他人用]

6.1 消息队列一期：

使用一台主服务器，一台 MySQL 服务器，实现基础消息队列服务，支持消息读写，消息存储。

6.2 消息队列二期：

消息队列服务器加入从服务器，服务器基于 ZooKeeper 进行主从切换；

MySQL 服务器增加主备复制；

即实现一个 sharding 的完整功能。

6.3 消息队列三期：

支持多个 sharding，根据服务配置表切换不同的 sharding；

后台消息队列管理后台。