教学管理系统功能设计文档
1.用户登录模块
- 1 用户登录
功能描述
输入:账号、密码
输出: 提示信息:登录成功(也可以不提示直接跳转主页)
业务逻辑:
1)管理员在登陆页面输入账号、密码
2)输入不存在的账号,提示“不存在此用户”
3)输入错误密码,提示“密码或账户输入错误”
4)输入正确,提示“登陆成功”,跳转到主页面
2用户管理
1.2用户添加
功能描述
输入:用户名、Email、联系电话、角色
输出:提示信息、添加成功
业务逻辑:
- 在添加员工页面输入姓名、密码(默认)、所属角色、创建时间、email、联系电话、用户状态
- 输入姓名为空,提示“请输入姓名”
- 输入姓名格式为非英文,汉字,提示“请输入正确的名称”
- 输入手机号码,使用正则表达式验证。
- 选择用户角色
- 提示“添加成功”
1.3用户修改
功能描述
输入:用户名、Email、联系电话、角色
输出:提示信息、添加成功
业务逻辑:
- 在添加员工页面输入姓名、密码(默认)、所属角色、创建时间、email、联系电话、用户状态
- 输入姓名为空,提示“请输入姓名”
- 输入姓名格式为非英文,汉字,提示“请输入正确的名称”
- 输入手机号码,使用正则表达式验证。
- 选择用户角色
- 提示“修改成功”
1.4用户删除以及批量删除
功能描述
输入:用户ID数组
输出:提示信息、删除成功
业务逻辑:
- 选择要删除的用户
- 点击确定
- 提示“删除成功”或“删除失败”
- 刷新页面
1.5 用户分页查询
功能描述
输入:业务参数、每页数据条数、页码
输出:页面
业务逻辑:
- 点击功能选项,默认第一页
- 点击页码
- 获取数据
- 展示页面
1.6根据用户名查询用户信息
功能描述
输入:用户名
输出:页面
业务逻辑:
- 输入用户名进行模糊查询
- 获取数据
- 展示页面
2.角色模块
2.1列表查询
功能描述
输出:页面
业务逻辑:
- 页面展示所有角色列表
- 获取数据
- 展示页面
2.2角色添加
功能描述
输入:角色名称
输出:添加成功
业务逻辑:
- 输入角色名称
- 点击确定
- 提示“添加成功”
2.3角色修改
功能描述
输入:角色名称、创建时间、修改时间
输出:修改成功
业务逻辑:
- 在修改页面输入角色名称
- 输入角色名称为空,提示“请输入角色名称”
- 提示“修改成功”
2.3角色删除
功能描述
输入:角色ID数组
输出:提示信息、修改成功
业务逻辑:
- 选择要删除的角色
- 点击确定
- 提示“删除成功”或“删除失败”
- 刷新页面
2.4角色分页查询
功能描述
输入:业务参数、每页数据条数、页码
输出:页面
业务逻辑:
- 点击功能选项,默认第一页
- 点击页码
- 获取数据
- 展示页面
3.留言模块
3.1留言列表查询
功能描述
输出:页面
业务逻辑:
- 查询所有留言列表
- 获取数据
- 展示页面
3.2留言添加
功能描述
输入:留言内容
输出:根据输入用户名称进行模糊查询
业务逻辑:
- 输入用户名称
- 非空判断
- 根据输入内容进行模糊查询
- 输出查询结果
3.3留言发送
功能描述
输入:根据用户名称发送留言
输出:发送成功并在内容显示区域显示留言交流内容
业务逻辑:
- 选择或搜索需要留言用户
- 双击打开用户留言板
- 空值判断、格式判断
- 发送
- 在内容区显示相互留言内容
3.4日记删除
功能描述
输入:角色ID数组
输出:提示信息、修改成功
业务逻辑:
- 选择要删除的角色
- 点击确定
- 提示“删除成功”或“删除失败”
- 刷新页面
4.日记模块
4.1分页查询日记列表
功能描述
输入:业务参数、每页数据条数、页码
输出:页面
业务逻辑:
- 页面数据包含:日记标题、创建时间、审阅教师、更新时间、状态、成绩、建议、操作
- 点击功能选项,默认第一页
- 点击页码
- 获取数据
- 展示页面
4.2新增日记(富文本编辑)
功能描述
输入:点击新增添加日记
输出:页面
业务逻辑:
- 点击功能选项,新增日记
- 新增页面从数据库中读取审阅老师
- 点击提交,把写好日记发送审阅老师
- 点击返回回到日记列表
4.2日记审核
功能描述
输入:点击操作中审核
输出:页面
业务逻辑:
- 日记两种状态审核和未审核,并对日记有评分
- 点击审核,弹出模态窗体
- 在模态窗体中有评分分别为:优、良、差、不及格
- 选择评分点击提交更改用户日记状态为审核并有成绩。
- 提交更改关闭模态窗体回到列表页面
5.其他说明
5.1页面清单
项目外部插件使用
插件列表 | ||
插件 | 说明 | 描述 |
Thymeleaf | 使用静态页面替代JSP页面 | |
SpringBoot | 无 | |
MyBatis | 数据库帮助插件,代码逆向生成 | |
BootStramp | 前端插件 | |
JQuery | 前端插件 |
5.2 接口统一格式
字段名称 | 变量名 | 数据类型 | 默认值 | 值域 | 说明 |
输出参数 | |||||
调用是否成功 | isSuccess | Boolean | 调用服务本身是否成功,不表示业务成功失败类型 | ||
返回结果编码 | code | String(8) | 具体代码查看接口响应码 | ||
返回信息 | msg | String(128) | |||
参数对象 | data | *Json | 响应参数Json格式 | ||
业务参数 | |||||
业务参数字符串,各业务接口定义。 |