前言

本文是外包学生管理系统详细设计文档，用于指导技术团队进行后续的开发、测试和运维。

词汇表

DNS：Domain Name System，域名系统

Front End：前端

Back End：后端

LB：Load Balance，负载均衡

1. 业务背景

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

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

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

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

2. 约束和限制

1. 系统交付日期为 2022 年 4 月 1 日前

2. 成本不超过 100 万

3. 数据库采用 MySQL

4. 后端开发语言为 JAVA，前端开发语言为 PHP

5. 不要求达到 ISO9001 标准

3. 总体架构

3.1 架构分析

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

[样例：

3.1.1 高可用

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

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

]

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

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

学生信息管理系统包含功能不多，但对质量要求高，主要是学生考试成绩不能丢不能错，选课不能选错等，所以学生管理系统是一个低业务复杂度、高质量复杂度的系统。

因此，学生信息管理系统的整体架构如下：

优点

• 基于简单原则，采用单机部署，根据预算，可以前后端分别用一台机器部署，也可以前后端部署在同一台机器上（只部署一台）

• 基于简单原则和合适原则，用户只有 1000 人，数据量不大，因此，存储采用开源数据库 MySQL，方便、简单、易用

• 基于合适原则，团队有一个 PHP 高手，前端采用 PHP 开发，开发效率高，交付有保障；大家都会 JAVA，后端采用 Java 开发，团队能力最大化（人尽其才）

• 架构简单，直接重用学校 DNS，不单独申请域名（省成本），前后端解耦（通过 REST API 对接），能快速完成端到端开发

• 系统运维成本低

• 架构简单，但模块独立，各模块可单独演进

缺点

• 没有高可用，单机部署

• 没有高性能，没有负载均衡

为了具备高可用性，增加双机部署能力，架构如下：

优点

• 增加负载均衡，提升并发访问能力以及可用性

• 双机部署，增加处理能力，提升性能

• 数据库采用主备双机，提升容灾能力

• 既可以使用虚拟机部署，也可以使用容器部署

• 人尽其才

缺点

• 成本比方案一高（增加机器、增加负载均衡）

4. 详细设计

4.1 核心功能

4.1.1 学生管理

4.1.1.1 系统登录

此功能面向所有用户角色，根据用户角色权限不一，功能权限也不一样。

4.1.1.2 账号分配

学生账号由系统生成，给定相应权限，可进行密码更改，无法对系统成绩评定等功能做出相应干涉。教师账号由管理者（教务）通过系统生成，教师有对学生成绩评定和试卷评定的权限，同时兼容学生权限。管理（教务）权限由系统固有账号，是系统 root 权限，对教师有分配管理权限，对数据有增加、修改、删除、查询权限。

4.1.1.3 账号绑定

学生账号可通过第三方如：手机号码、微信等自行绑定，可实现账号自助找回等。

4.1.1.4 组织管理层级

按学生实际情况划分归属。例如：软件学院—数字传媒方向（专业）—软件 1306—苗雨乔。

4.1.1.5 文件上传、下载

此功能针对所有用户开放，学生可以将自己课堂笔记、日常作业等相关信息在线传输，教师通过学生上传的相关作业、试卷信息进行相应评定，完成对学生平时成绩的评定。此功能一旦评定结束，所有用户只有查询、浏览的权限，除管理员外其他用户没有对成绩修改的权限。

4.1.1.6 信息查询

此项功能包含课程查询（含课程体系、课时安排、课表、教师、教材等）、成绩查询、文件查询。

4.1.2 课程管理

4.1.2.1 课程录入

由管理员对相应课程体系进行录入，供学生、教师进行在线选择。

4.1.2.2 选课功能

学生可以在线对自己的课程体系进行选择，相对应的课程选择功能类比。

4.1.2.3 排课功能

此功能根据学生选定的课程和教学体系安排，对相应教师、教室、时间进行统一规划安排。排课功能备选开发方向为在线排课和人工录入，在线排课是系统根据课程要设置课程的名称、课时、上课的班级、代课老师等信息，除此之外，还可以选填排课时的优选项，例如：上课时间有限上午等系统自动生成课程信息，管理员有权限对课程安排作出添加、删除、修改等判定。

4.1.2.4 教材选择

此功能由教务统一管理，根据每门课程选定相应教材。

4.1.3 考试管理

4.1.3.1 试卷区域分割

发起考试：期中的时候，教师可以创建一次考试；而在月考时可以根据上课的周数进行考试安排，如一般可以在在第八周、十二周、十六周分别创建三次考试。其中这些考试题目是在事先录入好的题库中按照教师设定的知识点、范围、难易程度以及题型自动生成的试卷。每创建一次考试之后，教师需要将出好的考试题进行分割点标注，然后印刷试卷，考试。考试过后，试卷会被扫描，然后教师需要将扫描件试卷录入系统之中，系统会根据标注点对试卷进行预处理和分割。教师进入系统，可以对已经分割好的试卷进行判分。

4.1.3.2 平时成绩

此项功能包含学生平时所有相关成绩信息，例如：考勤主要是由教师终端自动生成的或者教师手动输入，时间期限为当天；课堂笔记主要是由学生在当堂课程结束后将自己的笔记上传然后由教师批阅给予成绩在下次上课前完成自动签名；课后作业主要是在每堂课之后，教师可以发起一次作业任务，学生应老师设定的时间内提交作业，老师会对作业进行批阅，在下次课前给予成绩评分，将以上方式计算得到的总成绩计入平时成绩。最后按照系统判定的平时成绩结合月考、期中、期末试卷成绩按相应比例得出学生最终成绩。

4.1.3.3 评分判定

教师使用系统对上传的试卷分割区域作出相应的评分。由于教师要对试卷进行签字，我们建议教师在评分之前可以在试卷上进行签字，由此得到的扫描结果就有教师签字。如有额外需求，需要教师通过外设进行试卷签字，此项功能暂不做需求开发。

4.1.4 权限管理

• 系统使用者有学生、教师、管理员、辅导员

• 学生、教师、辅导员可以注册、登录、修改自己的信息，但注册信息需要管理员审核通过

• 学生只能查看自己的成绩，教师可以修改学生的成绩

• 辅导员可以查看学生的成绩，可以设置学生的奖惩信息

• 教师可以上传考试试题，学生可以做题

4.2 关键设计

1）消息发送可靠性

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

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

2）消息存储可靠性

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

3）消息如何存储

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

]

4.3 设计规范

1. 后端使用 Spring Boot 框架

2. 前端使用 PHP 开发

3. MySQL 使用 Innodb 存储引擎

5. 质量设计

学生管理系统属于低复杂度系统，可观测性不是太有必要。成本前面已经描述过，首个版本都是采用最低成本方案，因此，不再详述。

5.1 可测试性

所有功能点都要有单元测试覆盖，单元测试覆盖率要求达到 100%

5.2 可维护性

1. 要求部署守护进程，在当前服务进程挂掉时能自动拉起。

2. 前后端均需要打印关键日志，方便定位

6. 演进规划

当前实现的是学生管理系统 1.0 版本，后续将会在功能、容量、性能、易用性上做进一步的发展和优化。具体计划如下：