概要设计说明书【宜昌智慧校园管理与应用系统】

概要设计说明书[YCZC-F20140007-1(2)][宜昌智慧校园管理与应用系统]项目负责人陈然作者周昱龙徐国超文档提交日期

版本编号或者更改记录编号*变化状态简要说明（变更内容和变更范围）日期变更人批准日期批准人V1.0C新增文档20151020周昱龙20151026陈然*变化状态：C——创建，A——增加，M——修改，D——删除

目录[YCZC-F20140007-1(2)][宜昌智慧校园管理与应用系统] 11 引言 51.1 编写目的 51.2 背景 51.3 定义 61.4 参考文献 62 总体设计 72.1 需求规定 72.2 运行环境 72.3 基本设计概要和处理流程 83 接口设计 83.1 用户接口 83.1.1 获取班级通知方法 83.1.2 单独获取通知回复的方法 93.1.3 单独获取通知回复的回复方法 93.1.4 添加班级通知的一级回复 103.1.5 删除班级通知 113.1.6 取消自己顶置的班级通 113.1.7 获取班级家长动态 113.1.8 获取个人动态接口 123.1.9 获取单个动态信息 133.1.10 家长发表动态的方法 133.1.11 老师发表动态的方法 143.1.12 动态转发 143.1.13 删除自己的动态 153.1.14 获取动态的回复接口 163.1.15 添加动态回复 173.2 外部接口 183.2.1 按班级获取所有动态接口 183.2.2 按班级获取老师动态接口 183.2.3 动态收藏 193.2.4 动态点赞 193.2.5 获取其他人的动态接口 203.3 内部接口 213.3.1 接口重用该对象 213.3.2 接口重用该接口 214 模块设计 214.1 权限管理系统 214.2 基础数据库 224.3 学生管理系统 234.4 教职工管理系统 244.5 系统管理 254.6 第三方应用系统使用权限 274.7 管理员登录结构图 284.8 前台用户登录结构图 29五、系统出错处理设计 29出错信息 29

