《概要设计说明书【宜昌智慧校园管理与应用系统】.doc》由会员分享，可在线阅读，更多相关《概要设计说明书【宜昌智慧校园管理与应用系统】.doc（30页珍藏版）》请在三一办公上搜索。
1、概要设计说明书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单独获取通知回
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内部接口
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出错信息291 引言1.1 编写目的本文档是宜昌教育云 教师/家长前台提供给平台设计及研发人员使用，作为系统设计实施的依据。作为项目验收标准之一。软件维护的参考资料。1.2 背景为进一步实现“教育公开”的要求，同时方便各类教育信息能准确、安全、快速的发布到指定的用户层面上，同时推进教育信息办公效率，在调研大量
4、学校用户（教师、学校中层干部及校领导）和家庭用户的基础上，建立本项目研发的设计需求根据宜昌市教育及教育信息化发展现状和发展需要， 基于政府有关系统和宜昌教育公共服务平台基础数据库，建设贯穿全市各级幼儿园、小学、初中、高中（职校）、教育管理部门的智慧校园管理与应用系统，开展教育管理和教学的各项应用。宜昌教育的基本情况：高等教育：全市有普通高等学校5 所（三峡大学、三峡大学科技学院、三峡职业技术学院、三峡电力职业学院、三峡旅游职业技术学院），全日制在校生 56588 人，教职工6322人，其中专任教师 3510 人;高等教育成教生28644 人（含宜昌广播电视大学在校生 6093 人），市电大教职
5、工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%，
6、师生比1：13，高中阶段毛入学率 95%，初中毕业生升入高中阶段教育的比例97%。有幼儿园 383 所，在园幼儿 78499 人，幼儿园教职工7674 人，学前三年幼儿入园率 76%，学前两年幼儿入园率 89%，学前一年幼儿入园率100%。有特殊教育学校9 所，招收残疾少年儿童 150。该系统建设完成之后，将部署在宜昌电子政务云平台上，从硬件、网络条件而言，就具备了和宜昌电子政务云深度融合的相应条件。而从教育从业者和广大学生家长的实际需求出发，将会使教育信息化的应用真正落在实处。在该系统开发的设计和开发过程中，应该在系统的底层标准化设计、接口开发性、功能与服务模块化以及用户交互体验重点考虑。具
7、体而言，由于该系统的建设是以平台级系统来加以定位，系统要面对“局、校、班、师、家、生”等多重不同角度的用户，涉及用户基础信息繁多复杂，这要求设计者要认真研究用户基础数据特征，提出完整、标准且有可扩性的数据结构体系。其次，不同层级和角色的需求也各不相同，功能和服务也会具有需求多样性和流程多样性，而合理的理解并设计各种基本功能和增值功能显得尤为重要，将功能和服务模块化，使流程可自由组合，使数据可相互复用，是对系统一个重要的考验指标。因此，接口开放性和功能服务的模块化是解决这些问题的关键点。1.3 定义学生信息管理系统：对学生的基本信息、课程选择、成绩的录入、修改、删除、查询等一系列的操作。1.4
8、参考文献C语言程序设计、软件工程软件需求 劳森（作者），刘晓辉（译者） 电子工业出版社实用软件工程第三版 殷人昆 清华大学出版社电子政务系统的需求分析甘明鑫，曹菁 机械工业出版社2 总体设计2.1 需求规定（1） 管理员能够方便的对信息进行添加、修改、查询、删除和汇总、通过条件选择查询所有信息、并进行排序。（2）可以将数据库发布到网上、进行资源共享。（3）学生可以在自己的权限内对信息进行访问、查询相关信息。（4）添加功能：管理员可以通过填写表格的形式输入学生成绩及相关信息。（5）修改功能：管理员通过条件查询所要修改的信息、然后对信息进行修改保存、系统会自动查找是否是重复信息。（6）删除功能：管
9、理员可以对数据进行删除操作。系统能够通过管理员的条件进行查找删除信息、确定删除则数据库自动删除。2.2 运行环境Visual Studio 6.02.3 基本设计概要和处理流程3 接口设计3.1 用户接口3.1.1 获取班级通知方法接口函数原型string GetClassNotice(string accesstoken, string classID, int topCount, int replyCount);说明获取班级通知方法（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定classID要获取的班级stringtopCount一次取得的条数
10、intreplyCount回复的条数int返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel现实对象，具体含义参见通用对象说明属性类型说明3.1.2 单独获取通知回复的方法接口函数原型string GetClassNoticeReply(string accesstoken, int noticeID, int commentID, int topCount);说明单独获取通知回复的方法（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定noticeID要获取的通知IDstringcommentID基准回复的IDint
11、topCount一次性取的条数int返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel现实对象，具体含义参见通用对象说明属性类型说明ObjPersonalComment回复的内容，具体含义参见通用对象说明3.1.3 单独获取通知回复的回复方法接口函数原型string AddClassNotice(string accesstoken, string noticeName, string noticeText, string classID, string noticePic, int topDays)说明单独获取通知回复的回复方法（参数说明）名称说明数据类型
12、长度备注accesstoken用户标识string必填，权限鉴定noticeName班级通知标题string可以不填noticeText班级通知内容intclassID要发布的班级IDintnoticePic图片topDays顶置的天数返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel现实对象，具体含义参见通用对象说明属性类型说明3.1.4 添加班级通知的一级回复接口函数原型AddClassNoticeReply(string accesstoken, int noticeID, string commentText, , string replyerID)
13、;说明添加班级通知的一级回复（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定noticeID要回复的班级通知的IDintcommentText回复的内容stringreplyerID回复某人的ID1.2新加，没有回复人时可以填写空字符串返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel现实对象，具体含义参见通用对象说明属性类型说明3.1.5 删除班级通知接口函数原型string DeleteClassNotice(string accesstoken, int noticeID);说明删除班级通知（参数说明）名称说
14、明数据类型长度备注accesstoken用户标识string必填，权限鉴定noticeID要删除班级通知的IDint返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel现实对象，具体含义参见通用对象说明属性类型说明3.1.6 取消自己顶置的班级通接口函数原型string CancelNotice(string accesstoken, int noticeID);说明取消自己顶置的班级通知（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定noticeID要取消顶置班级通知的IDint返回值说明：返回JSON格式返回JS
15、ON实例：JSON对象说明：返回TipsModel现实对象，具体含义参见通用对象说明属性类型说明3.1.7 获取班级家长动态接口函数原型string GetDynamicPersonalListByParentsByClass(string accesstoken, int dynamicID, int topCount, string classcode, int replyCount);说明获取班级家长动态（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint必填，为0时，获取最新的动态，不为0时获取该动态以后的动态to
16、pCount要获取动态的数量int必填classcode要获取的班级stringreplyCount每天动态带出的回复数int返回值说明：返回JSON格式返回JSON实例：同上JSON对象说明：返回DynamicPersonalShow现实对象，具体含义参见本页的通用对象说明属性类型说明3.1.8 获取个人动态接口接口函数原型string GetDynamicPersonalListByPersona (string accesstoken, int dynamicID, int topCount, int replyCount)说明获取个人动态接口，采用瀑布流刷新，刷新节点是dynamicI
17、D，当dynamicID为0时获取最新的动态，不是0时，以该动态为基准获取该动态以后的动态（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint必填，为0时，获取最新的动态，不为0时获取该动态以后的动态topCount要获取动态的数量int必填replyCount要回去回复的数量int返回值说明：返回JSON格式返回JSON实例：同上JSON对象说明：返回DynamicPersonalShow现实对象，具体含义参见本页的通用对象说明属性类型说明3.1.9 获取单个动态信息接口函数原型string GetDynamicPers
18、onalByDynamicID(string accesstoken, int dynamicID, int replyCount);说明获取单个动态信息（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint必填，为0时，获取最新的动态，不为0时获取该动态以后的动态replyCount要获取动态的数量int必填返回值说明：返回JSON格式返回JSON实例：同上JSON对象说明：返回DynamicPersonalShow现实对象，具体含义参见本页的通用对象说明属性类型说明3.1.10 家长发表动态的方法接口函数原型string
19、 AddDynamicPersonalByParent (string accesstoken, string dynamicText, bool isGrowMoment, string dynamicPic)说明家长发表动态的方法（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicText动态的内容intisGrowMoment是否是成长瞬间BoolFalse不是，true是，默认不是dynamicPic动态图片的地址String暂时可以不写返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel 参见通用
20、对象属性类型说明3.1.11 老师发表动态的方法接口函数原型string AddDynamicPersonalByTeacher (string accesstoken, string dynamicText, string dynamicPic, bool isClassNotice,string classID,int topdays)说明老师发表动态的方法（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicText动态的内容intdynamicPic动态图片的地址String暂时可以不写isClassNotice是否是班级通知Bool
21、False不是，true是，默认不是classID要发布的班级String当作为班级通知时此项生效，如果要发布多班级，请用逗号隔开如：BH0001,BH00002topdays顶置的天数int当作为班级通知时此项生效返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel 参见通用对象属性类型说明3.1.12 动态转发接口函数原型string DynamicPersonalForward (string accesstoken, string dynamicText, int forwardID）说明转发动态，注意：如果转发动态时，当前转发的动态是原创的则forw
22、ardID是当前动态ID，如果是转发别人的，则forwardID是转发动态的ID不是当前动态ID（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicText添加转发的内容intforwardID转发动态的IDint如果转发动态时，当前转发的动态是原创的则forwardID是当前动态ID，如果是转发别人的，则forwardID是转发动态的ID不是当前动态ID返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel 参见通用对象属性类型说明3.1.13 删除自己的动态接口函数原型string DeleteDynam
23、icPersonal (string accesstoken, int dynamicID ）说明删除自己的动态（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID添加转发的内容int返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel 参见通用对象属性类型说明3.1.14 获取动态的回复接口接口函数原型string GetDynamicPersonalReply (string accesstoken,int dynamicID, int commentID, int topCount）说明获取动态的
24、回复接口，ReplyerPersonal属性有值时,说明是某某回复某某（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint获取哪一条动态的回复commentID回复的idint为0时，获取最新的动态回复，不为0时获取该动态以后的动态回复topCountint获取回复动态的条数返回值说明：返回JSON格式返回JSON实例： ShowName: null, Personal: null, ReplyCommentID: 0, CommentID: 6, PersonalID: Z2dzb3BlbmlkIzEyMjQ0MQ=,
25、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: , Reply
26、erPersonal: 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=, Reply
27、erPersonal: null, ReplyerShowName: null, CreateTime: /Date(1393294313000)/, CommentText: 回复的回复, ModuleID: 1, ModuleIndexID: 11, CommentState: 1, ChildList: null JSON对象说明：返回PersonalComment参见通用对象属性类型说明3.1.15 添加动态回复接口函数原型string AddDynamicPersonalReply (string accesstoken,int dynamicID, string commentTe
28、xt, , string replyerID）说明添加动态回复（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint回复的动态commentText回复的内容string回复的内容replyerID回复某人的IDint1.4新加，没有回复人时可以填写空字符串返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel 参见通用对象属性类型说明3.1.16 按班级获取所有动态接口接口函数原型string GetDynamicPersonalListAllByClass (string accessto
29、ken, int dynamicID, int topCount, string classcode, int replyCount）说明添加动态回复（参数说明）名称说明数据类型长度备注accesstoken用户标识stringdynamicID动态IDinttopCount带出动态的数量intclasscode班级代码stringreplyCount要带出主回复的数量int返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回DynamicPersonalShow参见本页通用对象属性类型说明3.1.17 按班级获取老师动态接口接口函数原型string GetDynamicPer
30、sonalListByTeacherByClass (string accesstoken, int dynamicID, int topCount, string classcode, int replyCount）说明添加动态回复（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint基准ID,给0的时候获取所有,topCount带出动态的数量int回复的内容classcode班级代码stringreplyCount要带出主回复的数量int返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回DynamicP
31、ersonalShow参见本页通用对象属性类型说明3.1.18 动态收藏接口函数原型string DynamicPersonalCollect (string accesstoken, int DynamicID）说明动态收藏, 如果是转发的,则输入转发的ID（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint要收藏的动态ID，如果是转发的,则输入转发的ID返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel 参见通用对象属性类型说明3.1.19 动态点赞接口函数原型string Dyna
32、micPersonalGooD (string accesstoken, int dynamicID）说明动态点赞（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定dynamicID动态IDint点赞的动态返回值说明：返回JSON格式返回JSON实例：JSON对象说明：返回TipsModel 参见通用对象属性类型说明3.1.20 获取其他人的动态接口接口函数原型string GetDynamicPersonalListByOther(string accesstoken, string personalID, int dynamicID, int to
33、pCount, int replyCount);说明获取其他人的动态接口（参数说明）名称说明数据类型长度备注accesstoken用户标识string必填，权限鉴定personalID要查看某人的用户IDstringdynamicID动态IDint必填，为0时，获取最新的动态，不为0时获取该动态以后的动态topCount要获取动态的数量int必填replyCount要回去回复的数量int返回值说明：返回JSON格式返回JSON实例：同上JSON对象说明：返回DynamicPersonalShow现实对象，具体含义参见本页的通用对象说明属性类型说明3.2 外部接口见外部接口规范【宜昌智慧校园管理
34、与应用系统】3.3 内部接口3.3.1 接口重用该对象DynamicPersonalShow，接口重用该对象（动态显示）属性类型说明DynamicDynamic动态显示的对象PersonalPersonalModel发送人的对象，见通用对象，PersonalForwardPersonalModel转发的对象，如果Dynamic有转发动态则这里会有数据，反之就没有ShowNamestring动态显示的名字，如某某的家长ForwardNamestring转发的名字，如某某的家长，如果Dynamic没有转发对象这里也就没有3.3.2 接口重用该接口Dynamic，接口重用该对象（动态主体）属性类型说
35、明ReplyListPersonalComment回复的数据，参见通用对象GoodsCountint赞的人的数量DynamicIDint动态IDPersonalIDstring发布人IDDynamicTextstring动态的内容CreateTimestring发布时间DynamicTypeint动态的类型，客户端暂时可以不关注DynamicPicstring动态图片GooDPersonalNamestring咱的人的名字DynamicUpIDint转发的ID，如果有转发动态这不为0，DynamicStateint动态的状态，客户端暂时可以不关注DynamicForwardDynamic转发的
36、动态，可以为空，如果这个不为空，则是转发的动态，IsClassNoticeBoolFalse为动态，true为班级通知, 当为班级通知时,不显示赞,收藏,转发, 可以取消顶置4 运行设计4.1 权限管理系统 市管理员拥有创建区管理员的权限、区管理员拥有创建校管理员的权限 市管理员创建区管理员时选择新建的管理员的管理区域，输入帐号、密码，然后将帐号密码告知给对应的区管理员 区管理员创建校管理员时选择新建的管理员的管理学校，输入帐号、密码，然后将帐号，密码告知对应的校管理员 校管理员负责录入维护本校学生、教职工信息，负责维护学校基础信息权限管理功能权限图4.2 基础数据库机构管理： 机构管理只有市
37、管理员拥有新增与删除的权限 区管理员能够查看本区、查询、编辑本区所有的学校 校管理员只能查看、编辑本校的信息 市管理员通过组织机构代码从法人库获取学校基础信息机构管理功能权限图4.3 学生管理系统 校管理员通过学生身份证号获取学生基础信息 将学生设定到指定的班级 家长负责维护孩子的地址信息及部分基础信息，当存在地址与现住址不一致时，负责维护更新，网格员将根据新的地址线下核查学生管理系统功能权限图4.4 教职工管理系统 校管理员通过教职工身份证号获取教职工基础信息 将教职工中的教师设定到指定的班级 教职工负责维护自己的地址信息及部分基础信息，当存在地址与现住址不一致时，负责维护更新，网格员将根据
38、新的地址线下核查 当学生与教职工都绑定班级后，则学生与教师形成了关联关系 教职工信息管理权限图4.5 系统管理 市管理员负责维和配置各级管理员的权限 市管理员负责维护好数据字典，以为所用用户提供统一的数据选择系统管理功能权限图4.6 第三方应用系统使用权限根据角色不同可以使用不同的第三方应用第三方应用使用权限图4.7 管理员登录结构图4.8 前台用户登录结构图5 系统数据结构设计见数据库设计【宜昌智慧校园管理与应用系统】6 系统出错处理设计出错信息补救措施由于数据在数据库中已经有备份，故在系统出错后可以依靠数据库的恢复功能，并且依靠日志文件使系统再启动，就算系统崩溃用户数据也不会丢失或遭到破坏。但有可能占用更多的数据存储空间，权衡措施由用户来决定。对一般错误给用户提示信息，用户重新输入或退出。对于严重错误，启动备份文件恢复，建议使用帮助文件.
