学生信息管理系统详细设计文档

第一章引言

1.1编写目的

本文档给出了“学生信息管理系统”的详细设计。针对高校学生群体数量较大，为方便高校学生信息管理，我们设计了一个较为高效的学生信息管理系统。编写该文档目的：便于用户，开发人员之间进行理解和交流，可以作为项目开发工作的基础和依据以及确认测试和验收的依据。最后可为后面必要的系统升级或维护提供一些必要的系统信息；本系统具有运行速度快、安全性高、稳定性好的优点，并且具备完善的修改，删除等功能，能够快速的查询学生的相关信息。本文档的预期读者：使用该系统的用户管理者。

1.2背景

学生信息管理系统是校园网络中一个重要的应用系统，它大大改善了学校教学、科研与管理的基础环境，在一定程度上反映出学校管理现代化的水平。信息管理系统提供了强大的学生档案管理功能，方便管理员，学校老师对学生信息的添加、修改、删除、查询等操作。本系统开发的总体任务就是实现学生信息管理的系统化、规范化、自动化、达到提高学生信息管理效率的目的。系统主要使用者是高级管理员，教师管理者，以及学生本人，使用者通过系统可以对学生信息做查询，修改等操作。本系统适用于所有使用该系统的管理员用户和在校的学生。

1.3 预期读者

本文档（本指南）适用于所有使用该系统的管理员用户和在校的学生。

1.4参考资料

[1]《软件工程-软件建模与文档写作》龙浩王文乐刘金戴莉萍 [M] 人民邮电出版社.2018

[2]《软件工程》，高等教育出版社2001年出版，作者齐治昌、谭庆平。

[3]郑人杰.《软件工程——实践者的研究方法》[J].计算机教育,2007,No.(2s):80-80

第2章系统的结构

2.1软件结构框图

如图2-1所示

图2-1学生信息管理系统软件结构图

2.2系统配置图

该图主要说明软件硬件之间的层次关系，如图2-2所示

图2-2学生信息管理系统配置图

第3章模块（标识符）设计说明

3.1 login（登录）模块

3.1.1 描述

登录模块主要是实现用户的登录，用户通过输入正确的帐号、密码，而成功登录进入学生信息管理系统。

3.1.2 功能

如下表1所示。

表1

模块名字：login（登录）	模块编号：1
上层调用模块：无	下层调用模块：数据库查询模块
输入数据：登录信息	输出数据：模块控制代码
处理过程：进行登录操作：当用户的账号和密码输入正确时，登录进入相应的学生端、超级管理员端以及教师端。

3.1.3 输入项

用户信息：用户账号，用户密码。

3.1.4 输出项

控制代码，是被调该模块的名字。

3.1.5 设计方法（算法）

该登录模块中应用选择算法，根据要求选择不同的模式。

3.1.6 流程逻辑

登录模块逻辑流程图如下图3-1所示。

图3-1 登录模块逻辑流程图

3.1.7 接口

本模块为最初的主模块，没有上层模块，根据用户要求调用子模块;在模块的检查用户的合法性时需要调用系统的查询模块，传递参数是用户信息。该模块不直接操作数据库文件。

3.1.8 存储分配

根据学生信息管理系统需求分析说明以及概要设计的设计思路,系统的登录模块存储在所有数据的最前面。

3.1.9 注释设计

对不同用户登录不同页面的实现代码进行必要的注释。

3.1.10 限制条件

用户的权限受控。

3.1.11 尚未解决的问题

当前该系统的用户数据较少。

3.2 学生模块

3.2.1 描述

学生模块主要起承接的作用，学生可以查看自己的个人信息，以及修改自己的一些相关信息。

3.2.2 功能

如下表3-2所示。

表2

模块名字：学生	模块编号：2
上层调用模块：login（登录）	下层调用模块：数据库查询
输入数据：操作类型（查询或者修改）	输出数据：控制代码
处理过程：进入学生模块后，拥有学生权限，可以根据需要选择调用的子模块。

