详细设计文档（final）

1. 引言

1.1编写目的

本部分旨在阐明编写详细设计的目的，面向读者对象。

本文档主要描述各个模块的细节设计，明确软件的结构与实现过程，分析各个模块，描述模块的功能、性能和结构等方面包括模块接口、调用关系、处理过程和算法，以及各个模块的测试方案。本文档的主要读者为软件设计人员、模块开发人员、管理人员、测试人员。

1.2项目背景

我们通过调查问卷的方式，调查了华农部分学生，结果显示参加调查的50%以上的学生有查找空教室，蹭课，约自习需求。经过讨论权衡分析最终确定以该想法----华中农业大学空教室查询作为项目主题，并在此基础上进行功能拓展：经过约自习、蹭课，以微信小程序为应用平台，为华农全体学生提供便利的空教室查询途径。  

1.2.1项目来源

该项目起初源自Triple兔小组一名成员的想法。

1.2.2项目实现

本项目由Triple兔小组成员共同实现。

1.3缩写定义

华农：华中农业大学。

Triple兔：华中农业大学信息学院triple兔软件工程小组。

 

1.4术语定义

无。

1.5参考资料

[1]窦万峰.软件工程与实践[M].北京：机械工业出版社,2017.

1.6版本信息

 

修改编号	修改日期	修改后版本	修改位置	修改内容概述
1	2019-5-17	1.0	全部	完成第一次编写

 

2.总体设计

本部分简要给出系统的需求和软件结构组成，以便追踪到需求与设计。

 

2.1需求概述

 

自习吧小程序的需求定义如下：

初始化设置：设置用户登录后的初始页面为查空教室页面。

用户发布邀约设置：在发出邀约之前，必须填写个人资料。

 

2.2软件结构

自习吧小程序流程图经过优化设计，得出模块层次结构适中的软件总流程图如下：

 

 

3.程序描述

本部分针对每一个模块进行详细设计。

3.1登录模块

3.1.1 模块说明如下：

小程序授权登录，获取用户个人信息，进入小程序

3.1.2算法

后端算法描述：

 

前端算法描述：

 

3.1.3程序逻辑

 

 

3.2 查询空教室模块

3.2.1 模块说明如下：

输入：教学楼信息（几栋教学楼，哪座，几层）

输出：当前楼层的教室信息

功能：查询指定教学楼楼层的教室信息（空闲或者有课）

性能：要求在0.5秒以内完成

3.2.2算法

查询空教室模块调用以下模块完成相应功能：

查询指定教学楼楼层的空闲教室

调整数据格式

后端算法描述：

 

前端算法描述：

 

3.2.3程序逻辑

 

 

3.3蹭课模块

3.3.1  模块说明如下：

输入：课程名，教师名，专业名（三选一）

输出：课程信息

功能：查询想要上的课程的具体信息

性能：要求在0.5秒以内完成

3.3.2  算法

蹭课模块调用以下模块完成相应功能：

（三选一）

根据课程名查询相应课程信息

              后端算法描述：                                                前端算法描述：

 

根据教师名查询该教师教授的课程

              后端算法描述：                                                前端算法描述：

 

 

根据专业名查询该专业本学期上的课

              后端算法描述：                                                前端算法描述：

 

补充：其他算法：

 

3.3.3  程序逻辑

 

3.4约自习模块

3.4.1 模块说明如下：

输入：用户约自习请求信息

输出：在“广场”页面上对所有人显示该请求

功能：用户输入的约自习请求，在数据库中保存相应请求的信息，并在“广场”页面上对所有人可见，在“我的”页面可查看、删除或编辑用户个人发布的邀约。

性能：要求在0.5秒以内完成

3.4.2算法

蹭课模块模块调用以下模块完成相应功能：

接收用户输入的信息

数据库存储

数据库信息显示

主要功能描述：1.发布约自习   2.查看仔细邀约内容   3.检索自习邀约内容

后端算法描述：

 

前端算法描述：

 

3.4.3程序逻辑

 

3.5测试要点

主要测试输入输出接口是否正确，以及模块内部调用关系是否正确。