軟件架構(gòu)設(shè)計(jì)說(shuō)明書(shū)

1、軟件架構(gòu)設(shè)計(jì)說(shuō)明書(shū)Prepared on 22 November 20202008軟件工程蟲(chóng)孟揮學(xué)院第二組李錦剛劉宗智軟件架構(gòu)聲恤明書(shū)吳光偉張玉祥指導(dǎo)教師:2011 年8 月本文檔全面與系統(tǒng)的介紹了 MemoryBox網(wǎng)絡(luò)硬盤(pán)系統(tǒng)的構(gòu)架設(shè)計(jì)，并且使用多種視 圖來(lái)從不同角度描述本系統(tǒng)的各個(gè)主要的方面，以滿(mǎn)足各種不同涉眾（用戶(hù)、設(shè)計(jì)人員） 對(duì)于本系統(tǒng)不同關(guān)注焦點(diǎn)與需求。本文檔記錄并表述了系統(tǒng)架構(gòu)設(shè)計(jì)人員對(duì)于系統(tǒng)架構(gòu) 方面做出的重要決策。項(xiàng)目所有成員根據(jù)用戶(hù)需求通過(guò)小組討論獲得項(xiàng)目開(kāi)發(fā)計(jì)劃，制定系統(tǒng)架構(gòu)方案； 項(xiàng)目組長(zhǎng)通過(guò)個(gè)人所長(zhǎng)分配相應(yīng)的項(xiàng)目開(kāi)發(fā)任務(wù)；程序設(shè)計(jì)人員按照架構(gòu)方案進(jìn)行系統(tǒng) 詳細(xì)功能的開(kāi)

2、發(fā)；項(xiàng)目測(cè)試人員根據(jù)構(gòu)架設(shè)計(jì)項(xiàng)目的總體測(cè)試框架；構(gòu)架文檔用于各個(gè) 構(gòu)件的實(shí)施、集成及測(cè)試。2、文檔目的本文檔用于指導(dǎo)項(xiàng)目開(kāi)發(fā)人員進(jìn)行系統(tǒng)功能詳細(xì)設(shè)計(jì)；測(cè)試人員的測(cè)試框架設(shè) 計(jì)；各個(gè)構(gòu)件的實(shí)施與集成等。3、文檔范圍本軟件架構(gòu)文檔適用于MemoryBox系統(tǒng)的總體應(yīng)用構(gòu)架。4、讀者對(duì)象項(xiàng)LI組長(zhǎng)、程序開(kāi)發(fā)人員、測(cè)試人員等相關(guān)工作人員。5、參考資料軟件項(xiàng)目開(kāi)發(fā)文檔軟件架構(gòu)技術(shù)6、術(shù)語(yǔ)與縮寫(xiě)解釋MVC： (Model-View-ControIler)中文翻譯為"模型-視圖-控制器"。MySql： MySQL是一個(gè)小型關(guān)系型數(shù)據(jù)庫(kù)管理系統(tǒng)，開(kāi)發(fā)者為瑞典MySQL AB公司。CVS :

