即時通信軟件項目需求說明書

1、系統(tǒng)軟件設計與開發(fā)（第一稿）局域網即時通信軟件項目需求分析和功能說明書公安海警學院電子技術系2010級電子信息工程專業(yè) 03742010021 張力文 目錄第1章 引言31.1 編寫目的.31.2 編寫背景.31.2.1 系統(tǒng)名稱及行業(yè)情況.31.2.2 文檔讀者內容及參看資料.3第2章 任務概述2.1 項目背景及目標92.2 用戶特點92.3 條件92.4 運行環(huán)境92.4.1 硬件環(huán)境92.4.2 軟件環(huán)境9第3章 系統(tǒng)概述11第4章 系統(tǒng)功能組成124.1 功能名稱及功能編號124.1.1 功能描述124.1.2 業(yè)務流圖、處理邏輯124.1.3 功能細分、及各個子功能之間的關系124.

2、1.4 輸入134.1.5 輸出134.1.6 約束條件134.1.7 異常處理13第5章 菜單和界面原型13第6章 非功能需求146.1 用戶管理和使用權限管理146.2 軟件性能需求分析146.3 軟件易用性需求的分析146.4 軟件開放性、可擴充性、可維護性方面的需求分析146.5 軟件兼容性方面的需求分析146.6 軟件相應的用戶文檔的需求分析146.7 接口156.7.1 硬件接口156.7.2 軟件接口156.7.3 通信接口151、引言 1.1 編寫目的 本需求說明書編寫目的是為清晰說明本小組開發(fā)的局域網即時通信軟件要實現(xiàn)的所有功能，使軟件使用者和軟件開發(fā)者能夠建立起一定程度上的

3、溝通，使系統(tǒng)設計員能夠理解用戶對于要實現(xiàn)功能的詳細描述與要求，為保證描述沒有二義性，促進理解效果，期冀達到用戶的預期。 1.2 編寫背景 1.2.1系統(tǒng)名稱及行業(yè)情況 待開發(fā)軟件名稱： 即時聊天v1.0 軟件項目用途：為方便在小的局域范圍內實行即時通信 軟件項目范圍：學員與學員間、學員與教員間構建聯(lián)系網絡 目標任務提出者：教員 目標任務開發(fā)者：學員1.2.2文檔讀者、內容以及參看資料 文檔讀者：本文檔讀者為即時系統(tǒng)開發(fā)人員、測試人員、實施人員以及教員 文檔內容：局域網即時通信軟件項目需求分析和功能說明書，內容是系統(tǒng)描述即時通信系統(tǒng)的框架以及功能2、任務概述2.1 任務目標 方便校園內部的溝通聯(lián)

4、系，防止QQ，MSN等即時通訊軟件中的娛樂成分影響工作。即時通訊系統(tǒng)能完成點對點的即時通訊，信息在校園內部的廣播，以及建立群聊天室進行文字會議。2.2 運行環(huán)境服務器：Windows 2003 Server數(shù)據(jù)庫：Oracle基礎平臺：.Net Framework 4.0瀏覽器插件：silverlight 3、實現(xiàn)功能 3.1 用戶管理系統(tǒng)1.用戶管理功能l 用戶注冊l 用戶登陸l 用戶信息查詢l 普通用戶查詢個人信息l 管理員查詢全部信息l 用戶信息修改l 普通用戶修改個人信息l 管理員修改全部信息l 用戶刪除（管理員）l 添加新用戶2.即時通信功能l 端對端短信發(fā)送3聊天記錄查詢l 短信群

5、發(fā)功能l 端對端的文件發(fā)送l 端對端的視頻發(fā)送l 消息廣播 3.2 系統(tǒng)結構 系統(tǒng)包括兩種終端：服務器端、客戶端l 服務器承擔客戶端獲取機器列表、查詢機器IP等服務，也是群聊的服務器l 客戶端和客戶端之間，客戶端和服務器之間可以點對點進行通信l 一個局域網內服務器只能啟動一個關鍵通訊模式說明：客戶端與客戶端私聊發(fā)送信息 客戶端1 客戶端2從服務器端獲取信息用戶管理信息返回應答 客戶端 服務器 注：獲取信息是需要應答的。4.總體功能需求4.1功能劃分 根據(jù)業(yè)務需求和系統(tǒng)功能分為以下幾個部分：l 文字即時通訊l 管理員可以添加刪除人員l 本人修改密碼l 實名顯示公司所有學員l 廣播消息于全體學員l