引言编写目的本文档是[宜昌教育云][教师/家长前台]提供给平台设计及研发人员使用，作为系统设计实施的依据。作为项目验收标准之一。软件维护的参考资料。背景为进一步实现“教育公开”的要求，同时方便各类教育信息能准确、安全、快速的发布到指定的用户层面上，同时推进教育信息办公效率，在调研大量学校用户（教师、学校中层干部及校领导）和家庭用户的基础上，建立本项目研发的设计需求根据宜昌市教育及教育信息化发展现状和发展需要，基于政府有关系统和宜昌教育公共服务平台基础数据库，建设贯穿全市各级幼儿园、小学、初中、高中（职校）、教育管理部门的智慧校园管理与应用系统，开展教育管理和教学的各项应用。宜昌教育的基本情况： 高等教育：全市有普通高等学校5所（三峡大学、三峡大学科技学院、三峡职业技术学院、三峡电力职业学院、三峡旅游职业技术学院），全日制在校生56588人，教职工6322人，其中专任教师3510人;高等教育成教生28644人（含宜昌广播电视大学在校生6093人），市电大教职工70人、专任教师32人。全市18周岁适龄人口升入高等学校比例37%。基础教育：全市有小学282所，在校生156855人，专任教师11003人，专任教师学历合格率99.7%，师生比1：14，小学学龄儿童入学率100%，六年教育完成率100%，小学生升初中比例为100%。有初中学校135所，在校生90816人，专任教师8652人，专任教师学历合格率98.8%，师生比1：11，初中适龄少年入学率100%，初中三年教育完成率98.95%，九年义务教育完成率98%。有普通高（完）中35所，在校生59930人，专任教师4565人，专任教师学历合格率98.1%，师生比1：13，高中阶段毛入学率95%，初中毕业生升入高中阶段教育的比例97%。有幼儿园383所，在园幼儿78499人，幼儿园教职工7674人，学前三年幼儿入园率76%，学前两年幼儿入园率89%，学前一年幼儿入园率100%。有特殊教育学校9所，招收残疾少年儿童150。 该系统建设完成之后，将部署在宜昌电子政务云平台上，从硬件、网络条件而言，就具备了和宜昌电子政务云深度融合的相应条件。而从教育从业者和广大学生家长的实际需求出发，将会使教育信息化的应用真正落在实处。 在该系统开发的设计和开发过程中，应该在系统的底层标准化设计、接口开发性、功能与服务模块化以及用户交互体验重点考虑。 具体而言，由于该系统的建设是以平台级系统来加以定位，系统要面对“局、校、班、师、家、生”等多重不同角度的用户，涉及用户基础信息繁多复杂，这要求设计者要认真研究用户基础数据特征，提出完整、标准且有可扩性的数据结构体系。其次，不同层级和角色的需求也各不相同，功能和服务也会具有需求多样性和流程多样性，而合理的理解并设计各种基本功能和增值功能显得尤为重要，将功能和服务模块化，使流程可自由组合，使数据可相互复用，是对系统一个重要的考验指标。因此，接口开放性和功能服务的模块化是解决这些问题的关键点。定义学生信息管理系统：对学生的基本信息、课程选择、成绩的录入、修改、删除、查询等一系列的操作。参考文献《C语言程序设计》、《软件工程》《软件需求》劳森（作者），刘晓辉（译者）电子工业出版社《实用软件工程》第三版殷人昆清华大学出版社《电子政务系统的需求分析》甘明鑫，曹菁机械工业出版社总体设计需求规定（1）管理员能够方便的对信息进行添加、修改、查询、删除和汇总、通过条件选择查询所有信息、并进行排序。（2）可以将数据库发布到网上、进行资源共享。（3）学生可以在自己的权限内对信息进行访问、查询相关信息。（4）添加功能：管理员可以通过填写表格的形式输入学生成绩及相关信息。（5）修改功能：管理员通过条件查询所要修改的信息、然后对信息进行修改保存、系统会自动查找是否是重复信息。（6）删除功能：管理员可以对数据进行删除操作。系统能够通过管理员的条件进行查找删除信息、确定删除则数据库自动删除。运行环境VisualStudio6.0基本设计概要和处理流程接口设计用户接口获取班级通知方法接口函数原型stringGetClassNotice(stringaccesstoken,stringclassID,inttopCount,intreplyCount);说明获取班级通知方法（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定classID要获取的班级stringtopCount一次取得的条数intreplyCount回复的条数int返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel现实对象，具体含义参见通用对象说明属性类型说明单独获取通知回复的方法接口函数原型stringGetClassNoticeReply(stringaccesstoken,intnoticeID,intcommentID,inttopCount);说明单独获取通知回复的方法（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定noticeID要获取的通知IDstringcommentID基准回复的IDinttopCount一次性取的条数int返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel现实对象，具体含义参见通用对象说明属性类型说明ObjPersonalComment[]回复的内容，具体含义参见通用对象说明单独获取通知回复的回复方法接口函数原型stringAddClassNotice(stringaccesstoken,stringnoticeName,stringnoticeText,stringclassID,stringnoticePic,inttopDays)说明单独获取通知回复的回复方法（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定noticeName班级通知标题string可以不填noticeText班级通知内容intclassID要发布的班级IDintnoticePic图片topDays顶置的天数返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel现实对象，具体含义参见通用对象说明属性类型说明添加班级通知的一级回复接口函数原型AddClassNoticeReply(stringaccesstoken,intnoticeID,stringcommentText,,stringreplyerID);说明添加班级通知的一级回复（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定noticeID要回复的班级通知的IDintcommentText回复的内容stringreplyerID回复某人的ID1.2新加，没有回复人时可以填写空字符串返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel现实对象，具体含义参见通用对象说明属性类型说明删除班级通知接口函数原型stringDeleteClassNotice(stringaccesstoken,intnoticeID);说明删除班级通知（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定noticeID要删除班级通知的IDint返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel现实对象，具体含义参见通用对象说明属性类型说明取消自己顶置的班级通接口函数原型stringCancelNotice(stringaccesstoken,intnoticeID);说明取消自己顶置的班级通知（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定noticeID要取消顶置班级通知的IDint返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel现实对象，具体含义参见通用对象说明属性类型说明获取班级家长动态接口函数原型stringGetDynamicPersonalListByParentsByClass(stringaccesstoken,intdynamicID,inttopCount,stringclasscode,intreplyCount);说明获取班级家长动态（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint必填，为0时，获取最新的动态，不为0时获取该动态以后的动态topCount要获取动态的数量int必填classcode要获取的班级stringreplyCount每天动态带出的回复数int返回值说明：返回JSON格式返回JSON实例：同上JSON对象说明：返回DynamicPersonalShow现实对象，具体含义参见本页的通用对象说明属性类型说明获取个人动态接口接口函数原型stringGetDynamicPersonalListByPersona(stringaccesstoken,intdynamicID,inttopCount,intreplyCount)说明获取个人动态接口，采用瀑布流刷新，刷新节点是dynamicID，当dynamicID为0时获取最新的动态，不是0时，以该动态为基准获取该动态以后的动态（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint必填，为0时，获取最新的动态，不为0时获取该动态以后的动态topCount要获取动态的数量int必填replyCount要回去回复的数量int返回值说明：返回JSON格式返回JSON实例：同上JSON对象说明：返回DynamicPersonalShow现实对象，具体含义参见本页的通用对象说明属性类型说明获取单个动态信息接口函数原型stringGetDynamicPersonalByDynamicID(stringaccesstoken,intdynamicID,intreplyCount);说明获取单个动态信息（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint必填，为0时，获取最新的动态，不为0时获取该动态以后的动态replyCount要获取动态的数量int必填返回值说明：返回JSON格式返回JSON实例：同上JSON对象说明：返回DynamicPersonalShow现实对象，具体含义参见本页的通用对象说明属性类型说明家长发表动态的方法接口函数原型stringAddDynamicPersonalByParent(stringaccesstoken,stringdynamicText,boolisGrowMoment,stringdynamicPic)说明家长发表动态的方法（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicText动态的内容intisGrowMoment是否是成长瞬间BoolFalse不是，true是，默认不是dynamicPic动态图片的地址String暂时可以不写返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel参见通用对象属性类型说明老师发表动态的方法接口函数原型stringAddDynamicPersonalByTeacher(stringaccesstoken,stringdynamicText,stringdynamicPic,boolisClassNotice,stringclassID,inttopdays)说明老师发表动态的方法（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicText动态的内容intdynamicPic动态图片的地址String暂时可以不写isClassNotice是否是班级通知BoolFalse不是，true是，默认不是classID要发布的班级String当作为班级通知时此项生效，如果要发布多班级，请用逗号隔开如：BH0001,BH00002topdays顶置的天数int当作为班级通知时此项生效返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel参见通用对象属性类型说明动态转发接口函数原型stringDynamicPersonalForward(stringaccesstoken,stringdynamicText,intforwardID）说明转发动态，注意：如果转发动态时，当前转发的动态是原创的则forwardID是当前动态ID，如果是转发别人的，则forwardID是转发动态的ID不是当前动态ID（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicText添加转发的内容intforwardID转发动态的IDint如果转发动态时，当前转发的动态是原创的则forwardID是当前动态ID，如果是转发别人的，则forwardID是转发动态的ID不是当前动态ID返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel参见通用对象属性类型说明删除自己的动态接口函数原型stringDeleteDynamicPersonal(stringaccesstoken,intdynamicID）说明删除自己的动态（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID添加转发的内容int返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel参见通用对象属性类型说明获取动态的回复接口接口函数原型stringGetDynamicPersonalReply(stringaccesstoken,intdynamicID,intcommentID,inttopCount）说明获取动态的回复接口，ReplyerPersonal属性有值时,说明是某某回复某某（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint获取哪一条动态的回复commentID回复的idint为0时，获取最新的动态回复，不为0时获取该动态以后的动态回复topCountint获取回复动态的条数返回值说明：返回JSON格式返回JSON实例：[{"ShowName":null,"Personal":null,"ReplyCommentID":0,"CommentID":6,"PersonalID":"Z2dzb3BlbmlkIzEyMjQ0MQ==","ReplyerID":"","ReplyerPersonal":null,"ReplyerShowName":null,"CreateTime":"/Date(1393294131000)/","CommentText":"我的动态回复222","ModuleID":1,"ModuleIndexID":11,"CommentState":1,"ChildList":[]},{"ShowName":null,"Personal":null,"ReplyCommentID":0,"CommentID":5,"PersonalID":"Z2dzb3BlbmlkIzEyMjQ0MQ==","ReplyerID":"","ReplyerPersonal":null,"ReplyerShowName":null,"CreateTime":"/Date(1393294123000)/","CommentText":"我的动态回复","ModuleID":1,"ModuleIndexID":11,"CommentState":1,"ChildList":[{"ShowName":null,"Personal":null,"ReplyCommentID":5,"CommentID":7,"PersonalID":"Z2dzb3BlbmlkIzEyMjQ0MQ==","ReplyerID":"Z2dzb3BlbmlkIzEyMjQ0MQ==","ReplyerPersonal":null,"ReplyerShowName":null,"CreateTime":"/Date(1393294313000)/","CommentText":"回复的回复","ModuleID":1,"ModuleIndexID":11,"CommentState":1,"ChildList":null}]}]JSON对象说明：返回PersonalComment参见通用对象属性类型说明添加动态回复接口函数原型stringAddDynamicPersonalReply(stringaccesstoken,intdynamicID,stringcommentText,,stringreplyerID）说明添加动态回复（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint回复的动态commentText回复的内容string回复的内容replyerID回复某人的IDint1.4新加，没有回复人时可以填写空字符串返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel参见通用对象属性类型说明按班级获取所有动态接口接口函数原型stringGetDynamicPersonalListAllByClass(stringaccesstoken,intdynamicID,inttopCount,stringclasscode,intreplyCount）说明添加动态回复（参数说明）名称说明数据类型长度备注accesstoken用户标识stringdynamicID动态IDinttopCount带出动态的数量intclasscode班级代码stringreplyCount要带出主回复的数量int返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回DynamicPersonalShow参见本页通用对象属性类型说明按班级获取老师动态接口接口函数原型stringGetDynamicPersonalListByTeacherByClass(stringaccesstoken,intdynamicID,inttopCount,stringclasscode,intreplyCount）说明添加动态回复（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint基准ID,给0的时候获取所有,topCount带出动态的数量int回复的内容classcode班级代码stringreplyCount要带出主回复的数量int返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回DynamicPersonalShow参见本页通用对象属性类型说明动态收藏接口函数原型stringDynamicPersonalCollect(stringaccesstoken,intDynamicID）说明动态收藏,如果是转发的,则输入转发的ID（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint要收藏的动态ID，如果是转发的,则输入转发的ID返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel参见通用对象属性类型说明动态点赞接口函数原型stringDynamicPersonalGooD(stringaccesstoken,intdynamicID）说明动态点赞（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint点赞的动态返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel参见通用对象属性类型说明获取其他人的动态接口接口函数原型stringGetDynamicPersonalListByOther(stringaccesstoken,stringpersonalID,intdynamicID,inttopCount,intreplyCount);说明获取其他人的动态接口（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定personalID要查看某人的用户IDstringdynamicID动态IDint必填，为0时，获取最新的动态，不为0时获取该动态以后的动态topCount要获取动态的数量int必填replyCount要回去回复的数量int返回值说明：返回JSON格式返回JSON实例：同上JSON对象说明：返回DynamicPersonalShow现实对象，具体含义参见本页的通用对象说明属性类型说明外部接口见外部接口规范【宜昌智慧校园管理与应用系统】内部接口接口重用该对象DynamicPersonalShow，接口重用该对象（动态显