聊天室设计报告

网络聊天系统设计报告组长：靳子豪组员：冯凯强、许玉军、王明明完成时间：2015年11月3日一、可行性研究报告可行性研究报告(ISO标准)编者说明：在立项时，应该对项目进行综合分析，探讨项目的经济、社会、技术可行性，从而为决策提供基础。该模板为ISO标准文档模板，其不仅适用于软件项目，对于其它的系统项目也适用。1．引言1.1编写目的该聊天室项目可行性研究报告是对项目课题的全面考虑，是项目分析员对下一步工作进行的前提，是软件开发人员正确成功开发项目的前提与基础。写可行性研究报告可以使软件开发团体尽可能早的估计研究课题的可行性，较早的认识到系统方案的缺陷，可以少花时间和精力，也可减少成本资金，避免专业性的问题。1.2背景a. 待开发系统的名称：信息交流系统b用户：大众c.它基于web小浏览器的程序系统的设计与开发，服务平台：appserv-win开发语言：PHP数据库：MYSQL1.3定义技术可行性：分析功能，性能以及限制条件，能否是一个技术上可实现的系统经济可行性：估计开发费用已及最终从开发成功的系统所获得的收入或利益，衡量比较支出的费用和收到的利益1.4参考资料《软件工程导论》（第6版）清华大学出版社张海藩牟永敏编著可行性研究的前提2.1要求聊天室功能用户的聊天功能，包括数据输入、修改、删除，并要达到界面美观又好、使用方便软件的性能开发该软件应具有的基本要求与功能是实现用户信息数据包括与用户有关的数据的管理与操作处理，基于MYSQL的数据库的数据管理使该软件有更优异的性能，软件的基本数据流动为用户数据的输入，用户信息及数据的输出。输出用户基本信息和聊天内容输入用户根据自身需要，发起聊天e、安全保密方面的要求设置管理员2.2目标 该软件的设计目标必须尽量达到人力与设备费用的节省，软件的整个设计过程必须通过生产能力的提高、人员工作效率的提高等等使软件开发成本最小化。2.3条件、假定和限制a、本聊天室建议使用寿命为5-10年 b、法律方面的限制：（1）、严禁危害国家信息安全（2）、严禁损害国家荣誉和利益（3）、严禁传播不良信息（5）、严禁抄袭2.4进行可行性研究的方法成本效益分析、对估算问题的看法、软件的作用范围、软件的成本估算、速度安排3．对现有系统的分析3.1处理流程和数据流程该系统的数据处理与流程基本为用户数据录入与查询，管理员删除等，流程图如下:更改密码更改密码普通用户管理普通用户管理删除记录删除记录用户用户管理管理员管理管理员管理管理管理用户图1.处理流图3.2人员鉴于该系统的技术含量比较低，故不需要高技术人才。3.3设备设备的科技含量也比较低，没有达到计算机大量普及的地步。3.4局限性经研究分析，可知原有的系统存在很大的局限性，比如技术过于陈旧，人员工作负荷大，系统维护方面存在很多局限性。4．所建议的系统4.1对所建议系统的说明网络聊天室主要是用户的聊天功能，包括数据和文本的传输、修改、删除等功能，要能高效、准确地完成这个功能，使使用方便。4.2处理流程和数据流程，如下所示：管管理员聊天室服务聊天室服务器增加用户删除用户回复发言单用户单用户a单用户b发信息图2.处理流图4.3技术条件方面的可能性以现有的技术与开发人员的数量和质量条件下，可在规定的期限内完成该系统的开发5．投资及效益分析5.1支出5.1.1房屋和设备3万环境保护设备1万安全与保密设备1万数据库管理软件1万5.1.2研究费用3万数据库建立1.5万开发人员一次性支出5000元5.1.3设备维护费用1000元软件维护100元人员工资2000元房屋、水电费500元网络杀毒软件100元5.2收益5.2.1一次性收益运行效益3万应用系统价值的增值引起的收益5万设备出售回收的收益5000元5.2.2系统维护2000元6．社会因素方面的可能性6.1（1）、严禁危害国家信息安全、泄露国家秘密（2）、严禁损害国家荣誉和利益（3）、严禁传播不良信息（5）、严禁抄袭6.2.经过管理员的同意者可以使用7．结论经过各方面的可行性分析，各成员对需要解决的问题取得基本一致看法，开发方案得到批准，开发工程继续进行下去。二、需求规格说明书需求规格说明书(ISO标准版)编者说明：当需求调查、分析工作告一段落时，你就需要将这些需求进行规格化描述，整理成文，即软件需求规格说明书，也就是SRS。这是在软件项目过程中最有价值的一个文档。ISO所提供的标准虽然已经时间久远，但还是颇具参考价值的。1．引言1.1编写的目的随着互联网的迅速普及，以及网络技术的不断发展，人们通过网络的交流方式不断发展。网络聊天室就是其中的一种。聊天室的系统即使交流的方式满足了网络中多人同时交流的需要。本设计所完成的聊天室具有常用聊天室的所有功能。包括多人在线的同时聊天，两人间的私密聊天。在聊天的时候可以发送表情，还能显示在线用户数量，满足了不同人群的交流方式。1.2背景a. 待开发系统的名称：聊天室b用户：大众c.它基于web小浏览器的程序系统的设计与开发，服务平台：appserv-win开发语言：PHP数据库：MYSQL1.3定义客户端、服务器、数据设计、数据通信、1.4参考资料《软件工程导论——第4版》张海藩编著清华大学出版社 《软件工程实践导论：有关方法、设计、实现、管理之三十六计》金尊和编著清华大 学出版社《实用软件工程》LeszekA.MaciaszekBrucLeeLiong著机械工业出版社2．任务概述2.1目标主要是设计一个基于WINDOWS平台的局域网即时聊天工具，利用各种平台上的网络通信接口，构建基于下层TCP/IP的原件产品，在局域网内，这些功能的实现跟广域网比较就很简单，但仍然很有研究价值。2.2假定和约束首先程序要完全可靠，可以应付系统问题产生的各种错误。要求前提设想到类似尽可能多的可能发生的各种事件并做出相应的应对措施，并为用户提供简单易懂清晰明白的提示信息。程序要有良好的容错性，当用户进行非法操作时或系统本省出现问题时能以最好的方式退出程序，避免发生假死的现象。3．需求规定3.1对功能的规定用户端之间的信息发送，是本程序实现的基本的功能。显示在线用户的数量。在C/S模式中，服务器与客户端时相互依赖的。在使用过程中，客户端在指定时间内未向服务器端发送信息的，服务器认为客户端下线聊天室具有常用聊天室的所有功能。包括多人在线的同时聊天，两人间的私密聊天。在聊天的时候可以发送表情，还能显示在线用户数量，满足了不同人群的交流方式。用户基本信息和发言内容，用户根据自身需要，发表言论，3.2对性能的规定精度按相关提示输入时间特性要求运行的时间：a,登录模块小于5秒b.在线用户模块小于5秒c.聊天功能模块小于5秒d.退出模块小于5秒响应时间：所有的发送操作响应时间一般不超过7秒，大量的信息发送，呈现应该在提示10秒内显示或者提示相关出错信息。更新处理时间：所有提交的数据一般都在10秒内相应。灵活性用户做发出某些控制动作（如按回车键，单击或右击）时，都要相应得到回复。3.3输入输出要求输入：编辑用户的个人信息以及各用户之间的即时聊天内容输出：显示相应的用户信息以及对相应的用户的聊天内容3.4数据管理能力要求（针对软件系统）能及时更新相关的数据库信息，3.5故障处理要求聊天记录及配置文件必须按日、按周进行及时的备份4．运行环境规定4.1设备a. 处理器型号：英特尔酷睿I3/5内存容量：2Gb. 外存容量：8 Gc. 输入及输出设备的型号:WINDOWS平台和数量，联机4.2支持软件选择好的操作系统和编程语言是系统优劣的关键，该设计在Wins平台下运行，利用基于服务器的软件，面向对象的可视化软件开发与程序运行，功能强大，开发效率比较高。它不仅是网络环境下优秀前段开发语言和工具，也是服务器WEB编程的优秀工具。操作系统：winsxp以及以上的系统开发工具：appserv-win+mysql4.3接口a.用户接口：本系统采用图形用户接口，以鼠标和键盘为用户接口，方便用户对系统数据的操作。b.外部接口：保持一致性：界面规范应遵循WINDOWS软件界面的规范完整的对话过程：系统的每一次通信都有一个明确的次序，有开始到中间处理过程再到结束。设计良好地联机帮助：画面简介清晰明快。c.硬件接口：支持一般的pc机，笔记本电脑d.软件接口：本产品能在windows及以上的系统运行4.4控制a.在用户登录成功后，进入聊天平台主界面，b.通过菜单选择特定的功能模块，c.结束程序运行。三、数据要求说明书编者说明：如果在你的项目中有大量要求数据存储、数据采集等方面的需求，那么你就应该专门将这些需求进行整理，以数据要求说明书的形式表现出来。1．引言1.1编写目的目的：明确《php聊天室》中各项功能和非功能实现时所需要的数据，并可以以此数据为依据设计数据库。同时为概要设计和详细设计人员提供设计依据。预期读者：参与聊天室开发的同学。1.2背景a. 待开发系统的名称：交流系统b.用户：大众c.它基于web小浏览器的程序系统的设计与开发，服务平台：appserv-win开发语言：PHP数据库：MYSQL1.4参考资料《软件工程导论——第4版》张海藩编著清华大学出版社 《软件工程实践导论：有关方法、设计、实现、管理之三十六计》金尊和编著清华大 学出版社《实用软件工程》LeszekA.MaciaszekBrucLeeLiong著机械工业出版社2．数据的逻辑描述静态数据：所谓静态数据，指在运行过程中主要作为参考数据，他们在很长的一段时间内不会变化，一般不随运行而改变。动态数据：包括所有运行中发生变化的数据以及在要输入，输出的数据。2.1静态数据用户个人信息，管理员信息。2.2动态输入数据用户输入的信息2.3动态输出数据输出信息2.4数据约定合法的数据输入范围。3．数据的采集3.1要求和范围1、输入数据的来源：用户的输入信息。2、数据输入所用的媒体和硬设备：键盘。3、接受者说明输出数据的接受者：信息接收用户。4、输入和输出数据形式和硬设备：文字信息，文件信息。5、数据值的范围给出每一个数据元的合法值范围：合理的数据输入范围内。3.2输入的承担者此软件没有固定的输入承担者，其输入的相应数据都是由通信用户双方来完成。3.3预期处理在这里预处理的数据包括，默认坚挺的服务器ip和端口号，以及监听状态的标志位和数据库名称。3.4影响1、设备2、现有软件能够运行MYSQL3、用户建议系统使用的新技术是完全基于原有的系统上的，故用户不必考虑系统带来的人员培训等。概要设计编者说明：这是ISO提供的规范，是最原始的概要设计说明书的编写格式，其适用于结构化设计思想下的软件设计，不过其中还是有很多具有参考价值的内容。1．引言1.1编写目的本报告以实现聊天室功能为目的，对该系统如何实现各业务环节以及功能如何划分做了概要性的说明。通过该报告能够使详细设计人员和开发人员了解本系统的体系结构、技术方案、软件的功能结构、各业务间的数据接口、数据库结构等，并对整个系统的功能实现按照功能模块进行了较为详细的划分和描述，为下一步的开发任务指明了方向，提出了纲要。1.2背景a.待开发软件系统的名称：交流系统b.用户：大众1.3参考资料《软件工程导论——第4版》张海藩编著清华大学出版社 《软件工程实践导论：有关方法、设计、实现、管理之三十六计》金尊和编著清华大 学出版社《实用软件工程》LeszekA.MaciaszekBrucLeeLiong著机械工业出版社2．总体设计2.1需求规定系统功能，如图3在线聊天平台在线聊天平台显示在线用户显示聊天信息用户注册注用户登录陆私聊群聊显示在线用户显示聊天信息用户注册注用户登录陆私聊群聊用户退出图3.系统功能图系统性能.1精度按相关提示输入.2时间特性要求响应时间，所有的发送操作响应时间一般不超过7秒，大量的信息发送，呈现应该在提示10秒内显示或者提示相关出错信息。更新处理时间，所有提交数据一般在10秒内响应。.3可靠性该系统应该保证用户信息的安全性.4灵活性可以随意更改个人资料，指定人进行私聊输入输出要求输入：修改个人资料信息，及发送信息内容输出：信息修改成功界面数据管理能力要求及时更新数据，保证数据的安全可靠故障处理要求聊天记录及配置文件必须按日、按周进行及时的备份2.2运行环境设备开发该系统应尽可能采用高档的硬件。因此，在应用时应采用更好的配置。处理器：酷睿I5内存：2G或更高。网络：局域网。支持软件操作系统：WindowsXP或Window2000。接口外部接口1.尽量保持一致性：界面规范应遵循Winows软件界面的规范2.设计完整的对话过程：系统的每d一次对话都应该有明确的次序：开始、中间处理过程、结束。3.提供简单的错误处理机制硬件接口支持一般的PC机，笔记本电脑软件接口本产品只能在Windows2000及以上windows系列操作系统运行2.2.4控制接口=1\*alphabetica、在用户登陆成功后，进入聊天平台主界面=2\*alphabeticb、通过菜单选择特定的功能模块=3\*alphabeticc、结束程序运行2.3基本设计概念和处理流程服务器总体结构，： 服务器聊天室聊天室客户端客户端显示在线用户显示在线用户客户端发送消息客户端发送消息接收并显示消息接收并显示消息图4.结构图操作流程：如图5所示：开始开始输入用户名和密码选择角色输入用户名和密码选择角色判断输入是否正确判断输入是否正确N进入聊天室进入聊天室 Y选择聊天对象选择聊天对象结束结束图5.操作流程图数据流程图，如图6所示：登陆注册注册新账户登陆注册登陆注册登陆注册新账户信息资料不资料检查合法资料检查账号密资料码信息合法账号资料库账号资料库不正确登陆成功 及用户信息数据库用户操作数据信息数据库用户操作个人资料资料信息查看修改资料退出信息查看修改资料在线用户信息聊天信息退出平台聊天列表退出平台聊天列表聊天内容聊天内容公私聊图6.数据流程图2.5功能需求与系统模块的关系，如表1所示登陆注册模块聊天模块在线用户模块退出模块注册√登陆√√私聊√公聊√查看聊天记录√选择表情√显示在线好友√修改个人资料√退出聊天平台√表1.功能需求与系统模块的关系表2.6人工处理过程注册和修改个人资料2.7尚未解决的问题查看个人资料和修改个人资料，发送文件3．接口设计3.1用户接口提供一个用户操作界面：包括用户可以在界面中登陆聊天室、输入消息、浏览聊天内容和聊天对象。以鼠标和键盘为用户接口，方便用户对系统数据的操作。4．运行设计4.1运行模块组合客户端：1、登录模块能够存储一定数量的用户档案信息，并方便有效地进行相应数据操作和管理，主要包括：用户的登录、注册、密码修改；管理员登录、注册、密码修改；2、在线用户模块用户通过该用例对该用户好友进行管理，主要包括：（1）显示在线好友（2）查看和修改个人信息3、聊天功能模块（1）与好友进行即时聊天（2）在聊天室中进行多人聊天（3）好友之间可以进行信息的发送与接收4.退出模块(1)实现用户退出功能后台系统：1、系统管理对系统进行维护，或添加、删除修改各个功能模块，主要包括：（1）系统的维护；（2）添加、删除、修改各个功能模块；2、公告管理向用户进行广播操作。主要包括：（1）向用户进行广播宣布系统维护，系统更新；（2）向用户发布公共话题或资料，供用户讨论或给大部分用户提供需求资料；3、用户管理通过管理员对用户进行管理，主要包括：（1）系统管理员完成对用户账号的管理，可以添加，删除用户；（2）对用户上传的文件进行管理，可以删除、打开或下载文件；4.2运行控制在客户端登录后直接进入主界面结束程序运行4.3运行时间本系统的各个模块之间功能是相互联系的，故各模块占用各种资源的时间是累计的，所以运行时间由用户的操作和网络的运行速度决定。登录模块小于5秒在线用户模块小于5秒聊天功能模块小于5秒D.退出模块小于5秒5．系统出错处理设计5.1出错信息，如表2所示错误原因处理方法用户没有输入用户名系统提示：“请输入登录名称！”用户输入的昵称与已登录用户同名系统提示：“该名已被使用！”发送空语句系统提示：“不能发送空语句！”表2.出错信息表5.2补救措施对一般错误，给用户提示信息，让用户重新输入或退出。五、详细设计文档编者说明：概要设计通常是项目中专门的人员完成，是对系统的高层描述，而详细设计的任务则通常由每一个任务实施人来完成，其是对某个具体的模块、类等局部元素的设计描述。该模板是ISO推荐的格式，其仍然是以结构化设计为主要思想。1.引言1.1编写目的本文档是为了初步明细项目功能模块，便于下一步的代码实现。预期读者：参与聊天室开发的同学。1.2背景a. 待开发系统的名称：交流系统b.用户：大众1.3定义SQLSERVER:系统服务器所使用的数据库管理系统（DBMS）。SQL:一种用于访问查询数据库的语言事务流：数据进入模块后可能有多种路径进行处理。主键：数据库表中的关键域。值互不相同。外部主键：数据库表中与其他表主键关联的域。ROLLBACK:数据库的错误恢复机制。1.4参考资料《软件工程导论——第4版》张海藩编著清华大学出版社 《软件工程实践导论：有关方法、设计、实现、管理之三十六计》金尊和编著清华大 学出版社《实用软件工程》LeszekA.MaciaszekBrucLeeLiong著机械工业出版社2.系统的结构软件结构：登录界面2.主面板3.用户列表4.聊天窗口3．模块1（标识符）设计说明3.1功能1.注册注册新账号，用户从申请账号页面填写必要的信息，申请账号。服务器收到注册请求后，并将用户填写的信息保存至数据库中。2.登录3.增删用户3.2性能时间特性耍求响应时间：所有的发送操作响应时间一般不超过7秒，大量的信息发送，呈现应该在10秒内显示或者提示相关出错信息。更新处理时间：所有提交数据一般在10秒内相应。故障处理要求：聊天记录及配置文件必须按日、按周进行及时的备份。精度：按相关提示输入。3.3输入项默认扫描当前IP段，输入需要发送的消息内容，点击发送按钮、点击是或否按钮或按回车键。3.4输出项在对话框中的消息记录中显示聊天记录，在消息记录中显示聊天记录。3.5流程逻辑，如图7所示开始开始输入用户名和密码选择角色输入用户名和密码选择角色判断输入是否正确判断输入是否正确N进入聊天室 Y进入聊天室选择聊天对象选择聊天对象结束结束图7.流程图3.6接口1.登录输入：用户账号（有数字组成）输出：界面显示2.注册输入：注册用户资料（用户名，密码）输出：注册成功界面3.聊天输入：聊天信息输出：好友恢复的信息4.显示用户列表输入：用户的登陆信息输出：显示在线用户5.资料修改输入：修改个人资料信息输出：信息修改成功界面6.退出输入：退出命令3.7测试计划一、环境配置测试网络连接是否正常网络流量负担是否过重软件测试平台是否可选。如果（3），是否在不同的软件测试平台进行软件测试所选软件测试平台的版本是否正确所选软件测试平台的参数设置是否正确所选软件测试平台上正在运行的其它程序是否会影响测试结果二、代码测试静态测试（1）同一程序内的代码书写是否为同一风格（2）代码布局是否合理、美观（3）程序中函数、子程序块分界是否明显（4）注释是否正确反映代码的功能（5）变量定义是否正确（长度、类型、存储类型） （6）是否引用了未初始化变量（7）数组和字符串的下标是否为整数 （8）数组和字符串的下标是否在范围内（不“越界”）4．模块2（标识符）设计说明注册模块使用验证控制对部分内容进行验证，将注册的信息存储到已建好的数据库中，若键入的信息不符合要求需重新注册，注册成功后站到登录页面。登录模块已经注册成功的用户（数据库中已经存储其注册信息）输入正确的用户名和密码后就可以进入聊天室，未注册的系统自动返回注册页面，要求用户进行注册聊天模块私聊和公聊退出模块退出该系统六、软件测试报告软件测试报告项目名称：网络聊天系统安装：（1）程序运行环境已经正确设定是□否程序代码检查：（1）程序单位首部有程序说明和修改备注□（2）变量、过程、函数命令符合规则□（3）程序中有足够的说明信息□（4）修改注释符合要求□（5）类库的使用符合要求□画面及报表格式检查：（1）画面和报表格式符合规定需求□（2）程序命名符合格式需求