信息发布系统详细设计文档
数据库操作类(包括静态方法)
6
信息发布系统详细设计文档
3.7存储分配
本程序在高级语言JAVA进行编码,直接的内存分配由JAVA运行时分配。 本组件内所依赖的变量、结构要求全部在组件元素内申明。
3.8注释
在代码的适当出有中文代码注释。
注释设计请参考《Visual Basic 可视化程序设计》的附录部分。
3.9限制条件
所有用户的权限都经过严格设置,不能进行权限外的操作。用户组分为三组:管理员,用户和游客。
3.10测试计划
测试日期、测试人员安排请参考测试计划,测试用例的具体内容,请参考测试用例说明。
3.11尚未解决的问题
在文件中存储文档文件中,不能存储文件名相同,但类型不同的文档。可以通过在文件名中加入文档类型来解决。但因时间关系,尚未解决。
第四部分、其它附加功能及帮助系统
4.1 程序描述
本程序设计是客户机和服务器机通过C/S模式,建立连接。在此基础上,进行信息的共享,发布等功能。系统的目的是为了方便用户的沟通。
4.2 功能
主要功能就是给用户带来信息的沟通,交流的便捷。
7
信息发布系统详细设计文档
4.3 性能
灵活性:响应鼠标操作和键盘操作。 时间性:视网络响应速度而定。
4.4 输入输出项
从键盘,鼠标按提示输入。
依服务器响应从界面输出响应信息。
4.5 限制条件
在界面上控制输入输出,服务器端如果出错也会返回出错信息。
5 设计特点 5.1 通信便捷
本系统客户端与服务器端采用JSON格式作为信息载体,在开发中将信息作为对象,信息传递很便捷。
5.2 开发速度快
由于使用通信协议约定,所以只要客户端与服务器端约定好通信协议API文档,即可以进行通信。而且直接对对象操作,不存在类型转换的问题。这样可以使客户端与服务器端开发同时在API文档的约定下进行,提高开发效率。
第六部分、项目分工
王佳龙: 负责编写GUI部分代码,以及客户端部分的所有代码
戴清灏:编写服务器端代码,设计通信协议,以及对数据库的操作。负责编写详细设计文档。
8
信息发布系统详细设计文档
华从男:各方面知识全面,负责组织工作,在软件测试方面有一定的能力。在软件开发过程负责测试文档等文档的编写。 王玮柯:负责测试,组织工作。
附录:
服务器端操作API文档(最少需要的参数,如不全服务器会返回type=“0”的信息):
服务器和客户端之间的所有通信都封装在protocol对象中,通过对要发送的protocol对象进行set和get操作就可以通信。
验证用户,用户注册,更改密码,更新文档,新建文档,新建记录(包括浏览记录和回复记录),查看文档,删除文档,查看记录
1.验证用户
name,pass,LimitsOfAuthority
返回:如验证通过则返回type=“11”,不通过则返回type=“12”
2.用户注册
name,pass,LimitsOfAuthority
返回:如注册成功则返回type=“21”,不成功则返回type=“22”
3.更改密码
name,pass,newPass
返回:如更改成功则返回type=“31”,不成功则返回type=“32”
4.查看文档 filename(可选,如为“”则查询本类的所有文档,不带全部内容),filetype,replyAuthor(可选,如果filename不为“”则必须)
返回:如查看成功则返回则返回type=“41”,不成功则返回type=“42”;文档内容在content中,文档名列表在filenames[]中,对应的文档摘要在filesummaries[]中;回复内容在recordContents[]中,对应的回复作者在recordAuthors[]中
5.建立新文档
filename,filetype,content,author,filesummary
返回:如果建立成功则返回type=“51”,如不成功则返回type=“52”
9
信息发布系统详细设计文档
6.修改文档
filename,filetype,newFilename,newFiletype,filesummary 返回:如果修改成功则返回type=“61”,如不成功则返回type=“62”
7.建立新记录
filename,filetype,recordContent,replyAuthor
返回:如果建立成功则返回type=“71”,如不成功则返回type=“72”
8.删除文档
filename,filetype
返回:如查询成功则返回type=“81”,如不成功则返回type=“82”
9.查看浏览记录 无
返回:如查看成功则返回type=“91”,如不成功则返回type=“92”,返回的记录内容在recordContents[]中,对应的作者在recordAuthors[]中
10