0 基础架构入门 - 3(学生管理系统 - 详细架构设计文档)
前言
本文是学生管理系统详细架构设计文档,用于指导学生管理系统后续的开发、测试和运维。
1. 业务背景
随着学校规模的扩大和学生数量的增加,需要处理的信息也日趋增大。不仅花费大量的教师资源,处理效率也十分低下。尤其是学生信息管理数据信息量大修改不方便,对一系列数据进行分析时花费时间长。
基于以上背景,需要引入学生信息管理系统,总体任务是实现学生信息关系的系统化、规范化、自动化,其主要任务是统计学生各类信息进行日常管理,如查询、修改、增加、删除、以及学生选课、成绩的查询等。
2. 约束和限制
要求可以通过公网域名访问
要求至少 3 人合作完成
能够支撑管理 1000 个学生
3. 总体架构
[必选,描述经过备选架构决策后定下来的架构方案,这一章主要是描述架构的 3R:Rank、Role、Relation]
[技巧:1. 系统边界白盒图描述系统内的角色与外界的交互(Rank + Role + 外部 Relation);2. 系统架构图来描述内部的 Role + 内部 Relation]
[注意:不建议一张图同时描述系统架构的 3R 以及与外界的交互,因为图太复杂,画系统边界白盒图的时候,系统内部的 Relation 可以不画]
3.1 架构分析
[可选,这部分主要是架构复杂度的分析,基本上从备选架构文档中提炼关键内容过来即可]
[样例:
3.1.1 高可用
对于微博子系统来说,如果消息丢了,导致没有审核,然后触犯了国家法律法规,则是非常严重的事情;对于等级子系统来说,如果用户达到相应等级后,系统没有给他奖品和专属服务,则 VIP 用户会很不满意,导致用户流失从而损失收入,虽然也比较关键,但没有审核子系统丢消息那么严重。
综合来看,消息队列需要高可用性,包括消息写入、消息存储、消息读取都需要保证高可用性。
]
[技巧:常见的复杂度都要覆盖到,即使分析后不涉及也要描述,避免评审的时候被人认为遗漏了关键点]
3.2 总体架构
采用 Nginx 作为反向代理服务器
系统拆分为三个模块,每个模块作为一个子系统单独部署,所有子系统共用一套数据库
一套数据库包含一台主 MySQL 和一台备 MySQL,主备数据复制
4. 详细设计
4.1 核心功能
4.1.1 学生子系统
面向所有用户角色,提供系统登录功能
提供管理员账号,支持管理员添加教师账号、系统自动生成学生账号
支持手机号、微信等账号绑定,账号自助找回功能
提供组织管理、文件上传/下载、课程查询、成绩查询、文件查询等功能
4.1.2 课程子系统
支持课程体系的录入及类比选择,提供排课功能和教材管理
提供试卷区域分割功能,支持日常成绩管理和试卷评分判定
4.1.3 权限子管理
提供注册、登录、信息修改等功能
提供角色、用户、权限管理等功能
4.2 关键设计
[必选,描述系统的一些关键设计点是如何实现和取舍的]
[样例(如果你有兴趣,可以对比一下 kafka 的文档:Kafka design):
1)消息发送可靠性
业务服务器中嵌入消息队列系统提供的 SDK,SDK 支持轮询发送消息,当某个分组的主服务器无法发送消息时,SDK 挑选下一个分组主服务器重发消息,依次尝试所有主服务器直到发送成功;如果全部主服务器都无法发送,SDK 可以缓存消息,也可以直接丢弃消息,具体策略可以在启动 SDK 的时候通过配置指定。
如果 SDK 缓存了一些消息未发送,此时恰好业务服务器又重启,则所有缓存的消息将永久丢失,这种情况 SDK 不做处理,业务方需要针对某些非常关键的消息自己实现永久存储的功能。
2)消息存储可靠性
消息存储在 MySQL 中,每个分组有一主一备两台 MySQL 服务器,MySQL 服务器之间复制消息以保证消息存储高可用。如果主备间出现复制延迟,恰好此时 MySQL 主服务器宕机导致数据无法恢复,则部分消息会永久丢失,这种情况不做针对性设计,DBA 需要对主备间的复制延迟进行监控,当复制延迟超过 30 秒的时候需要及时告警并进行处理。
3)消息如何存储
每个消息队列对应一个 MySQL 表,消息队列名就是表名,表结构设计为……(此处请自行补充)
]
[技巧:常见的关键设计点包括高性能、高可用、可扩展、安全等]
4.3 设计规范
学生子系统、课程子系统、权限子系统均使用 SpringBoot 开发,持久层框架使用 Mybatis
MySQL 使用 Innodb 存储引擎
5. 质量设计
5.1 可测试性
5.2 可维护性
5.3 可观测性
5.4 成本
6. 演进规划
6.1 学生管理系统一期
6.2 学生管理系统二期
[必选,可以是演进规划,也可以是项目计划,需要描述每个里程碑或者版本具体要实现的能力]
[样例:
6.1 消息队列一期
6.2 消息队列二期
]
[技巧:开发阶段快速迭代,小步快跑,但要基本完善后才能正式推出给其他人用]
评论