1. 业务背景

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

]

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

学生管理系统主要解决学生在校期间的生活和学习课程等一系列行为的统一的数据管理。

整个系统功能模块分为：学生管理，课程管理，权限管理三个模块。权限管理模块规定了可以使用前两个模块的角色。学生管理模块和课程模块之间主要通过数据库和 MQ 进行数据交互。

同时系统还需要 NGINX 进行网络隔离，以及风控模块确保数据安全。

2. 约束和限制

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

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

整个系统采用 SpringBoot 框架为基础，Java 作为主要开发语言进行开发。数据库采用 MySQL。要求两位后端开发，一位前端开发全职参与，开发周期为 2 个月。同时要求一位产品进行需求的沟通，一位 QA 对系统质量进行测试和保障。后续维护需要投入 2 位开发，兼职进行维护。维护周期为一年。

3. 总体架构

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

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

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

因为学校一般是由校园内网和外网进行隔离，所以使用 NGINX 进行内外网隔离。通过 Nginx 后需要通过风控模块对请求和数据流进行拦截，阻拦不正常的行为。

学生模块负责管理学生的在校期间的日常生活，包括住宿信息，餐饮信息，图书馆借阅信息等。

课程模块负责学生的选课，成绩，以及实验和毕业等信息。

权限模块通过为学生分配不同的角色来进行资源访问控制。

因为是学校内部系统，而且进行的是学生日常和课程管理，所以只会有几个功能会在偶尔出现高 QPS 的情况，比如选课系统，成绩查询系统等。在这些系统的入口需要有流量控制的能力，并且避免慢 SQL 和实时复杂处理逻辑的出现。

数据库采用主从设置。学生数据安全是该系统最重要的部分。从数据库根据 bin log 进行数据更新，同时每天要进行数据和日志的增量备份。

4. 详细设计

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

4.1 核心功能

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

[样例：

4.1.1 消息发送流程

4.1.2 消息消费流程

]

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

4.2 关键设计

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

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

1）消息发送可靠性

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

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

2）消息存储可靠性

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

3）消息如何存储

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

]

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

4.3 设计规范

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

[样例：

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

2）MySQL 使用 Innodb 存储引擎

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

]

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

5. 质量设计

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

[样例：

5.1 消息队列管理后台

5.2 成本

]

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

6. 演进规划

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

[样例：

6.1 消息队列一期

6.2 消息队列二期

]

队列一期主要用 kafka 起到学校学生与课程服务的解耦，

二期拆分不同的 partition 保证消息的顺序性