北软教育网络培训java培训——教务管理系统.doc

北软教育|北京java培训、网络培训、网络安全培训、CSR培训案卷号日期教务管理系统详细设计说明书 作 者： 北软第一组 完成日期： 2010-7-17 签 收 人： 签收日期： 修改情况记录：版本号修改批准人修改人安装日期签收人 北软教育java培训班学生作品版权所有：北软教育III目 录1 引言11.1 编写目的11.2 背景11.3 定义12 程序系统的结构13 程序（标识符）设计说明13.1 课程管理模块13.1.1 学生重考模块程序描述 功能 性能 输入项 输出项 算法 流程逻辑 接口 存储分配0 注释设计1 限制条件2 测试计划3 尚未解决的问题43.1.2 课程安排功能模块程序描述界面输入项输出项算法程序流程图73.1.3学生成绩功能模块功能描述程序输入项输出项103.2教师功能模块103.2.1教师管理程序描述 功能性能 输入项 输出项 算法 流程逻辑113.2.2管理员管理管理教师程序设计说明123.2.2. 2功能性能 输入项 输出项 算法 流程逻辑 接口153.3学生功能模块163.3.1程序描述163.3.2 功能163.3.3 输入项173.3.4 输出项203.3.5 算法213.3.6 流程逻辑213.4学校功能模块223.4.1学院管理模块功能描述223.4.2 功能223.4.3 输入项233.4.4 输出项233.4.5 算法243.4.6 页面原型243.4.7 接口243.4.8 注释设计253.4.9 限制条件253.4.10 测试计划253.4.11尚未解决的问题253.5新闻公告模块253.5.1程序描述253.5.2 功能263.5.3 性能263.5.4 输入项263.5.5 输出项263.5.6 算法273.5.7 流程逻辑273.5.8接口293.5.9 注释设计293.5.10 限制条件303.6 课程评价模块303.6.1评价管理功能程序描述303.6.2 功能303.6.3 输入项323.6.4 输出项323.6.5 算法333.6.6 流程逻辑333.6.8 接口353.6.10 注释设计353.6.11 限制条件353.6.12 测试计划353.6.13 尚未解决的问题353.7 教务人员功能模块353.7.1功能描述353.7.2输入项353.7.3输出项363.7.4功能描述363.7.5算法373.7.6流程图37详细设计说明书编写规范1 引言1.1 编写目的 详细说明项目运行时的业务流程和程序接口，设计简单的界面原型1.2 背景a 教务管理系统b 项目提出者：c 项目开发者：北软项目小组d 项目用户：教务管理人员，学生，教师，教务人员1.3 定义 列出本文件中用到的专门术语的定义和缩写词的原词组。2 程序系统的结构用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。本程序主要采用四层结构，如下所示：数据层(DB)数据访问层(DAL)业务逻辑层(BLL)用户层(UI)图1 系统结构示意图3 程序（标识符）设计说明3.1 课程管理模块该功能模块提供学生重考查询，重考报名及成绩查询功能。3.1.1 学生重考模块程序描述学生重考功能包括重考课程查询，重考报名，及重考成绩查询1. 重考课程查询：在学生功能界面选择重考课程查询可以查看所有需要重考的科目。2. 重考报名：在重考课程列表里选择课程后的报名按钮可以报名3. 成绩查询：在学生功能界面选择重考成绩查询可以查看所有重考科目的成绩 功能1. 该功能点的大致处理流程图如下： 性能说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。 输入项1. 触发单击按钮事件。 输出项1. 查询重考科目查询成功：返回重考课程列表界面，输出全部重考课程。2. 重考报名报名成功：返回重考课程列表界面，输出全部重考课程。 3. 查询成绩查询查询成功：重考成绩列表界面，输出全部重考科目的成绩 算法1. 重考课程查询1) 创建存储过程，核心语句：query.list();2) 在DAO层创建Retake类，并实现方法query()，由query()执行上述查询过程。方法名为：query()3) 在Action层创建RetakeAction类，并封装Retake.query()。 流程逻辑1. 本功能所涉及到的逻辑流程以活动图描述如下：图4 往来单位流程逻辑活动图2. 本功能点，分为五个功能模块，分别对这五个功能模块描述如下：l 重考科目查询模块：功 能：完成重考科目查询功能。输入项目：触发事件按钮。输出项目：重考科目列表。程序逻辑：P1： 学生功能界面。P2： 用户点击重考课程查询按钮。P3： 显示重考科目列表。 接口无 存储分配无0 注释设计说明准备在本程序中安排的注释，如：1. 加在模块首部的注释；2. 加在各分枝点处的注释；3. 对各变量的功能、范围、缺省条件等所加的注释；4. 对使用的逻辑所加的注释等等。1 限制条件说明本程序运行中所受到的限制条件。2 测试计划3 尚未解决的问题3.1.2 课程安排功能模块程序描述本部分主要的功能为管理排课信息，主要的操作包括排课、修改已排课程的信息、查询已排课程信息、打印课表、考试日程安排、考试日程查询。1. 排课(AddSchedule)2. 修改已排课程信息(AlterSchedule)3. 查询已排课程信息(QuerySchedule)4. 打印课表(PrintSchedule)5. 考试日程安排(AddExamtime)6. 考试日程查询(QueryExamtime)本程序属于课程管理模块的一个子模块，要求对排课时的时间、地点、教师课表的冲突进行处理。界面图：管理员课程管理界面图：管理员排课界面输入项标识类型格式输入方式数据来源学院collegeNameStringxxx下拉列表学院信息表专业specialtyNameStringxxx下拉列表专业信息表课程名称courseNameStringxxx下拉列表课程信息表班级classesNameStringxxx复选框班级信息表上课学期semesterStringxxx下拉列表排课信息表上课周次weekStringx.x-x键盘输入排课信息表课程学时periodsIntx键盘输入排课信息表课程学分creditintx键盘输入排课信息表任课教师teacherNameStringxxx下拉列表教师信息表周几上课daysintx下拉框上课时间表上课节次Timesintx下拉框上课时间表上课教室classroomStringxxx下拉框教室信息表输出项输出项字段名称、标识、类型、格式均与输入项相同。算法1创建存储过程，将用户输入的信息如学院、专业、课程名称、上课学期、上课周次、课程学分、课程学时、任课教师、周几上课、上课节次、上课教室进行封装然后保存到输入库中。核心语句：session.save();2在dao层创建ScheduleDAO类，并实现insertSchedule()来执行存储过程1。3在bean层创建Schedule类，ScheduleTime类和StudentSchedule类来封装用户输入的信息。4. 在action中创建ScheduleAction，并实现insert()来控制过程。5在insertSchedule.jsp页面提供用户输入信息接口，用户单击提交按钮后，检查是否冲突，在不冲突的情况下，将信息持久化到数据库中。程序流程图 排课流程图：3.1.3学生成绩功能模块功能描述学生成绩管理1.管理员在“管理员控制界面”可以查看某个特定学生的成绩信息，并可以通过选择学期来筛选该生在某学期的成绩情况。2.管理员在“管理员控制界面”可以点击“修改”按钮来修改学生的成绩。3.管理员在“管理员控制界面”可以点击“打印”按钮来打印学生的成绩信息。查看学生总排名1.管理员在“管理员控制界面”点击“总成绩排名”按钮可以进入总成绩排名界面，在该界面管理员通过下拉框来选择学院，专业，年级，班级，学期从而来查询学生的总成绩排名。2.管理员在“总成绩排名”界面可以点击“打印”按钮来打印学生的总成绩排名。教师进行管理教学管理.教师在“教师管理”界面点击“学生成绩录入”链接可以录入自己所教授课程的学生的成绩。程序第一步，教师进入教务管理主界面，然后登陆教师管理页面，点击学生成绩录入，便进入学生成绩录入界面。第二步，教师选择要录入成绩的课程，系统便列出该修课程的所有学生，然后老师填写成绩，录入完毕，保存即可。提交到教务处之前可以修改成绩，一旦提交到教务处便没有权限修改了。开始功能 选择课程显示修课的学生添加学生成绩保存完成修改输入项1课程名（Course_name）：字符串型，下拉列表中选择。2, (选择课程后显示该修课程的所有学生)学生成绩：（Student_score）:浮点数输出项1， 录入成绩成功：保存，显示录入成功信息。2， 录入成绩失败：不予保存，并显示失败信息3， 修改录入成绩：显示录入成绩页面，原始数据默认显示3.2教师功能模块教师管理程序处理教师对自己个人信息和课程信息的管理，需要通过外部接口获取数据，如从课程表管理模块中获得课程信息。教师管理主要负责的功能是个人和课程信息管理，包括教师查看自己教授的所有课程信息，查询自己每周授课的课程表，录入自己所教授课程的学生的成绩，查询、修改自己个人信息，修改自己的个人密码。本程序主要由教师管理程序模块实现。3.2.1教师管理程序描述本模块给用户提供系统登录功能，用户可根据自己拥有的用户名和密码进入系统，防止无关人员随意进入系统。本程序根据用户输入的用户名和密码，对其进行验证，如结果正确则进入系统，反之显示用户名或密码错误，提示其重新输入，直到输入正确或用户选择退出为止。本模块实现教师对其所教授课程信息的查询，对于其每周授课的课程表的查询，对其所教授课程学生成绩的录入。本模块教师对自己的个人信息的查询，个人密码的修改以及个人信息的修改。 功能界面：图47 登录界面性能 输入项 1帐号（name）：字符串型，最大长度为20个字符，或10 个中文字。2密码（Password）：字符串型，最大20个字符，不允许中文。3. 触发登陆按钮事件。 输出项1登陆成功：跳转到教师首页(teachermain.jsp)。输出：教师名2. 登陆失败：提示帐号或密码错误，返回登陆页面(login.jsp). 算法 流程逻辑用例图：教师登录用例图流程图：教师登录流程图3.2.2管理员管理管理教师程序设计说明管理教师程序处理管理员对教师信息的管理。需要通过外部接口获取数据，如从课程表管理模块中获得课程信息。管理教师主要负责的功能是管理员对教师个人和课程信息管理，包括添加、查询、修改教师个人信息，查看教师教授的所有课程和教师教授的某门课程的评价。3.2.2. 2功能界面：添加教师性能 输入项 1. 教师教工号（number）：整型，最大4个字符。2. 教师姓名(name)：字符串型，最大10个字符。3. 教师性别(gender)：字符串型，最大10个字符。4. 教师职称(title)：字符串型，最大3个字符。5. 教师出生日期(birthday)：Date型。6. 教师登录密码(pwd)：字符串型，最大20个字符。7. 教师籍贯(native_place)：字符串型，最大50个字符。8. 教师民族(nationality)：字符串型，最大50个字符。9. 政治面貌(poli_status)：字符串型，最大20个字符。10. 身份证号码(id_card)：字符串型，最大18个字符。11. 教师教学状态(te_status)：字符串型，最大2个字符。12. 老师所属学院(college)：字符串型，最大4个字符。13. 触发添加按钮事件。 输出项添加成功：数据库中添加一名新的教师。输出：教师姓名，教师编号，性别，学院，职称，出生日期，初始密码，籍贯，民族，政治面貌，身份证号。 算法1创建增改查存储过程2在Model层创建TeacherDao类，实现add()、modify()和search()等。3在Control层创建TeacherAction类，封装增改查方法。4在teacher.jsp页面实现增删改查事件，提交并验证，验证不通过拒绝操作并弹出窗口提示。 流程逻辑用例图：管理教师用例图状态图：管理教师状态图 接口功能模块功能字模块功能模块描述接口描述教师信息管理showAll列表形式显示所有教师详细信息入口：出口：输出相应信息insert管理员添加新教师入口：获取新教师参数出口：数据库selectByTName管理员通过教师名字查找教师入口：获取教师名字出口：输出相应信息selectByCollege管理员通过专业名查找教师入口：获取学院名字出口：输出相应信息Modify管理员修改教师个人信息入口：修改的教师参数出口：数据库selectCommentByTeacher管理员查看所有教师的所有课程，可通过教师筛选，入口：获取教师名出口：输出相应信息showComment管理员查看教师具体评价入口：获取教师名出口：输出相应信息3.3学生功能模块3.3.1程序描述该模块功能为对学生信息（在输入里有描述）进行管理，进行一些有关学生信息的增加、删除、修改等基本管理操作，同时还有检索功能。目的是直观的了解学校学生的基本情况，便于管理员，学生的使用。本程序的特点（非常驻内存，需要的时候调用；是子程序；是可重入的；无覆盖要求；是并发处理的）。3.3.2 功能学生信息基本操作IPO图（即输入处理输出图）操作添加修改删除保存返回保存数据显示数据返回保存数据图23 学生信息基本操作IPO图图26 员工信息管理流程图3.3.3 输入项输入项目：鼠标或键盘事件。增加操作输入项：学生编号（主键）数据库中自增学生学号文本框输入格式学生姓名文本框输入格式学生性别单选框学生专业文本框输入格式学生出生日期文本框输入格式学生所在年级下拉框学生所在班级下拉框学生登录密码文本框输入格式学生入学成绩文本框输入格式学生籍贯文本框输入格式学生名族文本框输入格式政治面貌下拉框身份证号码文本框输入格式学生简历空学生在校状态数据库默认学生所在学院（外键）下拉框管理员添加学生页面：管理员修改操作输入项：学生学号文本框输入格式学生姓名文本框输入格式学生性别单选框学生专业文本框输入格式学生出生日期文本框输入格式学生所在年级下拉框学生所在班级下拉框学生登录密码文本框输入格式学生入学成绩文本框输入格式学生籍贯文本框输入格式学生名族文本框输入格式政治面貌下拉框身份证号码文本框输入格式学生在校状态数据库默认学生所在学院（外键）下拉框管理员修改学生页面：学生修改操作输入项：学生简历文本框输入格式电话号码文本框输入格式联系地址文本框输入格式查找操作输入项：学生专业下拉框学生所在年级下拉框学生所在班级下拉框学生所在学院下拉框管理员学生管理主页：3.3.4 输出项增加：1 学生信息增加成功，跳转到学生管理页面，所有的学生信息显示，显示具体内容如下：在数据浏览区域显示所有员工的信息，包括学生编号（主键），学生学号，学生姓名，学生性别，学生专业，学生出生日期，学生所在年级，学生所在班级，学生登录密码，学生入学成绩，学生籍贯，学生名族，政治面貌，身份证号码，学生在校状态，学生所在学院。2 学生信息增加失败，给出提示。管理员修改：1学生信息修改成功，跳转到学生管理页面，所有的学生信息显示，显示具体内容如下：在数据浏览区域显示所有员工的信息，包括学生编号（主键），学生学号，学生姓名，学生性别，学生专业，学生出生日期，学生所在年级，学生所在班级，学生登录密码，学生入学成绩，学生籍贯，学生名族，政治面貌，身份证号码，学生在校状态，学生所在学院。2学生信息修改失败，给出提示。学生修改：1学生信息修改成功，跳转到学生主页页面。2学生信息修改失败，给出提示。查看：在当前页面显示学生信息显示，显示具体内容如下：在数据浏览区域显示所有员工的信息，包括学生编号（主键），学生学号，学生姓名，学生性别，学生专业，学生出生日期，学生所在年级，学生所在班级，学生登录密码，学生入学成绩，学生籍贯，学生名族，政治面貌，身份证号码，学生在校状态，学生所在学院。3.3.5 算法学生信息和数据库绑定，数据显示，数据的基本操作（增加、修改、删除、保存），员工名称检索在检索时用到模糊查询算法，数据显示的刷新等。3.3.6 流程逻辑学生信息管理活动图：管理员登录用户登录学生登录查看学生修改学生信息增加学生查看个人信息修改个人信息返回学生管理返回学生主页学生信息管理活动图检索功能功 能：完成检索功能。性 能：响应时间控制在12秒内。输入项目：要检索的关键词；输出项目：检索出来的结果显示在数据浏览框中。3.4学校功能模块3.4.1学院管理模块功能描述该功能模块是系统中的一个底层模块，主要是管理系统所需要的所有专业，包括增加、删除、修改、查询、打印等，为系统的其他模块调用做好铺垫。3.4.2 功能根据需求分析和详细设计中的对商品信息管理的分析，可以得到商品信息管理的总的流程图如下：学院管理流程图其中，所输入、修改、显示、的具体数据参见下图类图中的基本属性。针对上述流程中增加商品信息、删除商品信息、修改商品信息、查询商品信息、打印商品信息等功能，其具体的执行流程如下：删除学院信息删除功能流程图图8 删除信息流程图3.4.3 输入项根据要求，学院管理中所用到的输入信息具体如下：3.4.4 输出项学院添加成功：提示添加成功，跳转到学院管理主页面，以表格的形式显示添加后的学院信息；学院添加失败：提示添加失败，跳转到学院管理主页面，以表格的形式显示原始的商品信息。3.4.5 算法本商品信息管理模块主要是对商品信息进行增加、删除、修改、查找、打印等操作，具体是算法设计如下：l 增加/*添加学院*/public void executeInsert(College college) Session session = HibernateUtil.getSessionFactory().openSession();session.beginTransaction();session.save(college);session.getTransaction().commit();3.4.6 页面原型3.4.7 接口用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。3.4.8 注释设计说明准备在本程序中安排的注释，如：1. 加在模块首部的注释；2. 加在各分枝点处的注释；3. 对各变量的功能、范围、缺省条件等所加的注释；4. 对使用的逻辑所加的注释等等。3.4.9 限制条件说明本程序运行中所受到的限制条件。3.4.10 测试计划说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。3.4.11尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。3.5新闻公告模块3.5.1程序描述新闻公告管理分为添加，删除，查询新闻功能4. 添加（Insert）：在增加记录页面(newsInsert.jsp)中填写信息，以增加一条记录。5. 删除（Delete）：将删除选中的整个新闻。6. 查询： 模糊查询：标题检索（SearchByTitle）：在文本框中输入标题进行检索； 精确查询按ID检索（SearchNewsById）：点击点击新闻题目进行检索；3.5.2 功能2. 该功能点的大致处理流程图如下：图2 新闻公告模块流程图3.5.3 性能说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。3.5.4 输入项2. 新闻标题（title）：文本框3. 新闻内容（content）：文本框4. 新闻发表日期（publishtime）：从当前系统日期获得5. 触发单击按钮事件。3.5.5 输出项4. 添加添加成功：返回到新闻管理主页面（newsManage.jsp），输出3.1.4所有输入项。添加失败：提示数据库插入失败，返回增加记录页面（newsInsert.jsp）。5. 删除删除成功：返回到新闻管理主页面（newsManage.jsp），输出3.1.4所有输入项。删除失败：提示数据库删除失败，返回新闻管理主页面（newsManage.jsp）。6. 查询查询成功：返回到新闻管理主页面（newsManage.jsp ），输出所有查询结果项。查询失败：无操作。3.5.6 算法2. 增加4) 创建存储过程，核心语句：Save(news) 对象参数为所有3.1.4输入项5) 在增加记录页面（newsInsert.jsp）用服务器验证控件验证输入。 验证不合法：提示错误信息并要求重新输入。 验证合法：调用insertNewsI方法进行数据库插入操作。3. 删除1) 创建存储过程，核心语句：Delete(news)进行数据库删除操作2) 删除成功返回新闻管理主页面（newsManage.jsp）3) 若删除不成功，则给出出错提示。4. 查询1) 创建存储过程，核心语句： 标题检索（SearchByTitle）：在文本框中输入标题进行检索； 按Id检索（SearchNewsById）：News news = (News) session.get(News.class, id);3.5.7 流程逻辑3. 本功能所涉及到的逻辑流程以活动图描述如下：图4 新闻管理流程逻辑活动图4. 本功能点，分为五个功能模块，分别对这五个功能模块描述如下：l 增加模块（M1.1.2）：功 能：完成增加功能。输入项目：图2-新闻管理输入项类图。输出项目：图3-新闻管理输出项类图。程序逻辑：P4： 产生增加记录页面（newsInsert.jsp）。P5： 等待用户输入各项信息。P6： 若用户取消则返回。P7： 若确定则判断新闻题目是否为空。P8： 若P4中新闻题目为空，给出提示：新闻题目不能为空，返回P2。P9： 保存记录至数据库。P10： 调用show ( ) 刷新记录。l 删除模块（M1.1.4）：功 能：完成删除功能。输入项目：无。输出项目：见3.1.5输出项。程序逻辑：P1： 在输出项中选中某一行。P2： 点“删除”，则弹出“确定/取消”提示。P3： 若取消，则返回主页面（newsManage.jsp）。P4： 若确定，对数据库执行删除记录操作。P5： 若删除失败，提示系统错误，返回主页面（newsManage.jsp）。P6： 提示删除成功。P7： 调用show ( )刷新记录。l 查询模块（M1.1.5）：a) 模糊查询功 能：完成查询功能。输入项目：新闻标题输出项目：见3.1.5输出项。说 明：实现即时响应的查询方式，即边输入边检索。程序逻辑：P1： 监控所有输入项目文本框。P2： 若某个/某几个输入项目有动作，则提取信息，组合成查询语句，执行数据查询操作。P3： 调用show ( )刷新记录，返回P1。说明：在程序流程中，对于选择模糊查询项操作之后，专门提供“增加”，“删除”按钮，来新增一条选项列，删除所选择的选项列。3.5.8接口管理员主页面点击新闻管理跳转到新闻管理主页面完成该模块功能。3.5.9 注释设计说明准备在本程序中安排的注释，如：5. 加在模块首部的注释；6. 加在各分枝点处的注释；7. 对各变量的功能、范围、缺省条件等所加的注释；8. 对使用的逻辑所加的注释等等。3.5.10 限制条件添加删除和根据题目查询是管理员权限3.6 课程评价模块3.6.1评价管理功能程序描述该功能模块主要用来对教师课程进行评价，查询，删除。3.6.2 功能根据需求分析和详细设计中的对评价管理的分析，可以得到评价管理的总的流程图如下：图5 评价管理流程图其中，所输入、修改、显示、的具体数据参见下图类图中的基本属性。评价管理总活动图如下3.6.3 输入项评价内容（content）:输入框3.6.4 输出项1、评论添加成功：提示添加成功，跳转到评论管理页面，显示添加后的评论信息；评论添加失败：提示添加失败，跳转到评论管理页面，显示原始的评论信息。2、评论信息删除成功：提示删除成功，跳转到评论管理页面，显示删除后的评论信息；评论删除失败：提示删除失败，跳转到评论管理页面，显示删除前的评论信息。3、评论信息检索成功跳转到评论管理页面，显示检索到的评论信息；评论信息检索失败：提示没有符合要求的评论。3.6.5 算法l 增加1. 创建添加评论信息存储过程：核心语句：save（commentary）2. 在commentaryInsert.jsp页面中，用服务器验证控件（RequiredFieldValidator）验证评论内容是否填选或是否合法。 验证不合法：提示错误并要求重新填写或选择。 验证合法：调用insertCommentary方法进行数据库存储。l 删除1. 创建删除评论过程：核心语句：delete （commentary）2. 根据具体的删除情况给出提示：未选中行点击删除：给出必须选中行再删除的错误提示； 删除成功：提示删除成功，调用查询方法显示删除后的信息； 删除失败：提示删除失败。l 查找：1. 根据schedule_id 查找教师某一门课的所有评论 Commentary commentary = (Commentary) session.get(Commentary.class, schedule_id);2. commentaryInsert.jsp页面中，用服务器验证控件 （RequiredFieldValidator）验证是否输入了查询条件或所输入的查询条件是否合法：a) 未输入点击查询：弹出必