3.2.3 输入项

学生根据自己的需求，选择操作类型，该类型对应的是模块的名字。

3.2.4 输出项

控制代码，是被调模块的名字。

3.2.5 设计方法（算法）

该学生模块中应用选择算法，根据学生的选择要求选择不同的操作模式。

3.2.6 流程逻辑

学生模块逻辑流程图如下图3-2所示。

图3-2 学生管理员模块逻辑流程图

3.2.7 接口

本模块为只调用下层数据库查询模块或者维修申请模块，传的数据是全局唯一的模块的名字。

3.2.8 存储分配

该学生模块按照顺序模块放在登录模块之后即可实现系统的功能且不影响运行速度。

3.2.9 注释设计

每个方法前都有相应注释，以便更好地理解代码。

3.3 教师人员模块

3.3.1 描述

教师人员可以查看学生的个人信息，并可以进行学生信息的增删改查。

3.3.2 功能

如下表3-3所示。

表3

模块名字：教师人员	模块编号：3
上层调用模块：login（登录）	下层调用模块：数据库查询
输入数据：操作类型（查询或输入）	输出数据：控制代码
处理过程：进入教师人员模块后，拥有教师权限，可以根据需要选择调用的子模块。

3.3.3 输入项

教师人员根据自己的需求，选择操作类型，该类型对应的是模块的名字。

3.3.4 输出项

控制代码，是被调模块的名字。

3.3.5 设计方法（算法）

该教师人员模块中应用选择算法，根据教师人员的需求选择不同的操作模式。

3.3.6 流程逻辑

教师人员模块逻辑流程图如下图3-3所示

图3-3 教师管理员模块逻辑流程图

3.3.7 接口

本模块为只调用下层数据库查询模块，传的数据是全局唯一的模块的名字。

3.3.8 存储分配

该教师人员模块按照顺序模块放在登录模块之后即可实现系统的功能且不影响运行速度。

3.3.9 注释设计

对学生信息的查询和成绩输入的实现代码进行必要的注释。

3.4 管理员模块

3.4.1 描述

管理员模块主要起承接的作用，系统管理员有查询，增加，删除，修改学生信息的功能;。

3.4.2 功能

如下表4所示。

表4

模块名字：管理员	模块编号：4
上层调用模块：login（登录）	下层调用模块：数据库查询
输入数据：操作类型（查询或者增删改）	输出数据：控制代码
处理过程：进入管理员模块后，拥有管理员权限，可以根据需要选择调用的子模块。

3.4.3 输入项

管理员根据自己的需求，选择操作类型，该类型对应的是模块的名字。

3.4.4 输出项

控制代码，是被调模块的名字。

3.4.5 设计方法（算法）

该模块中应用选择算法，根据管理员的需求选择不同的操作模式。

3.4.6 流程逻辑

管理员模块逻辑流程图如下图3-4所示。

图3-4 超级管理员模块逻辑流程图

3.4.7 接口

本模块为只调用下层数据库查询模块，传的数据是全局唯一的模块的名字。

3.4.8 存储分配

该模块按照顺序模块放在登录模块之后即可实现系统的功能且不影响运行速度。

3.4.9 注释设计

对学生信息的增，删，改，查等操作的实现代码进行必要的注释。

3.5 数据库查询模块

3.5.1 描述

基于数据库操作的模块，用于实现上层模块调用进行数据库的查询功能。

3.5.2 功能

如下表5所示。

表5

模块名字：数据库查询	模块编号：5
上层调用模块：学生模块或教师模块，管理员模块	下层调用模块：显示模块
输入数据：上层模块传递的固定结构的数据类型	输出数据：固定数据类型
处理过程：实现上层模块调用进行数据库的查询功能，返回相应数据。

3.5.3 输入项

上层模块传递的固定结构的数据类型。

3.5.4 输出项

上层模块传递的固定结构的数据类型。

3.5.5 设计方法（算法）

