、

学生管理架构详细设计文档

前言

本文档是根据学生管理系统的详细架构设计文档，用于指导学生管理系统的开发，测试以及运维文档，对系统的功能需求，按业务划分进行模块划分，定义出整个需求的业务功能框架，对该系统的架构设计，模块设计以及系统集成进行总体定义。

术语、定义

表 1 术语定义

表 2 缩略语

1. 业务背景

随着学校的规模的不断扩大，学生数量的增加，目前需要处理的信息也日趋增大。不仅花费大量的教师资源，处理效率也十分低下，对于目前系统存在几个显著的问题：

1、性能问题：学生增加后，学生信息管理数据信息量大修改不方便，处理速度日益变慢；

2、耦合问题：旧系统各个模块耦合度高，运维人员维护困难，对于后期业务扩展亦很困难，不符合高内聚低耦合的设计思路；

3、效率问题，由于系统耦合度高，以及系统运行框架老旧，旧的开发人员均已离职，新接手人员对于在原来基础上开发新的模块效率低下，学习以及开发成本高。

基于以上问题背景，为提高学生管理的管理水平，优化资源，尽可能降低管理成本成为学生管理的新课题决定重构学生管理系统。

NSMS 系统

2. 约束和限制

NSMS 系存在的约束和限制

1、由于旧系统存在性能问题严重，需要在 2021 年 10 月 1 日正式上线，开发测试周期短；

2、系统重构成本不能超过 12W；

3、当前开发人员少，只有 2 人；

4、NSMS 系统要兼容现存存量数据，上线后数据要保持一致；

5、NSMS 系统在高峰时期(学生抢课)统性能上至少要达到 500/s 的 tps

3. 总体架构

经过架构决策确定方案，NSMS 系统采用以下的总体架构方案：

1：Rank 设计：分为系统访问接入层 nginx、业务层以及数据存储层

2：Role 设计：分为学生管理子系统，选课子系统以及权限子系统

3：Relation:学生管理子系统，选课子系统以及权限子系统之间都是互相关联的。

3.1 架构分析

NSMS 系统架构复杂度分析：

NSMS 系统划分了学生、选课、权限三个管理子系统，并分别部署在同一个服务器中，这样在原先的基础上，子系统之间进行了应用隔离，系统部署维护简单，业务扩展方便。

3.1.1 高可用

NSMS 系统采用 nginx 服务器分发访问，双机部署实现高可用，在一台机器出现故障的时候，能够很好的进行故障转移，为运维人员排查问题提供了缓冲时间，用户使用可靠性能够得到有效保证。

3.1.2 高性能

NSMS 系统对于子系统与子系统之间的交互采用 dubbo 进行交互方式，对于系统高性能提供了有效的支持。

3.1.3 高扩展

NSMS 系统采用了业界微服务 SpringCloud 框架，后期对于新业务的扩展拆分和独立部署都提供了良好支持。

3.2 总体架构

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

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

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

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

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

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

]

[技巧：

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

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

]

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 消息队列二期

]

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