6、 發(fā)起多人的文字聊天室l 本地通訊記錄保存于數(shù)據(jù)庫，可以查詢本人的通訊記錄4.2默認操作約束l 增加刪除成員（需要權限）4.3默認操作流程4.3.1用戶登錄用例圖圖3.3 登錄用例圖用例分析用戶在使用本系統(tǒng)前必須進行資格核查，包括系統(tǒng)管理員。核查的內容包括：用戶ID和密碼。在通過用戶身份驗證之后，系統(tǒng)將初始化該用戶的基本信息（例如更新用戶狀態(tài)為上線、留言提示等）。 用戶登錄基本流程用戶輸入用戶名、密碼，然后點擊登錄按鈕。用戶登錄系統(tǒng)后，會根據(jù)當前用戶類別，如一般用戶、管理員，顯示不同的界面。在稍后的操作中，根據(jù)用戶類型控制權限。分支流程1. 如果用戶沒有輸入用戶名，系統(tǒng)將顯示一條

7、錯誤消息，指出錯誤并提示用戶輸入用戶名;2. 如果用戶沒有輸入密碼，系統(tǒng)將顯示一條錯誤消息，指出錯誤并提示用戶輸入密碼;3. 如果用戶輸入的用戶名未被注冊，系統(tǒng)提示用戶輸入的用戶名不存在。4. 如果用戶輸入的用戶名密碼錯誤，系統(tǒng)將顯示一條錯誤消息，指出錯誤并提示用戶輸入正確的用戶名和密碼; 時序圖 圖3.4 登錄順序圖 4.3.2系統(tǒng)信息管理用例圖 用例分析該功能模塊主要實現(xiàn)對系統(tǒng)的管理，闡明了管理員的權限及操作，實現(xiàn)了后臺對客戶端數(shù)據(jù)及信息的管理。其功能包括發(fā)布系統(tǒng)公告，添加新來職員信息，修改老員工的信息以及刪除離職員工的所有信息，同時管理員可以實現(xiàn)對自己密碼信息的修改。 （1）發(fā)送系統(tǒng)公告

8、基本流程 管理員需要發(fā)布最新公告時，點擊公告發(fā)送按鈕進入公告發(fā)送窗口，輸入需要發(fā)送的公告，點擊發(fā)送按鈕，該消息即可群發(fā)給每個用戶。分支流程1、如果沒有輸入信息，直接點擊發(fā)送。系統(tǒng)會提示錯誤，請求輸入信息。2、如果用戶在線則可以馬上接收到公告。3、若用戶離線，則該公告儲存到數(shù)據(jù)庫，等用戶上線時系統(tǒng)將自動將數(shù)據(jù)庫中的公告發(fā)送給用戶?；顒訄D圖3.7 公告發(fā)送活動圖（2）添加用戶基本流程管理員為新來職員創(chuàng)建新的用戶ID，管理員點擊添加按鈕，輸入新用戶的基本信息，然后點擊確認按鈕，系統(tǒng)立即把所填信息保存至數(shù)據(jù)庫中，從而實現(xiàn)了用戶的添加。分支流程1. 如果添加信息時出現(xiàn)用戶ID相同，則系統(tǒng)提示該用戶已存在

9、，同時清除文本框中已填寫的內容。2. 添加用戶信息時如果員工的關鍵信息未填寫（如員工號，部門等信息），系統(tǒng)將會提示信息應填寫完整。順序圖圖3.8用戶添加順序圖（3）查看用戶資料基本流程當需要查看某個學員信息時，管理員可以通過點擊查看按鈕進入查看界面，根據(jù)關鍵信息搜索目標用戶，選中該用戶后點擊確定，即可顯示該用戶的所有信息。 分支流程1.如果未搜到該用戶，系統(tǒng)將提示該用戶不存在。2.如果搜索的信息與需要查找的用戶信息不相符，則退出用戶信息窗口，重新按其他關鍵詞搜索。順序圖圖3.9 資料查詢順序圖（4）修改用戶資料基本流程當管理員需要修改某個學員的信息時，打開用戶資料界面，找到需要修改的文本框，刪