本模块算法简单，符合数据库要求的合理即可。

3.5.6 流程逻辑

数据库增加模块逻辑流程图如下图3-5所示

图3-5 数据库查询模块逻辑流程图

3.6 数据库修改模块

3.6.1 描述

基于数据库操作的模块，用于实现上层模块调用进行数据库的修改功能。

3.6.2 功能

如下表6所示。

表6

模块名字：数据库修改	模块编号：6
上层调用模块：管理员管理模块	下层调用模块：显示模块
输入数据：上层模块传递的固定结构的数据类型	输出数据：固定数据类型
处理过程：实现上层模块调用进行数据库的修改功能，返回相应数据。

3.6.3 输入项

上层模块传递的固定结构的数据类型。

3.6.4 输出项

上层模块传递的固定结构的数据类型。

3.6.5 设计方法（算法）

本模块算法简单，符合数据库要求的合理即可。

3.6.6 流程逻辑

数据库修改模块逻辑流程图如下图3-6所示。

图3-6 数据库修改模块逻辑流程图

3.6.7 接口

该模块是基于数据库操作的模块，要和数据库进行通信，这里采用SQL语句。

3.7 数据库增加模块

3.7.1 描述

基于数据库操作的模块，用于实现上层模块调用进行数据库的增加功能。

3.7.2 功能

如下表3-7所示。

表7

模块名字：数据库增加	模块编号：7
上层调用模块：管理员模块	下层调用模块：显示模块
输入数据：上层模块传递的固定结构的数据类型	输出数据：固定数据类型
处理过程：实现上层模块调用进行数据库的增加功能，返回相应数据。

3.7.3 输入项

上层模块传递的固定结构的数据类型。

3.7.4 输出项

上层模块传递的固定结构的数据类型。

3.7.5 设计方法（算法）

本模块算法简单，符合数据库要求的合理即可。

3.7.6 流程逻辑

数据库增加模块逻辑流程图如下图3-7所示。

图3-7数据库增加模块逻辑流程图

3.7.7 接口

该模块是基于数据库操作的模块，要和数据库进行通信，这里采用SQL语句。

3.8 数据库删除模块

3.8.1 描述

基于数据库操作的模块，用于实现上层模块调用进行数据库的删除功能。

3.8.2 功能

如下表8所示。

表8

模块名字：数据库删除	模块编号：8
上层调用模块：管理员模块	下层调用模块：显示模块
输入数据：上层模块传递的固定结构的数据类型	输出数据：固定数据类型
处理过程：实现上层模块调用进行数据库的删除功能，返回相应数据。

3.8.3 输入项

上层模块传递的固定结构的数据类型。

3.8.4 输出项

上层模块传递的固定结构的数据类型。

3.8.5 设计方法（算法）

本模块算法简单，符合数据库要求的合理即可。

3.8.6 流程逻辑

数据库删除模块逻辑流程图如下图3-8所示。

图3-8数据库删除模块逻辑流程图

3.8.7 接口

该模块是基于数据库操作的模块，要和数据库进行通信，这里采用SQL语句。

3.9显示模块

3.9.1 描述

基于数据库操作的模块，用于显示用户操作结果。

3.9.2 功能

如下表9所示。

表9

模块名字：显示	模块编号：9
上层调用模块：数据库增加，数据库修改，数据库查询，数据库删除	下层调用模块：无
输入数据：上层模块传递的固定结构的数据类型	输出数据：固定数据类型
处理过程：显示用户操作结果。

3.9.3 输入项

上层模块传递的固定结构的数据类型。

3.9.4 输出项

上层模块传递的固定结构的数据类型。

3.9.5 设计方法（算法）

本模块算法简单，符合数据库要求的合理即可。

3.9.6 流程逻辑

显示模块逻辑流程图如下图3-9所示。

图3-9 显示模块逻辑流程图

3.9.7 接口

该模块是基于数据库操作的模块，要和数据库进行通信，这里采用SQL语句。