架构实战训练营|作业|模块 3
前言
本文是学生管理系统详细架构设计文档，用于指导后续的开发、测试、运维
词汇表
暂无
1. 业务背景
随着学校的规模的不断扩大，学生数量的增加，需要处理的信息也日趋增大。处理效率低下：不仅花费大量的教师资源， 处理效率也十分低下。
为提高学生管理的管理水平，优化资源，尽可能降低管理成本成为学生管理的新课题，学生管理系统是从学生管理现状出发，根据学生管理的新要求进行开发设计的，它需要解决学生信息管理数据信息量大修改不方便，对一系列数据进行分析时花费时间长等问题，帮助学生管理人员有效管理学生信息。
因此学生信息管理系统可以通过系统规范化地管理、科学性统计和快速查询、修改、增加、删除等，提高 信息的准确度以及日常管理的工作效率。
本系统主要是应用于学生各类信息的管理，总体任务是实现学生信息关系的系统化、规范化、自动化，其主要任务是统计学生各类信息进行日常管理，如查询、修改、增加、删除、以及学生选课、成绩的查询等功能设计的管理系统。
2. 系统概述
系统主要应用于学校学生信息管理，总体任务是实现学生信息管理的系统化、规范 化和自动化，其主要任务是管理学生相关信息，如学籍、课程、成绩、奖惩。
2.1 需求概述
1. 系统登录：此功能面向所有用户角色，根据用户角色权限不一，功能权限也不一样。
2. 账号分配：学生账号由系统生成，给定相应权限，可进行密码更改，无法对系统成绩评定等功能做出相应干 涉。教师账号由管理者（教务）通过系统生成，教师有对学生成绩评定和试卷评定的权限，同时兼容学生权 限。管理（教务）权限由系统固有账号，是系统 root 权限，对教师有分配管理权限，对数据有增加、修改、 删除、查询权限。
账号绑定：学生账号可通过第三方如：手机号码、微信等自行绑定，可实现账号自助找回等。
4. 组织管理层级：按学生实际情况划分归属。 例如：软件学院—数字传媒方向（专业）—软件 1306—苗雨 乔。
5. 文件上传/下载：此功能针对所有用户开放，学生可以将自己课堂笔记、日常作业等相关信息在线传输，教 师通过学生上传的相关作业、试卷信息进行相应评定，完成对学生平时成绩的评定。此功能一旦评定结束，所 有用户只有查询、浏览的权限，除管理员外其他用户没有对成绩修改的权限。
6. 信息查询：此项功能包含课程查询（含课程体系、课时安排、课表、教师、教材等）、成绩查询、文件查 询。
课程录入：由管理员对相应课程体系进行录入，供学生、教师进行在线选择。
选课功能：学生可以在线对自己的课程体系进行选择，相对应的课程选择功能类比。
排课功能：此功能根据学生选定的课程和教学体系安排，对相应教师、教室、时间进行统一规划安排。 排课功能备选开发方向为在线排课和人工录入，在线排课是系统根据课程要设置课程的名称、课时、上课 的班级、代课老师等信息，除此之外，还可以选填排课时的优选项，例如：上课时间有限上午等系统自动 生成课程信息，管理员有权限对课程安排作出添加、删除、修改等判定。
教材选择：此功能由教务统一管理，根据每门课程选定相应教材
试卷区域分割：发起考试：期中的时候，教师可以创建一次考试；而在月考时可以根据上课的周数进行考 试安排，如一般可以在在第八周、十二周、十六周分别创建三次考试。其中这些考试题目是在事先录入好的 题库中按照教师设定的知识点、范围、难易程度以及题型自动生成的试卷。每创建一次考试之后，教师需要 将出好的考试题进行分割点标注，然后印刷试卷，考试。考试过后，试卷会被扫描，然后教师需要将扫描件 试卷录入系统之中，系统会根据标注点对试卷进行预处理和分割。教师进入系统，可以对已经分割好的试卷 进行判分。
平时成绩：此项功能包含学生平时所有相关成绩信息，例如：考勤主要是由教师终端自动生成的或者教师手动输入，时间期限为当天；课堂笔记主要是由学生在当堂课程结束后将自己的笔记上传然后由教师批阅给 予成绩在下次上课前完成自动签名；课后作业主要是在每堂课之后，教师可以发起一次作业任务，学生应老 师设定的时间内提交作业，老师会对作业进行批阅，在下次课前给予成绩评分，将以上方式计算得到的总成 绩计入平时成绩。最后按照系统判定的平时成绩结合月考、期中、期末试卷成绩按相应比例得出学生最终成绩。
评分判定：教师使用系统对上传的试卷分割区域作出相应的评分。由于教师要对试卷进行签字，我们建 议教师在评分之前可以在试卷上进行签字，由此得到的扫描结果就有教师签字。如有额外需求，需要教师通过外设进行试卷签字，此项功能暂不做需求开发
学生、教师、辅导员可以注册、登录、修改自己的信息，但注册信息需要管理员审核通过。
学生只能查看自己的成绩，教师可以修改学生的成绩。
辅导员可以查看学生的信息，可以设置学生的奖惩信息。
教师可以上传考试试题，学生可以做题
2.2 参与者
系统使用者有学生、教师、管理员、辅导员。学生、教师、辅导员可以注册、登录、修改自己的信息，但注册信息需要管理员审核通过
学生：能够查看个人信息、答题、查看成绩、上传、下载、查看文件、查看奖罚信息、查看课程、选课
老师：课程录入、排课、创建试卷、发起考试、成绩录入、创建作业、发起课后作业、批阅作业、考勤、分数判定
辅导员：查看学生信息、设置学生奖罚信息
系统管理员：审核账号信息、分配权限、课程安排删除、修改、添加等操作、成绩修改、对数据有增加、修改、 删除、查询权限。
2.3 需求用例描述
就是将系统边界图细化，外加详细的描述，省略.....
2.4 系统边界图
3. 约束和限制
需要保证数据的高可用，数据库选型不做限制
开发时间三个月交付，正式投入上线使用
实现技术可使用 java、php、go、C++、js、vue。
4. 总体架构
[必选，描述经过备选架构决策后定下来的架构方案，这一章主要是描述架构的 3R：Rank、Role、Relation]
[技巧：1. 系统边界白盒图描述系统内的角色与外界的交互(Rank + Role + 外部 Relation)；2. 系统架构图来描述内部的 Role + 内部 Relation]
[注意：不建议一张图同时描述系统架构的 3R 以及与外界的交互，因为图太复杂，画系统边界白盒图的时候，系统内部的 Relation 可以不画]
使用 Nginx 代理请求，做负载均衡
部署三台服务器，保证服务高可用
数据库使用 mysql 主备架构，保证数据库的高可用
5. 详细设计
[必选，描述核心场景或者流程的实现机制]
5.1 核心功能
[必选，描述核心场景或者流程的实现机制，对应 4R 架构中的 Rule，每个核心场景一个小节]
[样例：
4.1.1 消息发送流程
4.1.2 消息消费流程
]
[技巧：使用系统序列图来描述 Rule，跟项目开发中写设计文档一样的写法]
5.2 关键设计
[必选，描述系统的一些关键设计点是如何实现和取舍的]
[样例（如果你有兴趣，可以对比一下 kafka 的文档：Kafka design）：
1）消息发送可靠性
业务服务器中嵌入消息队列系统提供的 SDK，SDK 支持轮询发送消息，当某个分组的主服务器无法发送消息时，SDK 挑选下一个分组主服务器重发消息，依次尝试所有主服务器直到发送成功；如果全部主服务器都无法发送，SDK 可以缓存消息，也可以直接丢弃消息，具体策略可以在启动 SDK 的时候通过配置指定。
如果 SDK 缓存了一些消息未发送，此时恰好业务服务器又重启，则所有缓存的消息将永久丢失，这种情况 SDK 不做处理，业务方需要针对某些非常关键的消息自己实现永久存储的功能。
2）消息存储可靠性
消息存储在 MySQL 中，每个分组有一主一备两台 MySQL 服务器，MySQL 服务器之间复制消息以保证消息存储高可用。如果主备间出现复制延迟，恰好此时 MySQL 主服务器宕机导致数据无法恢复，则部分消息会永久丢失，这种情况不做针对性设计，DBA 需要对主备间的复制延迟进行监控，当复制延迟超过 30 秒的时候需要及时告警并进行处理。
3）消息如何存储
每个消息队列对应一个 MySQL 表，消息队列名就是表名，表结构设计为……(此处请自行补充）
]
[技巧：常见的关键设计点包括高性能、高可用、可扩展、安全等]
5.3 设计规范
[必选，描述 Role 和 Relation 相关的开发框架、连接协议、数据包格式等]
[样例：
1）消息队列服务器使用 Spring Boot + Netty 开发
2）MySQL 使用 Innodb 存储引擎
3）TCP 包的结构设计……（此处省略，请自行补充）
]
[技巧：如果某个规范涉及内容比较多，请独立章节描述，例如数据包格式定义]
6. 质量设计
[必选，描述和质量相关的设计，包括：可测试性、可维护性、可观测性、成本等设计]
[样例：
5.1 消息队列管理后台
5.2 成本
]
[技巧：如果某个维度不涉及，也请在文档中说明，避免评审的时候被认为考虑不周全]
7. 演进规划
[必选，可以是演进规划，也可以是项目计划，需要描述每个里程碑或者版本具体要实现的能力]
[样例：
6.1 消息队列一期
6.2 消息队列二期
]
[技巧：开发阶段快速迭代，小步快跑，但要基本完善后才能正式推出给其他人用]
小步快跑 2019.04.15 加入
不想当架构师的程序员不是好程序员
评论