10、除原有信息，填寫上最新消息，修改完畢后點擊確定按鈕，提交給系統(tǒng)。分支流程1. 如果管理員試圖修改用戶關鍵信息（如職員ID 號，職員姓名等），系統(tǒng)會提示修改失敗。2. 如果修改用戶的部門信息時，輸入的部門在系統(tǒng)中不存在，提示修改無效，要求管理員重新輸入用戶部門名稱。3. 如果修改用戶的職位信息時，輸入的職位在系統(tǒng)中不存在，提示修改無效，要求管理員重新輸入用戶部門名稱。4. 順序圖圖3.10資料修改順序圖（5）刪除用戶：基本流程管理員需要刪除某個學員的信息時，打開用戶刪除窗口，選中離職員工點擊刪除，即可實現(xiàn)用戶刪除。分支流程1.如果管理員選擇驗證對話框中的“取消”按鈕，則退出驗證對話框，管理員可以

11、繼續(xù)選擇其他需刪除的用戶。圖3.11用戶刪除順序圖（6）修改密碼基本流程 管理員進入修改管理員密碼窗口后，首先輸入原有密碼，再重新輸入兩次新密碼，兩次新密碼需保持一致，修改完點擊“確定”按鈕提交最新密碼信息。分支流程1. 如果原有密碼輸入錯誤，則系統(tǒng)提示錯誤，同時清除文本框中的已輸入的內容。2. 如果原有密碼輸入正確，而兩次輸入的新密碼不一致，則系統(tǒng)提示錯誤，并清除文本框中的已輸入的內容。圖3.12 密碼修改順序圖(7)系統(tǒng)管理界面 4.3.3個人信息管理模塊用例圖圖3.14 個人信息管理用例圖用例分析公司職員在個人信息管理中，可以對個人的基本資料進行修改操作，或者補充管理員創(chuàng)建用戶時沒有填寫

12、完整的資料，修改登陸系統(tǒng)的個人密碼，查看其他同事的基本資料，還可以根據(jù)需求設置自己在系統(tǒng)中的顯示狀態(tài)。(1)修改個人資料基本流程用戶點擊修改個人資料按鈕，系統(tǒng)顯示資料修改窗口。用戶根據(jù)自己的需求編輯個人的資料，完成之后點擊提交，系統(tǒng)顯示個人資料修改成功窗口。分支流程1. 如果用戶修改了無權修改的資料，如用戶名、部門、職位等，系統(tǒng)顯示操作錯誤，并提示用戶無權進行此項操作。2. 如果用戶修改完資料后點擊取消，系統(tǒng)不保存修改結果，窗口關閉。3. 如果用戶修改完資料后沒有進行確認或取消操作，則系統(tǒng)始終顯示個人資料修改窗口。順序圖圖3.15個人修改資料順序圖(2)修改密碼基本流程用戶點擊修改個人密碼按鈕

13、，系統(tǒng)顯示密碼修改窗口。用戶輸入原始密碼，然后輸入新密碼和確認新密碼，完成之后點擊提交，原始密碼正確無誤且確認密碼和新密碼一致，就可以成功修改登陸密碼，系統(tǒng)顯示個人密碼修改成功界面。分支流程1. 如果用戶輸入的原始密碼錯誤，系統(tǒng)將顯示一條錯誤消息，并提示用戶輸入正確的原始密碼；2. 如果用戶輸入的確認密碼和新密碼不一致，系統(tǒng)將顯示一條錯誤消息，并提示用戶新密碼和確認密碼不一致；3. 如果用戶修改完密碼后點擊取消，則系統(tǒng)不保存修改結果并關閉頁面。4. 如果用戶修改完密碼后沒有進行確認或取消操作，則系統(tǒng)始終顯示密碼修改界面。順序圖圖3.16密碼修改順序圖（3）查看用戶資料基本流程用戶需要查看同事資

14、料時，選擇所要查看的同事的資料項，系統(tǒng)顯示同事的個人資料頁面，但不會顯示密碼資料。用戶查看完畢之后點擊關閉，系統(tǒng)關閉該頁面。分支流程1. 如果用戶在查看同事資料時做編輯操作，系統(tǒng)將提示一條錯誤消息；2. 如果用戶查看完同事資料后沒有進行關閉操作，則系統(tǒng)始終顯示查看同事資料頁面。順序圖圖3.17 用戶資料查看順序圖 （4）設置狀態(tài)基本流程用戶點擊設置狀態(tài)按鈕，系統(tǒng)顯示狀態(tài)設置頁面。用戶根據(jù)自己的需求選擇自己在系統(tǒng)中的顯示狀態(tài)，包括在線、離線和隱身三種狀態(tài)，點擊確認后用戶將在系統(tǒng)中顯示相應的狀態(tài)。順序圖圖3.18 設置狀態(tài)順序圖4.3.4文字聊天模塊用例圖 圖 3.20 文字會話模塊用例圖用例分析