3、 (Concurrent Versions System )CVS 是一個(gè) C/S 系統(tǒng)，多個(gè)開(kāi)發(fā)人員通過(guò)一 個(gè)中心版本控制系統(tǒng)來(lái)記錄，從而達(dá)到保證文件同步的目的。CVS版本控制系統(tǒng)是一種 GNU,主要用于在多人開(kāi)發(fā)環(huán)境下的源碼的維護(hù)。MyEclipse： (MyEclipse Enterprise Workbench ,簡(jiǎn)稱(chēng) MyEclipse) 個(gè)十分優(yōu) 秀的用于開(kāi)發(fā)Java, J2EE的Eclipse集合。功能豐富的JavaEE。JUnit : JUnit是ill Erich Gamma和Kent Beck編寫(xiě)的一個(gè)回歸測(cè)試框架 (regression testing framework

4、)。Junit測(cè)試是程序員測(cè)試,即所謂白盒測(cè)試。Log4J： Log4j是Apache的一個(gè)開(kāi)放源代碼項(xiàng)目，通過(guò)使用Log4j,可以控制信息 輸送的目的地是控制臺(tái)、文件、GUI組件、甚至是套接口服務(wù)器、NT的事件記錄器、 UNIX Syslog守護(hù)進(jìn)程等。二、系統(tǒng)概述MemoryBox是一個(gè)運(yùn)用J2EE技術(shù)，通過(guò)C/S模式實(shí)現(xiàn)用戶(hù)管理及用戶(hù)資料存儲(chǔ)的網(wǎng) 絡(luò)硬盤(pán)系統(tǒng)?？蛻?hù)端提供用戶(hù)操作界面，服務(wù)端處理用戶(hù)操作請(qǐng)求。用戶(hù)初次登陸需要通過(guò)注冊(cè)獲得系統(tǒng)的使用權(quán)限，注冊(cè)通過(guò)后進(jìn)入系統(tǒng)主界面，可 以進(jìn)行文件的上傳(包括文檔、音頻、視頻等類(lèi)型的文件)、下載、共享、刪除。同時(shí)實(shí) 現(xiàn)了多文件同時(shí)上傳、同時(shí)下載、

5、文件的斷點(diǎn)續(xù)傳及斷點(diǎn)下載等功能。用戶(hù)通過(guò)其他供 應(yīng)商接口可以實(shí)現(xiàn)開(kāi)通會(huì)員等提升用戶(hù)權(quán)限及服務(wù)的操作。三、設(shè)計(jì)約束命名約束：類(lèi)名、方法名與參數(shù)名統(tǒng)一采用駝峰法，類(lèi)名首字母大寫(xiě)，參數(shù)與方法名首字母小寫(xiě)；命名協(xié)定:rB" 包該項(xiàng)目的包結(jié)構(gòu)：所有界面 所有的動(dòng)作事件 所有數(shù)據(jù)庫(kù)訪問(wèn)類(lèi) 公用組件包 服務(wù)邏輯包類(lèi)類(lèi)的名稱(chēng)應(yīng)該清楚的標(biāo)識(shí)它所農(nóng)示的實(shí)體，若有多個(gè)單詞組成，則每個(gè)單詞首7母 大寫(xiě)。例如，代農(nóng)用戶(hù)的類(lèi)的名字應(yīng)該叫做User' o接口與橐毎方法(函數(shù))方法(函數(shù))名應(yīng)該根據(jù)它所完成的功能或者返回值決定它的命名。例如，返回值為布爾型：isMethodName()或 hasMethod

6、Name() 返回值為其他類(lèi)型：getMethodName() 執(zhí)行刪除數(shù)據(jù)功能：deleteMethodName() 執(zhí)行修改數(shù)據(jù)功能：updateMethodName() 執(zhí)行添加數(shù)據(jù)功能：addMethodName()變量靜態(tài)最終變量字母均大寫(xiě)文件文件名應(yīng)該能清晰的標(biāo)志它們存儲(chǔ)的數(shù)據(jù)的種類(lèi)。 image存放圖片文件sound存放音頻文件temp存放臨時(shí)文件四、設(shè)計(jì)策略本系統(tǒng)采用C/S模式設(shè)計(jì)，基本實(shí)現(xiàn)MVC模式；采用JUnit進(jìn)行單元測(cè)試，提高軟 件開(kāi)發(fā)質(zhì)量；使用Log4J記錄開(kāi)發(fā)曰志，隨時(shí)進(jìn)行改進(jìn)；使用CVS系統(tǒng)進(jìn)行開(kāi)發(fā)，對(duì)項(xiàng) 目進(jìn)程實(shí)時(shí)更新。五、系統(tǒng)總體結(jié)構(gòu)客戶(hù)端結(jié)構(gòu)設(shè)計(jì)：圖一：客戶(hù)

