基于局域网的即时通讯系统需求设计.docx

基于局域网的即时通讯系统需求设计文档信息：文档名称基于局域网的即时通讯系统需求说明书描述该文档描述基于局域网的即时通讯系统的需求，并对用户特点、功能、性能进行了定义。所有设计人员、开发人员、测试人员以及其他团队成员都应该以该文档作为产品的功能定义，并衍生出其他文档负责人状态项目组成：测试主管开发主管项目经理文档变更历史：时间修改人章节描述文档路径：相关文档：文档路径测试案例详细设计审核结果：审核人意见签名档全体团队测试团队目录基于局域网的即时通讯系统1需求说明书11引言11.1编写目的11.2范围11.3背景及概述11.4编写目标21.5编写原则21.6定义31.6.1即时通讯用户31.6.2即时通讯用户31.6.3即时通讯月度活跃用户31.6.4即时通讯软件最常使用用户31.6.5企业即时通讯32 任务概述32.1目标32.2用户的特点42.3 约束与假设43 需求规定43.1对功能的规定43.1.1系统功能结构43.1.2 登录模块63.1.3 系统信息管理模块83.1.4个人信息管理模块133.1.5文字聊天模块183.1.6 语音功能模块233.1.7视频功能模块273.2对性能的规定323.2.1精度323.2.2时间特性要求323.2.3灵活性323.3输人输出要求323.4数据管理能力要求324运行环境规定324.1设备324.2支持软件334.3接口334.4控制334.5故障处理要求335其他专门要求3334 软件需求说明书1引言本需求说明书，是为项目组成员在进行软件开发过程中规范自己的行为，提供全面的设计资料与设计思路。经过长时间的调研，与项目开发人员多次讨论，本说明书要考虑本系统规定的功能和性能。本说明书主要对客户的需求进行分析，归纳总结全部必要的过程细节，并给予清晰的表达，使之成为设计的依据。1.1编写目的此需求规格说明书对即时通信软件做了全面细致的用户需求分析，进一步定制软件开发的细节问题，对基于局域网的即时通讯系统的需求进行分析设计，明确所要开发的软件应具有的功能、性能与界面，使系统分析人员及软件开发人员能清楚地了解用户的需求，并在此基础上进一步提出概要设计说明书和完成后续设计与开发工作。1.2范围本文档的使用人员： 客户、业务人员公司管理层项目组所有成员1.3背景及概述随着网络技术的发展和网络的普及，网络给企业的管理带来了质的飞跃，同时也带来了便利便宜的即时沟通方法。对于商业活动而言，除了必须见面的会议外，利用即时通讯工具来实现网上即时通讯即是一种时尚，也是发展的一种潮流。 作为应用软件的一个重要分支，即时通讯(IM)软件自其产生开始就备受瞩目。即时通讯软件所构造的低成本实时性网上交流平台被广大互联网用户广泛使用。即时通讯软件的特点决定了它的普及性，成为了在互联网上和他人联系的重要方式。通过即时通讯软件，人们可以在发出消息后的很短时间内得到对方应答，积极互动，满足了人们几乎同步交流的需求。 目前中国的即时通讯软件主要面向的是个人用户，即时通讯软件的主导力量是个人即时通讯软件，而企业即时通讯软件市场还处于初步发展阶段。 即时通讯在中国企业中的应用比较广泛，但单独的企业即时通讯市场却还相对较小。大部分使用即时通讯的企业目前还是在使用公众即时通讯软件，而并没有特别的企业即时通讯解决方案。 从中国互联网近10年的发展历史来看，中国大部分的互联网服务和运营模式都是从国外的互联网应用中学来的，门户网站是如此，电子邮件是如此，即时通讯也不例外。在国内，自2000年之后，随着即时通讯用户数量和移动通信用户数量的逐渐增多，结合了互联网平台和移动通信平台特点的跨平台服务随之成为即时通讯用户的一个交流新工具。而以近两年互联网的整体的发展状态来看，Web2.0的大行其道，即时通讯和互联互通的客户端Web将成为即时通讯市场的一个新的增长点。1.4编写目标本说明书中将包括实现系统需求的各个细节问题，给设计人员一个清晰的思路，减少项目后期开发的风险。1.5编写原则统一规划、统一设计思想、统一信息交换标准，统一技术规范。最大限度地保护原有资源、并立足长远发展。应用系统工程的方法，根据实际业务需要，最优化地重组业务处理流程。应用成熟的先进技术实施系统 。统一组织，分层建设，注重实效。1.6定义1.6.1即时通讯即时通讯是一种便捷的网络通讯技术，是互联网的新形态通讯方式，透过计算机键盘或无线设备在网络上进行实时交谈， 是提供公共通讯、商务通讯及商务合作的新媒介， 可以弥补传统通讯形式的不足，尤其是电子邮件及语音的不足。1.6.2即时通讯用户过去一年内每月至少使用一次即时通讯软件的用户。1.6.3即时通讯月度活跃用户一个月内至少使用即时通讯软件10次的活跃用户。1.6.4即时通讯软件最常使用用户过年一年内最常使用即时通讯软件的用户。1.6.5企业即时通讯企业内部使用的即时、方便、安全、高效、维护成本低的即时通讯工具。2 任务概述2.1目标 此系统开发的目的是为了满足一个企业在不同地域的分公司与总公司的全体职员的互动交流，在企业内进行协同办公。 提高效率：利用软件进行通讯，减少消耗在交通上的时间以及费用，避免人工管理的失误以及延迟性，从而实现高效率的管理。2.2用户的特点基于局域网的即时通讯系统的最终用户是企业内部所有职员，用户通过系统的客户端进行通讯，相互交流。因此，使用本系统的用户一般是非计算机专业人士，他们用电脑进行一些日常的操作和工作的管理。维护人员由项目组的开发人员组成，由于他们对此系统足够了解，所以维护方面的问题不大。由于即时通讯的特殊性，基于局域网的即时通讯系统将在企业内部长期使用，其所提供的功能也会为企业工作效率的提高发挥重要作用。2.3 约束与假设3 需求规定 3.1对功能的规定3.1.1系统功能结构 登 录 界 面 设置 界面 会 话 界 面个人设置界面系统设置界面文字会话视频会话音频会话 图 3.1 总体功能示意图用例图图3.2 总用例图用例分析系统有两种不同的用户，即系统管理员和公司职员。系统管理员负责对该系统进行管理，主要功能是对公司现有职员信息进行更新和对系统数据进行维护。系统管理员可以修改公司职员的部分信息，新增和删除职员。公司职员能够登陆到系统与公司同事进行即时通信（文字会话、音频会话、视频会话等），职员还能够对自己的资料进行修改，同时能够查看其他同事的相关信息。3.1.2 登录模块用例图 图3.3 登录用例图用例分析用户在使用本系统前必须进行资格核查，包括系统管理员。核查的内容包括：用户ID和密码。在通过用户身份验证之后，系统将初始化该用户的基本信息（例如更新用户状态为上线、留言提示等）。（1）用户登录基本流程用户输入用户名、密码，然后点击登录按钮。用户登录系统后，会根据当前用户类别，如一般用户、管理员，显示不同的界面。在稍后的操作中，根据用户类型控制权限。分支流程1、如果用户没有输入用户名，系统将显示一条错误消息，指出错误并提示用户输入用户名;2、如果用户没有输入密码，系统将显示一条错误消息，指出错误并提示用户输入密码;3、如果用户输入的用户名未被注册，系统提示用户输入的用户名不存在。4、如果用户输入的用户名密码错误，系统将显示一条错误消息，指出错误并提示用户输入正确的用户名和密码;时序图 图3.4 登录顺序图（2）登录原型图3.5 登录原型图3.1.3 系统信息管理模块用例图 图3.6 系统管理用例图用例分析该功能模块主要实现对系统的管理，阐明了管理员的权限及操作，实现了后台对客户端数据及信息的管理。其功能包括发布系统公告，添加新来职员信息，修改老员工的信息以及删除离职员工的所有信息，同时管理员可以实现对自己密码信息的修改。（1）发送系统公告基本流程 管理员需要发布最新公告时，点击公告发送按钮进入公告发送窗口，输入需要发送的公告，点击发送按钮，该消息即可群发给每个用户。分支流程1、如果没有输入信息，直接点击发送。系统会提示错误，请求输入信息。2、如果用户在线则可以马上接收到公告。3、若用户离线，则该公告储存到数据库，等用户上线时系统将自动将数据库中的公告发送给用户。活动图 图3.7 公告发送活动图（2）添加用户基本流程管理员为新来职员创建新的用户ID，管理员点击添加按钮，输入新用户的基本信息，然后点击确认按钮，系统立即把所填信息保存至数据库中，从而实现了用户的添加。分支流程1、如果添加信息时出现用户ID相同，则系统提示该用户已存在，同时清除文本框中已填写的内容。2、添加用户信息时如果员工的关键信息未填写（如员工号，部门等信息），系统将会提示信息应填写完整。顺序图 图3.8用户添加顺序图（3）查看用户资料基本流程当需要查看某个职员信息时，管理员可以通过点击查看按钮进入查看界面，根据关键信息搜索目标用户，选中该用户后点击确定，即可显示该用户的所有信息。 分支流程1、 如果未搜到该用户，系统将提示该用户不存在。2、 如果搜索的信息与需要查找的用户信息不相符，则退出用户信息窗口，重新按其他关键词搜索。顺序图 图3.9 资料查询顺序图（4）修改用户资料基本流程当管理员需要修改某个员工的信息时，打开用户资料界面，找到需要修改的文本框，删除原有信息，填写上最新消息，修改完毕后点击确定按钮，提交给系统。分支流程1、如果管理员试图修改用户关键信息（如职员ID 号，职员姓名等），系统会提示修改失败。 2、如果修改用户的部门信息时，输入的部门在系统中不存在，提示修改无效，要求管理员重新输入用户部门名称。3、如果修改用户的职位信息时，输入的职位在系统中不存在，提示修改无效，要求管理员重新输入用户部门名称。顺序图 图3.10 资料修改顺序图（5）删除用户：基本流程管理员需要删除某个员工的信息时，打开用户删除窗口，选中离职员工点击删除，即可实现用户删除。分支流程1、如果管理员选择验证对话框中的“取消”按钮，则退出验证对话框，管理员可以继续选择其他需删除的用户。 图3.11 用户删除顺序图（6）修改密码基本流程 管理员进入修改管理员密码窗口后，首先输入原有密码，再重新输入两次新密码，两次新密码需保持一致，修改完点击“确定”按钮提交最新密码信息。分支流程 1 如果原有密码输入错误，则系统提示错误，同时清除文本框中的已输入的内容。 2 如果原有密码输入正确，而两次输入的新密码不一致，则系统提示错误，并清除文本框中的已输入的内容。 图3.12 密码修改顺序图(7)系统管理界面 图3.13 系统管理操作原型图3.1.4个人信息管理模块用例图 图3.14 个人信息管理用例图用例分析公司职员在个人信息管理中，可以对个人的基本资料进行修改操作，或者补充管理员创建用户时没有填写完整的资料，修改登陆系统的个人密码，查看其他同事的基本资料，还可以根据需求设置自己在系统中的显示状态。(1)修改个人资料基本流程用户点击修改个人资料按钮，系统显示资料修改窗口。用户根据自己的需求编辑个人的资料，完成之后点击提交，系统显示个人资料修改成功窗口。分支流程1. 如果用户修改了无权修改的资料，如用户名、部门、职位等，系统显示操作错误，并提示用户无权进行此项操作。2. 如果用户修改完资料后点击取消，系统不保存修改结果，窗口关闭。 3. 如果用户修改完资料后没有进行确认或取消操作，则系统始终显示个人资料修改窗口。顺序图 图3.15 个人修改资料顺序图(2)修改密码基本流程用户点击修改个人密码按钮，系统显示密码修改窗口。用户输入原始密码，然后输入新密码和确认新密码，完成之后点击提交，原始密码正确无误且确认密码和新密码一致，就可以成功修改登陆密码，系统显示个人密码修改成功界面。分支流程1. 如果用户输入的原始密码错误，系统将显示一条错误消息，并提示用户输入正确的原始密码；2. 如果用户输入的确认密码和新密码不一致，系统将显示一条错误消息，并提示用户新密码和确认密码不一致；3. 如果用户修改完密码后点击取消，则系统不保存修改结果并关闭页面。4. 如果用户修改完密码后没有进行确认或取消操作，则系统始终显示密码修改界面。顺序图 图3.16 密码修改顺序图（3）查看用户资料基本流程用户需要查看同事资料时，选择所要查看的同事的资料项，系统显示同事的个人资料页面，但不会显示密码资料。用户查看完毕之后点击关闭，系统关闭该页面。分支流程1. 如果用户在查看同事资料时做编辑操作，系统将提示一条错误消息；2. 如果用户查看完同事资料后没有进行关闭操作，则系统始终显示查看同事资料页面。顺序图 图3.17 用户资料查看顺序图（4）设置状态基本流程用户点击设置状态按钮，系统显示状态设置页面。用户根据自己的需求选择自己在系统中的显示状态，包括在线、离线和隐身三种状态，点击确认后用户将在系统中显示相应的状态。顺序图 图3.18 设置状态顺序图（5）用户界面原型 图3.19 个人用户原型图3.1.5文字聊天模块用例图 图 3.20 文字会话模块用例图用例分析用户登录后可以与其他同事进行文字会话。若对方在线，则可以直接接收信息，并回复信息，那么双方就可以进行在线的文字会话。如果对方不在线，可以通过留言的方式，向对方发送信息。在对方登录后，系统会提示对方查看留言。此外，用户与用户之间的文字会话内容保存在本地文件中，方便用户以后查询。如果存储空间已满，只保存最近的信息。用户可以根据需要查询与某位同事的相关历史会话记录。（1）发送信息基本流程用户可以选择任意一位同事进行文字会话。点击与该同事的文字会话按扭，启动文字会话，即打开文字会话框。用户在会话框内输入要发送的信息，然后点击发送按扭就完成了信息的发送。分支流程1如果该同事在线，对方可以直接收到信息。2如果该同事不在线，则信息会以留言的形式发出。3如果用户没有输入任何信息就点击发送按扭，系统将显示一条错误信息，指出错误并提示用户输入信息。4如果用户在对方不在线的情况下发送图片信息，系统将显示一条错误信息，指出错误并提示用户对方不在线，不能发送图片信息。5如果信息发送不成功，则系统提示由于某种原因信息发送不成功，在输入框中的信息仍然存在。6如果发送信息成功后，用户不关闭对话框，则对话框继续保持，但输入框中原有信息消失，输入框为空。（2）接收信息基本流程用户在成功登录后，如果有其他用户发送来的信息或留言，系统会有信息提示音响起，提示用户查看信息。此时用户可以点击相应的信息接收按扭来显示并查看信息，然后用户可以直接进行信息回复。分支流程1如果用户不在线时有其他用户发来信息并未超出规定时间，则用户登录后可点击信息接收按扭来接收并查看信息。2如果留言信息在规定的时间内（如5天）未被查看，则相应的信息在用户登录时不会被用户接收到，此信息作废。（3）处理历史信息用例分析当用户之间进行文字会话后，系统将对会话内容进行处理，包括将会话内容备份，方便用户以后查询。如果用户启动历史信息查询，根据查询要求，可以导出与相应同事的会话记录。a）备份历史信息基本流程 当接收到对方发来的信息时，会显示在会话框内。当会话结束后，还会自动保存一份会话记录在本地文件中。本地发送的信息，除发送给对方外，会话结束后也会自动保存一份在本地文件中。b）查询历史信息基本流程当用户需要进行历史信息查询时，先启动相应文字会话框。然后点击会话记录按扭，系统会从本地文件中调出相应的会话记录并显示或导出为文本文件。分支流程1、 如果用户与同事之间没有进行文字会话，则查询时记录为空。2、 如果用户与同事之间进行了文字会话，但本地文件被破坏或删除，则查询不到相关记录。3、 如果用户与同事之间进行了文字会话，但会话内容在本地文件中被新的会话内容所覆盖，则查询不到相关记录。（4）文字会话活动图 图3.21 文字会话活动图（5）文字会话界面 图3.22 文字会话原型图3.1.6 语音功能模块用例图 图3.23 语音功能模块总用例图用例分析用户登陆后能够与其他职员进行音频会话。若对方在线并且接受了请求，那么双方就可以进行在线会话，会话期间双方都能够对本次会话进行一些控制（比如说设置静音、调节音量等），双方还能够随时终止本次会话。若对方不在线，系统会提示对方不在线，并询问是否音频留言，若接受音频留言建议，则可以通过音频留言操作给对方留言，在对方上线后，系统会提示对方收听留言，对方可以接受或者拒绝收听留言。对于已经收听的留言，服务器不再进行保存。若对方在线，还可以申请给对方播放音频文件，若对方接受请求，则会话双方可以同时听到同一个音频文件的内容。在播放音频文件的过程中，会话双方都可以对本次播放做一些调节，但是调节的效果对另一方是不起作用的。(1)在线会话基本流程当用户希望与其他在线职员进行音频会话时，应点击音频会话按钮，系统发送一个请求给对方，若对方接收请求则双方就可以通话了。通话过程中，双方都可以调节耳机的音量和麦克风的音量。若不想让对方听见你的声音则可以选中静音。分支流程：1、 如果对方不在线，则不能进行在线会话，系统会询问是否进行音频留言。2、如果对方对你的请求不给予响应，则不能进行通话且系统一直处于等待连接状态，但你可以取消请求。4、 如果对方拒绝你的请求，则请求失败，系统返回未请求之前的界面。4、如果连接未建立，则不能进行会话控制（调节音量或者设置静音），系统会将音量调节和设置静音按钮设为不可用的。（2）音频留言基本流程当用户希望与其他职员进行音频会话，而对方又不在线的情况下，系统会给出添加音频留言的建议。若接受该建议，则该用户可以开始录制音频留言，录制完毕之后该留言将保存在服务器。在对方上线之后，系统会提示对方收听音频留言，对方用户选择接受来收该听音频留言。分支流程1、如果用户不接受系统的留言建议，则系统不进行音频留言操作。2、如果用户在音频留言的录制中退出，则系统对用户录制的留言不进行保存，系统提示音频留言失败。3、如果用户在录制完音频留言后未经发送就退出，系统会询问是否要发送留言，若不响应系统的询问则该次留言失败。4、如果对方用户在收到系统给出的留言提示后，不对其进行响应（在某个时间段未响应）则系统默认为对方用户拒绝收听该留言。活动图 图3.24 语音留言活动图（3）音频文件播放基本流程用户发送一个播放音频文件的请求给其他在线职员。对方接受该请求则该通道建立。请求方点击“添加播放文件”进行本地音频文件装载，装载完音频文件后，请求方即可点击“播放”按钮来给对方播放音频文件。同时请求方也能够收听到该音频文件的内容。在播放过程中，请求方可以点击相应的按钮来进行快进、调节音量等播放控制。受邀方则只能进行音量调节。在该过程中，双方都可以通过点击退出按钮来结束本次播放。分支流程1、如果受邀方不在线，则不能进行音频文件播放。系统会给出相应的提示后返回。2、如果用户装载的音频文件类型不符合系统规定，则该音频文件无法播放，同时系统提示用户选择正确的类型。3、如果用户是受邀方，且试图添加播放文件，则系统会提示用户没有权限，本次添加操作失败。4、如果用户是受邀方，且试图进行快进、倒退等播放控制，系统将不对其操作进行响应，同时将所有动作复位。顺序图 图3.25音频播放顺序图（4）界面原型 图3.26音频原型图3.1.7视频功能模块用例图 图3.27 视频功能用例图用例分析用户可以在视频会话之前进行视频设置，如调节视频的窗口位置和大小。选中要视频的某位职员后，在其对话框中直接发送请求到对方的客户端，系统会提示对方接受视频请求。若接受请求，则等待视频连接。用户通过设置视频的相关参数可使视频更加流畅，如显示控制、视频参数设置。（1）请求发送基本流程当用户需要进行视频会话时，应先向对方发送视频请求等待对方接收。用户通过点击视频会话按钮，系统弹出视频会话界面，同时系统显示是否取消视频会话。分支流程1.如果对方用户不在线，系统则显示一条信息对方不在线不能接受视频请求，并且请求断开。2.如果对方拒绝视频请求，系统则显示一条信息对方拒绝请求，并且请求断开。3.如果对方不响应请求，则一直等待。4.如果对方退出系统，则显示一条信息对方拒绝请求，并且显示断开。（2）请求接受基本流程当对方请求视频会话时，系统会提示是接受还是拒绝请求，用户可以根据自己的需要来选择。用户点击接受视频按钮，系统则显示一条信息已接受请求，则弹出视频会话对话框，建立连接，开通视频，进行视频会话。分支流程1. 如果用户收到了视频请求并点击拒绝视频按钮，系统则显示一条信息已拒绝请求，并且向请求方发送一个拒绝请求的信息。2. 如果用户既不拒绝也不接受视频请求，系统将一直显示请求信息。3. 如果用户关掉文字会话窗口则向请求方发送一个拒绝请求的信息，并退出文字会话框。4. 如果用户关闭系统，则系统自动向请求方发送一个拒绝请求的信息。（3）发送/接受请求顺序图 图3.28 视频发送/接受请求顺序图（4）视频会话原型图图3.29 视频会话原型图（5）设置视频基本流程当用户需要进行视频设置时，用户点击设置按钮，弹出视频设置窗口，进入视频设