学生学籍管理系统概要设计说明书

一、引言

学生学籍管理系统是一款用于学校管理学生学籍信息的软件，主要功能包括学生信息录入，查询，修改和删除等操作。本文档是该系统的概要设计说明书，旨在为开发人员提供系统的整体框架和基本功能的设计。

二、系统概述

学生学籍管理系统是一款基于Web的应用软件，采用B/S架构，使用Java语言开发，数据库采用MySQL。系统主要分为三个模块：学生信息管理模块、用户管理模块和系统管理模块。

三、功能模块设计

1. 学生信息管理模块

该模块主要负责学生信息的录入、查询、修改和删除。其中，学生信息包括姓名、学号、性别、年龄、班级、联系方式等基本信息。

2. 用户管理模块

该模块主要负责系统用户的管理，包括添加、删除、修改和查询等操作。系统用户包括管理员和普通用户。

3. 系统管理模块

该模块主要负责系统的配置和管理，包括系统设置、日志管理、备份和还原等操作。

四、数据结构设计

1. 学生信息表

字段名 | 类型 | 描述
-------- | ------- | --------
id | int(11) | 学生ID，自增主键
name | varchar | 姓名
student_id | varchar | 学号
gender | varchar | 性别
age | int(2) | 年龄
class | varchar | 班级
contact | varchar | 联系方式

2. 用户信息表

字段名 | 类型 | 描述
-------- | ------- | --------
id | int(11) | 用户ID，自增主键
username | varchar | 用户名
password | varchar | 密码
role | varchar | 角色，用于区分管理员和普通用户

五、系统流程设计

1. 登录流程

用户登录系统后，输入用户名和密码，点击登录按钮，系统验证用户名和密码后跳转到主界面。

2. 学生信息管理流程

管理员进入学生信息管理界面，可以进行学生信息的添加、查询、修改和删除等操作。普通用户只能进行学生信息的查询操作。

3. 用户管理流程

管理员进入用户管理界面，可以进行用户的添加、删除、修改和查询等操作。

4. 系统管理流程

管理员进入系统管理界面，可以进行系统设置、日志管理、备份和还原等操作。

六、接口设计

1. 学生信息管理接口

- 添加学生信息

请求地址：/students/add

请求方法：POST

参数：

{
"name": "张三",
"student_id": "20190101",
"gender": "男",
"age": 20,
"class": "计算机科学与技术",
"contact": "13888888888"
}

返回值：

{
"code": 0,
"msg": "添加成功"
}

- 查询学生信息

请求地址：/students/query

请求方法：GET

参数：

{
"student_id": "20190101"
}

返回值：

{
"code": 0,
"data": {
"name": "张三",
"student_id": "20190101",
"gender": "男",
"age": 20,
"class": "计算机科学与技术",
"contact": "13888888888"
}
}

- 修改学生信息

请求地址：/students/update

请求方法：POST

参数：

{
"student_id": "20190101",
"class": "软件工程"
}

返回值：

{
"code": 0,
"msg": "修改成功"
}

- 删除学生信息

请求地址：/students/delete

请求方法：POST

参数：

{
"student_id": "20190101"
}

返回值：

{
"code": 0,
"msg": "删除成功"
}

2. 用户管理接口

- 添加用户

请求地址：/users/add

请求方法：POST

参数：

{
"username": "admin",
"password": "123456",
"role": "admin"
}

返回值：

{
"code": 0,
"msg": "添加成功"
}

- 查询用户

请求地址：/users/query

请求方法：GET

参数：

{
"username": "admin"
}

返回值：

{
"code": 0,
"data": {
"username": "admin",
"password": "123456",
"role": "admin"
}
}

- 修改用户

请求地址：/users/update

请求方法：POST

参数：

{
"username": "admin",
"role": "user"
}

返回值：

{
"code": 0,
"msg": "修改成功"
}

- 删除用户

请求地址：/users/delete

请求方法：POST

参数：

{
"username": "admin"
}

返回值：

{
"code": 0,
"msg": "删除成功"
}

七、安全性设计

系统在设计时需要考虑安全性问题，主要有以下几点：

1. 用户密码加密存储，避免密码泄露。

2. 防止SQL注入攻击，使用预编译SQL语句。

3. 控制用户权限，普通用户只能进行查询操作，管理员可以进行所有操作。

4. 使用HTTPS协议传输数据，保证数据传输的安全性。

八、总结

本设计说明书主要描述了学生学籍管理系统的概要设计，包括系统模块、功能模块设计、数据结构设计、系统流程设计、接口设计和安全性设计等方面。本设计说明书旨在为开发人员提供系统的整体框架和基本功能的设计，以便于后续的详细设计和开发工作的顺利进行。