15、用戶登錄后可以與其他同事進行文字會話。若對方在線，則可以直接接收信息，并回復信息，那么雙方就可以進行在線的文字會話。如果對方不在線，可以通過留言的方式，向對方發(fā)送信息。在對方登錄后，系統(tǒng)會提示對方查看留言。此外，用戶與用戶之間的文字會話內容保存在本地文件中，方便用戶以后查詢。如果存儲空間已滿，只保存最近的信息。用戶可以根據(jù)需要查詢與某位同事的相關歷史會話記錄。（1）發(fā)送信息基本流程用戶可以選擇任意一位同事進行文字會話。點擊與該同事的文字會話按扭，啟動文字會話，即打開文字會話框。用戶在會話框內輸入要發(fā)送的信息，然后點擊發(fā)送按扭就完成了信息的發(fā)送。分支流程1如果該同事在線，對方可以直接收到信息。2

16、如果該同事不在線，則信息會以留言的形式發(fā)出。3如果用戶沒有輸入任何信息就點擊發(fā)送按扭，系統(tǒng)將顯示一條錯誤信息，指出錯誤并提示用戶輸入信息。4如果用戶在對方不在線的情況下發(fā)送圖片信息，系統(tǒng)將顯示一條錯誤信息，指出錯誤并提示用戶對方不在線，不能發(fā)送圖片信息。5如果信息發(fā)送不成功，則系統(tǒng)提示由于某種原因信息發(fā)送不成功，在輸入框中的信息仍然存在。6如果發(fā)送信息成功后，用戶不關閉對話框，則對話框繼續(xù)保持，但輸入框中原有信息消失，輸入框為空。（2）接收信息基本流程用戶在成功登錄后，如果有其他用戶發(fā)送來的信息或留言，系統(tǒng)會有信息提示音響起，提示用戶查看信息。此時用戶可以點擊相應的信息接收按扭來顯示并查看信息

17、，然后用戶可以直接進行信息回復。分支流程1如果用戶不在線時有其他用戶發(fā)來信息并未超出規(guī)定時間，則用戶登錄后可點擊信息接收按扭來接收并查看信息。2如果留言信息在規(guī)定的時間內（如5天）未被查看，則相應的信息在用戶登錄時不會被用戶接收到，此信息作廢。（3）處理歷史信息用例分析當用戶之間進行文字會話后，系統(tǒng)將對會話內容進行處理，包括將會話內容備份，方便用戶以后查詢。如果用戶啟動歷史信息查詢，根據(jù)查詢要求，可以導出與相應同事的會話記錄。a）備份歷史信息基本流程當接收到對方發(fā)來的信息時，會顯示在會話框內。當會話結束后，還會自動保存一份會話記錄在本地文件中。本地發(fā)送的信息，除發(fā)送給對方外，會話結束后也會自動

18、保存一份在本地文件中。b）查詢歷史信息基本流程當用戶需要進行歷史信息查詢時，先啟動相應文字會話框。然后點擊會話記錄按扭，系統(tǒng)會從本地文件中調出相應的會話記錄并顯示或導出為文本文件。分支流程1、 如果用戶與同事之間沒有進行文字會話，則查詢時記錄為空。2、 如果用戶與同事之間進行了文字會話，但本地文件被破壞或刪除，則查詢不到相關記錄。3、 如果用戶與同事之間進行了文字會話，但會話內容在本地文件中被新的會話內容所覆蓋，則查詢不到相關記錄。（4）文字會話活動圖圖3.21 文字會話活動圖 （5）文字會話界面 4.3.5 語音功能模塊用例圖 圖3.23 語音功能模塊總用例圖 用例分析 用戶登陸后能夠與其他

19、職員進行音頻會話。若對方在線并且接受了請求，那么雙 方就可以進行在線會話，會話期間雙方都能夠對本次會話進行一些控制（比如說設置靜音、調節(jié)音量等），雙方還能夠隨時終止本次會話。若對方不在線，系統(tǒng)會提示對方不在線，并詢問是否音頻留言，若接受音頻留言建議，則可以通過音頻留言操作給對方留言，在對方上線后，系統(tǒng)會提示對方收聽留言，對方可以接受或者拒絕收聽留言。對于已經收聽的留言，服務器不再進行保存。若對方在線，還可以申請給對方播放音頻文件，若對方接受請求，則會話雙方可以同時聽到同一個音頻文件的內容。在播放音頻文件的過 程中，會話雙方都可以對本次播放做一些調節(jié)，但是調節(jié)的效果對另一方是不起作用的。 (1)

