概要設(shè)計(jì)實(shí)例.doc

Lyra Resource Platform文檔概要設(shè)計(jì)說明書概要設(shè)計(jì)說明書1引言1.1編寫目的 本概要設(shè)計(jì)說明書是針對(duì)網(wǎng)絡(luò)信息體系結(jié)構(gòu)的課程作業(yè)而編寫。目的是對(duì)該項(xiàng)目進(jìn)行總體設(shè)計(jì)，在明確系統(tǒng)需求的基礎(chǔ)上劃分系統(tǒng)的功能模塊，進(jìn)行系統(tǒng)開發(fā)的分工，明確各模塊間的接口，為進(jìn)行后面的詳細(xì)設(shè)計(jì)和實(shí)現(xiàn)作準(zhǔn)備。本概要設(shè)計(jì)說明書的預(yù)期讀者為本項(xiàng)目小組的成員以及對(duì)該系統(tǒng)感興趣，在以后想對(duì)系統(tǒng)進(jìn)行擴(kuò)展和維護(hù)的人員。1.2背景a. 待開發(fā)的系統(tǒng)的名稱：Lyra Resource Platform;b. 本項(xiàng)目的任務(wù)提出者: 趙東，成富，陳良，竇文敏開發(fā)者：趙東，成富，陳良，竇文敏用戶：所有對(duì)該項(xiàng)目感興趣，并想通過該項(xiàng)目的產(chǎn)品提高資源檢索速度和質(zhì)量，方便的進(jìn)行資源檢索，預(yù)覽，上傳及下載的用戶。2總體設(shè)計(jì)2.1需求規(guī)定2.1.1系統(tǒng)功能l FTP的文件上傳及下載功能：類似于普通ftp的文件上傳和下載功能。u 用戶輸入ftp的服務(wù)器ip及用戶名，密碼，連接服務(wù)器并上傳或下載用戶指定的文件。u 如果用戶不輸入用戶名，密碼則默認(rèn)為匿名登錄。u 可以以列表的形式顯示服務(wù)器連接信息，以表格的形式顯示正下載文件的信息。u 具有站內(nèi)搜索功能。l 資源實(shí)時(shí)檢索功能：提供一個(gè)強(qiáng)大的搜索引擎功能， 用戶只需提供關(guān)鍵字和需要檢索的資源的類型，就能檢索到上面所述四種子平臺(tái)上的所有相關(guān)資源，并且列出來的資源都是可使用的。l 資源預(yù)覽功能：對(duì)于服務(wù)器上的某些資源，用戶可以選擇預(yù)覽，以確定是否下載。l 資源統(tǒng)計(jì)信息的功能：包括最近更新的資源，網(wǎng)上評(píng)論較熱門的資源等。提供一個(gè)詳細(xì)的列表，方便用戶瀏覽。2.1.2系統(tǒng)性能時(shí)間特性要求 系統(tǒng)的速度要在用戶可接受的范圍內(nèi)，但考慮到需要實(shí)時(shí)檢測(cè)服務(wù)器的可用性，對(duì)資源實(shí)時(shí)搜索的速度可以有較低的要求。ftp的文件上傳和下載速度要盡量的接近于普通ftp的速度?？煽啃?系統(tǒng)要有較高的可靠性，可恢復(fù)性。靈活性 系統(tǒng)要有良好的接口，以適應(yīng)增加資源平臺(tái)，增加資源類型，增加相關(guān)的資源獲取功能的需求；并留有服務(wù)器接口，適應(yīng)對(duì)以后實(shí)現(xiàn)服務(wù)器功能的需要；同時(shí)系統(tǒng)還需要具有跨平臺(tái)功能。2.1.3輸入輸出要求于ftp和資源實(shí)時(shí)檢索功能系統(tǒng)的輸入數(shù)據(jù)分為兩種類型，如果用戶已知服務(wù)器ip，用戶名，密碼，則輸入數(shù)據(jù)為服務(wù)器ip，用戶名，密碼；如果用戶只知道需要的資源名稱和類型，則輸入需要的資源名稱和類型。系統(tǒng)輸出為用戶需要的資源列表。并下載用戶選擇的文件。對(duì)于預(yù)覽功能，用戶需要選擇要預(yù)覽的文件，系統(tǒng)輸出該文件的一部分或全部內(nèi)容，如果用戶選擇保存預(yù)覽內(nèi)容，則保存。2.1.4數(shù)據(jù)管理能力要求系統(tǒng)需要記錄用戶最近連接過的ftp的地址，用戶名，密碼及該站點(diǎn)的文件列表。2.1.5故障處理要求 具有一定的容錯(cuò)能力，能檢測(cè)用戶的錯(cuò)誤輸入并給出錯(cuò)誤提示，能檢測(cè)資源的可用性錯(cuò)誤并輸出結(jié)果。能進(jìn)行系統(tǒng)故障恢復(fù)。2.1.6其他專門要求 因?yàn)楸鞠到y(tǒng)是一個(gè)普遍使用的工具，所以要求界面友好，使用方便，并要求系統(tǒng)具有高穩(wěn)定性，可擴(kuò)充性和運(yùn)行環(huán)境的可轉(zhuǎn)換性。 2.2運(yùn)行環(huán)境2.2.1設(shè)備普通pc機(jī)，互聯(lián)網(wǎng)。2.2.2支持軟件操作系統(tǒng)：windows或linux其它軟件:jdk 接口該系統(tǒng)早期會(huì)使用北大天網(wǎng)FTP搜索引擎和其他的文件搜索系統(tǒng)如百度的功能實(shí)現(xiàn)資源的檢索，但是在后期時(shí)間允許的情況下會(huì)開發(fā)自己的檢索部分。2.3基本設(shè)計(jì)概念和處理流程 系統(tǒng)的用況圖如下： 圖1 系統(tǒng)的用況圖活動(dòng)者：用戶，即使用系統(tǒng)進(jìn)行資源上傳下載，站內(nèi)搜索，資源實(shí)時(shí)檢索，資源預(yù)覽和資源統(tǒng)計(jì)信息的人。用況說明：l 用況名稱：上傳參與者：用戶主要事件流： 1. 用戶輸入ftp的ip及用戶名，密碼。 2. 系統(tǒng)連接ftp。 3. 用戶選擇資源并選擇上傳功能。 4. 系統(tǒng)運(yùn)行上傳功能，并顯示資源上傳信息。異常事件流： 1. 用戶輸入的ftp無法連接。 2. 顯示ftp無法連接，并提示原因，如無法找到此ftp，用戶名或密碼錯(cuò)誤，ftp連接人數(shù)已滿等等。異常事件流： 1. 資源上傳出錯(cuò)。 2. 顯示資源上傳錯(cuò)誤，并提示原因，如無上傳權(quán)限，ftp空間已滿等等。l 用況名稱：下載參與者：用戶主要事件流： 1. 用戶輸入ftp的ip及用戶名，密碼。 2. 系統(tǒng)連接ftp。 3. 用戶選擇資源并選擇下載功能。 4. 系統(tǒng)運(yùn)行下載功能，并顯示資源下載信息。異常事件流： 1. 用戶輸入的ftp無法連接。 2. 顯示ftp無法連接，并提示原因，如無法找到此ftp，用戶名或密碼錯(cuò)誤，ftp連接人數(shù)已滿等等。異常事件流： 1. 資源下載出錯(cuò)。 2. 顯示資源下載錯(cuò)誤，并提示原因，如無下載權(quán)限，用戶磁盤空間已滿等等。l 用況名稱：站內(nèi)搜索參與者：用戶主要事件流： 1. 用戶輸入需要搜索的資源名稱關(guān)鍵字。2. 系統(tǒng)進(jìn)行站內(nèi)搜索并顯示搜索結(jié)果。l 用況名稱：資源實(shí)時(shí)搜索參與者：用戶主要事件流： 1. 用戶輸入需要搜索的資源名稱關(guān)鍵字，選擇需要的資源類型。 2. 系統(tǒng)進(jìn)行實(shí)時(shí)檢索。 3. 輸出檢索結(jié)果。 4. 用戶在檢索結(jié)果中選擇需要的資源。 5. 系統(tǒng)連接用戶選擇的資源，并顯示。異常事件流： 1. 實(shí)時(shí)檢索出錯(cuò)。 2. 顯示錯(cuò)誤。l 用況名稱：預(yù)覽參與者：用戶主要事件流： 1.用戶選擇需要預(yù)覽的資源并選擇預(yù)覽功能。 2.系統(tǒng)顯示資源的內(nèi)容。 3.用戶選擇保存預(yù)覽資源。 4.系統(tǒng)將該資源保存到用戶選擇的目錄。異常事件流： 1. 預(yù)覽出錯(cuò)。 2. 系統(tǒng)顯示出錯(cuò)信息。l 用況名稱：統(tǒng)計(jì)資源信息參與者：用戶主要事件流： 1. 用戶輸入需要統(tǒng)計(jì)信息的資源類型。 2. 系統(tǒng)統(tǒng)計(jì)資源的信息。 3. 顯示資源的統(tǒng)計(jì)信息。異常事件流： 1. 統(tǒng)計(jì)資源信息出錯(cuò)。 2. 系統(tǒng)顯示出錯(cuò)信息。系統(tǒng)的主要使用流程：2.4結(jié)構(gòu) 系統(tǒng)物理結(jié)構(gòu)圖： 圖2 系統(tǒng)物理結(jié)構(gòu)圖系統(tǒng)模塊圖 圖3 系統(tǒng)模塊圖l ui：系統(tǒng)界面部分，負(fù)責(zé)接受用戶輸入，顯示系統(tǒng)輸出，負(fù)責(zé)其他模塊功能的協(xié)調(diào)調(diào)用，并含有站內(nèi)搜索功能，即在用戶指定的已打開的ftp站點(diǎn)中搜索用戶需要的資源。ui部分調(diào)用common部分的功能讀取xml文件中保存的界面元素屬性信息，用戶最近訪問過的10個(gè)ftp信息，用戶選擇的下載的ftp內(nèi)容列表及其他需要通過xml文件保存的信息。l client：實(shí)現(xiàn)ftp客戶端的功能，ftp連接，ftp上傳及下載：上傳或下載用戶指定的資源，并返回相應(yīng)的信息。l search:資源實(shí)時(shí)檢索部分，根據(jù)用戶輸入的資源名稱關(guān)鍵字，資源類型和選擇的檢索方式檢索用戶需要的資源，并驗(yàn)證資源的可用性，返回可用資源及其大小，速度等相關(guān)信息。l preview：資源預(yù)覽部分，顯示用戶選擇的資源的部分內(nèi)容，以使用戶決定是否需要該資源。preview部分調(diào)用common部分讀取屬性文件的內(nèi)容以設(shè)置預(yù)覽資源內(nèi)容的顯示格式。2.5功能需求與系統(tǒng)模塊的關(guān)系Cilentuisearch統(tǒng)計(jì)資源信息previewftp上傳及下載資源站內(nèi)搜索資源實(shí)時(shí)檢索統(tǒng)計(jì)資源信息預(yù)覽3接口設(shè)計(jì)3.1用戶接口 1.用戶： 用戶需要瀏覽的ftp的ip,用戶名，密碼。系統(tǒng)： 打開該ftp,根據(jù)用戶的選擇上傳，下載或預(yù)覽資源。2.用戶： 用戶需要實(shí)時(shí)檢索的資源的名稱關(guān)鍵字和資源類型。系統(tǒng)：實(shí)時(shí)檢索用戶需要的資源，顯示可用資源的列表。3.用戶：輸入需要統(tǒng)計(jì)信息的資源類型系統(tǒng)：統(tǒng)計(jì)資源信息并顯示。 3.2外部接口 調(diào)用天網(wǎng)的文件檢索功能：參數(shù)：需要檢索的資源名稱關(guān)鍵字， 返回：與該關(guān)鍵字匹配的所有資源的url。 調(diào)用百度的搜索功能：參數(shù)：需要檢索的資源名稱關(guān)鍵字， 返回：與該關(guān)鍵字匹配的所有資源的url。3.3內(nèi)部接口 說明本系統(tǒng)之內(nèi)的各個(gè)系統(tǒng)元素之間的接口的安排。 ui與client間的接口：輸入：ftp地址，用戶名，密碼，需上傳的資源，上傳到的目錄。輸出：上傳速度，其它相關(guān)信息。輸入：ftp地址，用戶名，密碼，需下載的資源，下載的目錄。輸出：下載速度，其它相關(guān)信息。 ui內(nèi)部界面與資源站內(nèi)搜索間的接口：輸入：ftp地址，需搜索資源的名稱關(guān)鍵字。輸出：搜索結(jié)果列表。 ui與search間的接口：輸入：需搜索資源的名稱關(guān)鍵字，需搜索資源的種類。輸出：搜索結(jié)果列表。 ui與preview間的接口： 輸入：需預(yù)覽資源的地址及類型。 輸出：需預(yù)覽資源的內(nèi)容。 ui與統(tǒng)計(jì)資源信息界的接口： 輸入：需統(tǒng)計(jì)信息的資源類型。 輸出：資源統(tǒng)計(jì)信息。4運(yùn)行設(shè)計(jì)4.1運(yùn)行模塊組合ftp上傳功能：系統(tǒng)界面模塊，ftp上傳模塊。ftp下載功能：系統(tǒng)界面模塊，ftp下載模塊。資源站內(nèi)搜索功能：系統(tǒng)界面模塊，站內(nèi)搜索模塊。資源實(shí)時(shí)檢索功能：系統(tǒng)界面模塊，資源實(shí)施檢索模塊。資源預(yù)覽功能：系統(tǒng)界面模塊，預(yù)覽模塊。統(tǒng)計(jì)資源信息功能：系統(tǒng)界面模塊，統(tǒng)計(jì)資源信息模塊。4.2運(yùn)行控制ftp上傳：輸入ftp的ip,用戶名，密碼。連接ftp，顯示ftp的內(nèi)容。瀏覽ftp選擇要上傳到的目錄。選擇需要上傳的資源并選擇上傳功能。執(zhí)行上傳操作。顯示上傳速度及相關(guān)信息。ftp下載：輸入ftp的ip,用戶名，密碼。連接ftp，顯示ftp的內(nèi)容。瀏覽ftp選擇要下載資源所在的目錄。選擇需要下載的資源并選擇下載功能。執(zhí)行下載操作。顯示下載速度及相關(guān)信息。資源站內(nèi)搜索：輸入需要搜索的資源名稱關(guān)鍵字。 搜索用戶指定的資源。 返回搜索結(jié)果。 資源實(shí)時(shí)搜索：輸入需要搜索的資源名稱關(guān)鍵字及資源類型。 進(jìn)行資源實(shí)時(shí)搜索。 顯示可用資源列表。 執(zhí)行其他所需的操作如下載。 資源預(yù)覽： 選擇需要預(yù)覽的資源并選擇預(yù)覽功能。 顯示資源的部分內(nèi)容。 決定是否保存該資源。 統(tǒng)計(jì)資源信息：輸入需統(tǒng)計(jì)信息的資源類型。 執(zhí)行統(tǒng)計(jì)資源信息功能。 顯示結(jié)果。5系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)5.1邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)主要的邏輯結(jié)構(gòu)如下：serversinfor：ftp服務(wù)器信息。屬性：name（服務(wù)器名稱或url） port（端口號(hào)）username(用戶名)password（密碼）。NetResource：實(shí)時(shí)檢索到的資源。屬性：fileURL（文件資源的URL，包括協(xié)議、主機(jī)字符串、路徑、文件