7、端模塊劃分詳細(xì)功能描述：用戶(hù)信息管理及安全設(shè)置：用戶(hù)通過(guò)注冊(cè)后在服務(wù)端存儲(chǔ)各項(xiàng)信息(用戶(hù)名、密碼、 郵箱、個(gè)性簽名、找回密碼問(wèn)題、密碼問(wèn)題答案等)；常用用戶(hù)登錄時(shí)可以選擇記住用 戶(hù)名及密碼，方便下次登錄；當(dāng)用戶(hù)名正確而忘記密碼時(shí)，用戶(hù)可以通過(guò)回答密碼問(wèn)題 修改自己的登錄密碼；登陸之后用戶(hù)可以瀏覽自己的個(gè)人信息、修改個(gè)人信息；用戶(hù)可 以通過(guò)第三方付費(fèi)方式開(kāi)通會(huì)員，提升使用權(quán)限，享受相應(yīng)的會(huì)員服務(wù)；用戶(hù)文件管理：用戶(hù)登錄進(jìn)入主界面，可以選擇上傳文件、下載文件、刪除文件、共享文件等操作；用戶(hù)可以新建文件夾來(lái)保存自己的所需要的資料；當(dāng)用戶(hù)上傳或者下載 是出現(xiàn)外部情況變化可以實(shí)現(xiàn)文件的斷點(diǎn)續(xù)傳及斷點(diǎn)下載

8、；客戶(hù)端業(yè)務(wù)流程：圖二：客戶(hù)端業(yè)務(wù)流程服務(wù)端結(jié)構(gòu)設(shè)計(jì)：圖三：服務(wù)端模塊劃分詳細(xì)功能描述：用戶(hù)容量控制：根據(jù)硬件與軟件條件，系統(tǒng)管理員對(duì)用戶(hù)的使用空間有控制權(quán)限；根據(jù)用戶(hù)不同權(quán)限分配不同空間，并且對(duì)整個(gè)系統(tǒng)的使用空間進(jìn)行操作與控制；用戶(hù)管理：審核用戶(hù)注冊(cè)信息是否合法，對(duì)于不合法用戶(hù)可以進(jìn)行刪除操作；存儲(chǔ)合法用戶(hù)信息，沒(méi)有修改權(quán)限；查看用戶(hù)文件并且審核，對(duì)于非法文件進(jìn)行刪除操作；根據(jù)用戶(hù)開(kāi)通會(huì)員的請(qǐng)求進(jìn)行用戶(hù)權(quán)限提升的操作；服務(wù)端業(yè)務(wù)流程：圖四：服務(wù)端業(yè)務(wù)流程系統(tǒng)部署圖：圖五:系統(tǒng)部署圖六、子系統(tǒng)的結(jié)構(gòu)與功能用戶(hù)管理：圖六：用戶(hù)登錄業(yè)務(wù)流程文件管理:圖七：文件上傳業(yè)務(wù)流程選樣曼下 載的文件選樣本地存放文件的目錄'是否與定下菽 足發(fā)送所需廣性至08務(wù)端悸待88務(wù)靖腆認(rèn)是否正誦連接諫入08務(wù)端發(fā)送 過(guò)來(lái)的文件宇書(shū)裕文件字節(jié)寫(xiě) 入本地文件1是否下載完成I是移除對(duì)應(yīng)誑度條 及相關(guān)緩存信啟.圖八：文件下載業(yè)務(wù)流程七、開(kāi)發(fā)環(huán)境的配置客戶(hù)端：Windows XP及以上運(yùn)行環(huán)境;JDK及以上開(kāi)發(fā)環(huán)境；MyEclipse及以上開(kāi)發(fā)環(huán)境；CVS及以上系統(tǒng)平臺(tái)；服務(wù)端：Windows XP及以上運(yùn)行環(huán)境;JDK及以上開(kāi)發(fā)環(huán)境；MyEclipse及以上開(kāi)發(fā)環(huán)境;CVS及以上系統(tǒng)平臺(tái)；MySql數(shù)據(jù)庫(kù)系統(tǒng)；八、運(yùn)行環(huán)境的配置客戶(hù)端：Windows XP