前言

本文是外包学生管理系统的架构文档，用于指导学生管理系统的后续开发、测试和运维。

[可选，用于总体上描述本篇文档的内容和目的]

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

词汇表

Nginx: 是一个高性能的 HTTP 和反向代理 web 服务器，此架构中用于实现业务服务器的负载均衡与请求路由分发。

MySQL：MySQL 是最流行的关系型数据库管理系统之一，此架构中用于存储业务数据。

ECS：指云服务器 ECS，可弹性扩展、安全、稳定、易用的计算服务。

1. 业务背景

随着学校的规模的不断扩大，学生数量的增加，需要处理的信息也日趋增大。不仅花费大量的教师资源， 处理效率也十分低下。

为提高学生管理的管理水平，优化资源，尽可能降低管理成本成为学生管理的新课题，学生管理系统是从 学生管理现状出发，根据学生管理的新要求进行开发设计的，它需要解决学生信息管理数据信息量大修改 不方便，对一系列数据进行分析时花费时间长等问题，帮助学生管理人员有效管理学生信息。

因此学生信息管理系统可以通过系统规范化地管理、科学性统计和快速查询、修改、增加、删除等，提高 信息的准确度以及日常管理的工作效率。

本系统主要是应用于学生各类信息的管理，总体任务是实现学生信息关系的系统化、规范化、自动化，其 主要任务是统计学生各类信息进行日常管理，如查询、修改、增加、删除、以及学生选课、成绩的查询等 功能设计的管理系统。

系统主要应用于学校学生信息管理，总体任务是实现学生信息管理的系统化、规范 化和自动化，其主要任务是管理学生相关信息，如学籍、课程、成绩、奖惩。

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

]

[样例：

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

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

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

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

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

]

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

2. 约束和限制

1. 必须在学生开学（9 月 1 日）前完成

2. 必须使用 java 语言与 mysql 数据库

3. 质量标准符合 ISO9001-XXXX

4. 可用性 99%

5. 服务器等运维成本不超过 100 万/年。

6. 可支持 5 万学生同时在线。

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

[样例：

1.必须在 2021.06.30 号完成

2.成本不能超过 1000 万

3.数据库采用 Oracle

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

]

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

3. 总体架构

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

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

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

3.1 架构分析

高性能：对于学生管理系统来说，总学生应该也就几万人，对学生管理系统的要求不高；针对一些特殊场景如抢课，一门课 1000 人抢课，对于一个系统的处理性能要求也不高。

高可用：一般情况下，学生管理系统挂掉几个小时，对学校的正常教学并不会有太大影响，大部分的学校教学活动并不完全依赖于学生管理系统。但是，由于学生、课程信息等是由学生和教师自己注册或者上传维护上去的，不能全部丢失，否则想要补全这些信息很困难。

可扩展：经过业务需求的分析，可以发现业务还是比较复杂的，有各种学生的管理，还有课程，考试，需要不断维护更新，后面还要进行统计分析、奖惩管理等，理解难度稍高，并且会根据学校的教学活动的变化而有新的需求增加，所以系统的可扩展性要求是比较高的，多人协作开发的情况下，需要进行一定的模块划分。

成本、安全：由于只在一个学校中使用，服务器成本应该不高；由于系统中不涉及学生、教师等的私密信息，不涉及资金流转，安全性上的要求也不算高。

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

[样例：

3.1.1 高可用

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

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

]

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

3.2 总体架构

此次架构分为三层：网关层、业务服务层、数据层。

网关层：

• 使用 Nginx 作为服务器网关，主要用于请求的负载均衡与服务路由分发，学生信息的相关请求路由到学生子系统，课程信息、考试相关的请求路由到课程子系统，教师、权限相关的请求路由到权限子系统。

业务服务层：

• 业务服务层由三个子系统组成：学生子系统、课程子系统、权限子系统。

数据层：

• 数据层由一主一备两台 Mysql 数据库服务器组成，主数据库负责日常所有业务数据的读写，并实时备份数据到备库。

• 由于业务性能要求不高，不需要做读写分离。

• 备库负责存储备份数据并在主库出现故障时临时切换到备库，保障可用性。

• 部分开发与运维同学使用数据库工具查询 or 统计数据时，可连接备库进行查询，这样可以保障主库的稳定性。

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

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

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

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

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

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

]

[技巧：

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

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

]

4. 详细设计

1. 新用户注册：选择班级，老师，年级，基本信息录入。

2. 用户主页：基本信息，考试成绩，奖惩信息

3. 选课、考勤、考试、打分、奖惩

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

4.1 核心功能

1. 新用户注册流程：选择班级，老师，年级，基本信息录入。

2. 用户主页查询：基本信息，考试成绩，奖惩信息

3. 选课、考勤、考试、打分、奖惩

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

[样例：

4.1.1 消息发送流程

4.1.2 消息消费流程

]

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

4.2 关键设计

1. 数据库主主复制

1）

1. nginx 请求路由

1）三个子系统的 http 请求链接中，分别加不同的关键字，如学生子系统-查询学生信息链接：http://www.stuMgmt.com/stuSubSys/queryStuInfo.html，课程子系统-查询课程信息链接：http://www.stuMgmt.com/stuCourseSys/queryCourseInfo.html，这样在 nginx 路由配置时只需要基于关键字配置路由的子系统指向即可。

3. zookeeper 实现分布式一致性锁（详情见链接）

1）由于几个子系统是分布式部署的，涉及多个子系统的业务操作，需要使用分布式一致性锁保证系统的最终一致性。

4. 通过 redis 实现抢课系统的库存管理（详情见链接）

1）通过 redis 的单线程实现某一门课程的抢课库存管理，这样能保证库存不会被多抢，并且 redis 性能高，也能减少抢课的相应时间。

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

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

1）消息发送可靠性

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

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

2）消息存储可靠性

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

3）消息如何存储

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

]

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

4.3 设计规范

1. Mysql 使用 Innodb 存储引擎。

2. java 开发需遵从《Google开发规范》。

3. redis 缓存的使用必须有过期时间。

4. 单实例数据库写多表必须有事务。

5. 分布式数据库写遵从最终一致性原则。

6. 所有数据变更库必须具有幂等设计。

7. 所有返回前端的 response 必须是 HttpResult<T>类。

8. 所有 Dubbo 接口返回 response 必须是 DubboResult<T>类。

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

[样例：

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

2）MySQL 使用 Innodb 存储引擎

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

]

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

5. 质量设计

可测试性：

• http 接口建立 postman 测试用例。

• Dubbo 接口通过 Dubbo 管理控制台建立测试用例。

• 超级管理员具有学生信息、教师信息、权限信息的删除权限，这样能保证测试后的一些测试脏数据可以通过超级管理员进行删除。

可维护性：

• Dubbo 具有控制台进行管理。

• mysql 可通过运维控制台进行管理。

可观测性：

• 系统性能观测，Dubbo、zookeeper、服务器、mysql 等，使用云平台提供的控制台进行系统监控。

• 业务数据由于没有多少，不需要监控。

成本：

• 目前云服务器的成本还是比较低的，而且由于性能要求不高，整体服务器可以选普通的服务器即可。

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

[样例：

5.1 消息队列管理后台

5.2 成本

]

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

6. 演进规划

一期：开学前必须完成学生注册、管理、课程、权限等管理功能上线。

二期：开学后考试前完成考试、考核奖惩、成绩统计等功能上线。

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

[样例：

6.1 消息队列一期

6.2 消息队列二期

]

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