20、在線會話 基本流程 當用戶希望與其他在線職員進行音頻會話時，應點擊音頻會話按鈕，系統(tǒng)發(fā)送一個請求給對方，若對方接收請求則雙方就可以通話了。通話過程中，雙方都可以調節(jié)耳機的音量和麥克風的音量。若不想讓對方聽見你的聲音則可以選中靜音。 分支流程： 1.如果對方不在線，則不能進行在線會話，系統(tǒng)會詢問是否進行音頻留言。 2、如果對方對你的請求不給予響應，則不能進行通話且系統(tǒng)一直處于等待連接 狀態(tài)，但你可以取消請求。 3.如果對方拒絕你的請求，則請求失敗，系統(tǒng)返回未請求之前的界面。 4.如果連接未建立，則不能進行會話控制（調節(jié)音量或者設置靜音），系統(tǒng)會將 音量調節(jié)和設置靜音按鈕設為不可用的。 （2）音頻

21、留言 基本流程 當用戶希望與其他職員進行音頻會話，而對方又不在線的情況下，系統(tǒng)會給出 添加音頻留言的建議。若接受該建議，則該用戶可以開始錄制音頻留言，錄制完畢之后該留言將保存在服務器。在對方上線之后，系統(tǒng)會提示對方收聽音頻留言，對方用戶選擇接受來收該聽音頻留言。 分支流程 1、如果用戶不接受系統(tǒng)的留言建議，則系統(tǒng)不進行音頻留言操作。 2、如果用戶在音頻留言的錄制中退出，則系統(tǒng)對用戶錄制的留言不進行保存，系統(tǒng)提示音頻留言失敗。 3、如果用戶在錄制完音頻留言后未經發(fā)送就退出，系統(tǒng)會詢問是否要發(fā)送留言，若不響應系統(tǒng)的詢問則該次留言失敗。 4、如果對方用戶在收到系統(tǒng)給出的留言提示后，不對其進行響應（在

22、某個時間段未響應）則系統(tǒng)默認為對方用戶拒絕收聽該留言。活動圖 圖3.24 語音留言活動圖 （3）音頻文件播放 基本流程 用戶發(fā)送一個播放音頻文件的請求給其他在線職員。對方接受該請求則該通道建立。請求方點擊“添加播放文件”進行本地音頻文件裝載，裝載完音頻文件后，請求方即可點擊“播放”按鈕來給對方播放音頻文件。同時請求方也能夠收聽到該音頻文件的內容。在播放過程中，請求方可以點擊相應的按鈕來進行快進、調節(jié)音量等播放控制。受邀方則只能進行音量調節(jié)。在該過程中，雙方都可以通過點擊退出按鈕來結束本次播放。 分支流程 1、如果受邀方不在線，則不能進行音頻文件播放。系統(tǒng)會給出相應的提示后返 回。 2、如果用戶

23、裝載的音頻文件類型不符合系統(tǒng)規(guī)定，則該音頻文件無法播放，同時系統(tǒng)提示用戶選擇正確的類型。 3、如果用戶是受邀方，且試圖添加播放文件，則系統(tǒng)會提示用戶沒有權限，本次添加操作失敗。 4、如果用戶是受邀方，且試圖進行快進、倒退等播放控制，系統(tǒng)將不對其操作進行響應，同時將所有動作復位。順序圖 圖3.25音頻播放順序圖 4.3.6視頻功能模塊用例圖 圖3.27視頻功能用例圖用例分析用戶可以在視頻會話之前進行視頻設置，如調節(jié)視頻的窗口位置和大小。選中要視頻的某位職員后，在其對話框中直接發(fā)送請求到對方的客戶端，系統(tǒng)會提示對方接受視頻請求。若接受請求，則等待視頻連接。用戶通過設置視頻的相關參數(shù)可使視頻更加流暢，如顯示控制、視頻參數(shù)設置。（1）請求發(fā)送基本流程當用戶需要進行視頻會話時，應先向對方發(fā)送視頻請求等待對方接收。用戶通過點擊視頻會話按鈕，系統(tǒng)彈出視頻會話界面，同時系統(tǒng)顯示是否取消視頻會話。分支流程1.如果對方用戶不在線，系統(tǒng)則顯示一條信息對方不在線不能接受視頻請求，并且請求斷開。2.如果對方拒絕視頻請求，系統(tǒng)則顯示一條信息對方拒絕請求，并且請求斷開。3.如果對方