軟件體系結構設計說明

軟件體系結構設計說明書編者說明：隨著OO方法論地日臻成熟，其思想也從編程（OOP）到了設計（OOD）和分析（OOA），而軟件體系結構則是從設計的最高層進行設計與規(guī)劃的技術，本文檔模板就是用來幫助你從用例視圖、邏輯視圖、進程視圖、部署視圖等方面對系統(tǒng)進行總體描述。1.文檔簡介[本節(jié)主要是描述軟件體系結構設計說明書的目的、范圍、相關術語、參考資料和本文檔的摘要性介紹。軟件體系結構設計屬于高層設計文檔，是符合現(xiàn)代軟件工程要求的概要設計。]1.1目的[軟件體系結構設計說明書，將從設計的角度對系統(tǒng)進行綜合的描述，使用不同的視圖來描述其不同方面。在本小節(jié)中，將對該文檔的結構進行簡要的說明，明確該文檔針對的讀者群，指導他們正確的地使用該文檔。]1.2范圍[說明該文檔所涉及的內容范圍，以及將影響的內容。]1.3定義、首字母縮寫詞和縮略語[與其它文檔一樣，該文檔也需要將本文檔中所涉及的所有術語、縮略語進行詳細的定義。還有一種可簡明的做法，就是維護在一個項目詞匯表中，這樣就可以避免在每個文檔中都重復很多內容。]1.4參考資料[在這一小節(jié)中，應完整地列出該文檔引用的所有文檔。對于每個引用的文檔都應該給出標題、標識號、日期以及來源，為閱讀者查找這些文檔提供足夠詳細的信息。]1.5概述[在本小節(jié)中，主要是說明軟件體系結構設計說明書各個部分所包含的主要內容，就像一個文章摘要一樣。同時也應該對文檔的組織方式進行解釋。]2.體系結構表示方式[本節(jié)說明軟件體系結構在當前系統(tǒng)中的作用及其表示方式。它將列舉其所必需的用例視圖、邏輯視圖、進程視圖、部署視圖或實施視圖，并分別說明這些視圖包含哪些類型的模型元素。]3.軟件體系結構的目標和約束[本節(jié)說明對軟件體系結構具有某種重要影響的軟件需求和用戶目標，例如，系統(tǒng)安全性、保密性、第三方組件的使用、可移植性、發(fā)布和重新使用。它還要記錄可能適用的特殊約束：設計與實施策略、開發(fā)工具、團隊結構、時間表、遺留系統(tǒng)等。]設備及分布服務器：主機只負責保存用戶信息列表功能和多播時信息的發(fā)送。配置無特殊要求。客戶端：具有奔騰III、128兆內存配置的計算機；網(wǎng)絡類型802.5存儲器容量至少50M空間，軟件安裝最少15MB的硬盤空間；內存要求：最少128MB的RAM存儲器；顯示設備：VGA顯示器或更高；其它特殊設備：無設備分布圖略支撐軟件操作系統(tǒng)：Windows98/2000/XP或更高；數(shù)據(jù)庫管理系統(tǒng)access其它支持軟件無功能名稱功能分類功能概述用戶注冊客戶端用戶利用合法的內部郵箱地址和初始密碼初次登陸，然后注冊個人信息和更改密碼，提交后提示此信息是否已經(jīng)被服務器接受。個人信息包括：昵稱，真實姓名，職務，電話，性別，部門，座位，個性說明及選擇個性化頭像。用戶登錄客戶端用戶利用經(jīng)過注冊的郵箱地址和更改后的密碼登陸，在登陸界面中可以選擇是否記錄密碼和登陸后的在線狀態(tài)（隱身，在線，離開）。如果沒有成功登陸，彈出錯誤提示對話框：服務器超時或郵箱地址和密碼不正確。用戶間通信客戶端與客戶端雙擊想要通信聯(lián)系人的頭像或名字，進入信息編輯器編輯信息（可以更改信息字體）。編輯好信息后點擊發(fā)送即可（如果發(fā)送沒有成功提示“發(fā)送超時請重試”）。也可以在消息編輯器中選擇發(fā)送文件功能。其中表情符號和快捷回復功能會在下一版本中實現(xiàn)。用戶信息管理客戶端用戶可以在登陸狀態(tài)下，任意更改個人信息和密碼。聯(lián)系人管理客戶端聯(lián)系人分為三類：聯(lián)系人，群組和最近聯(lián)系人。用戶可以對自己的聯(lián)系人增加或刪除。后臺管理員分配權限給項目負責人用戶，使項目負責人有權利建立并編輯群組（項目小組）內部人員，以方便組內聯(lián)系。已注冊帳戶管理后臺管理后臺管理人員刪除已注冊用戶或分配，修改已注冊用戶的權限。響應注冊服務器端服務器識別郵箱地址和初始密碼，如果正確就保存信息到數(shù)據(jù)庫，如果不正確就識別錯誤類型，即時回復錯誤提示信息。響應登陸服務器端服務器識別郵箱號和密碼是否匹配，如果該用戶選擇了記錄密碼功能，服務器將查詢本機cookie驗證密碼登陸。如果登陸沒有成功，即時按錯誤類型（密碼錯誤，超時）回復錯誤提示信息。TalkMachineTalkMachine客戶端服務器端后臺管理登錄通信帳戶信息管理聯(lián)系人管理注冊已注冊帳戶管理響應注冊響應登錄響應更新信息4.用例視圖[本節(jié)使用用例分析技術所生成的系統(tǒng)用例模型，描述其中的一些用例或場景。在該模型中納入用例或場景，應該是系統(tǒng)中最重要、最核心的功能部分。][另外，在本節(jié)中還應該選擇一個主要的用例，對其進行描述與解釋，以幫助讀者了解軟件的實際工作方式，解釋不同的設計模型元素如何幫助系統(tǒng)實現(xiàn)。]5.邏輯視圖[邏輯視圖主要是反映系統(tǒng)本質的問題領域類模型，在邏輯視圖中將列出組成系統(tǒng)的子系統(tǒng)、包。而對每個子系統(tǒng)、包分解成為一個個類，并說明這些關鍵的實體類的職責、關系、操作、屬性。這也是OO思想的體現(xiàn)，以類、類與類之間的協(xié)作、包、包與包之間的協(xié)作模型來表達系統(tǒng)的邏輯組織結構。]5.1概述[在本小節(jié)中，列出邏輯視圖的頂層圖，該圖將反映系統(tǒng)由哪些包組成，每個包之間的關系與協(xié)作，以及包的層次結構。使得讀者對整個軟件體系結構有一個整體的了解。]__MainUI_LoginControl_+GetUserinfo()_+Login()_+InfoChanges()_+login_Load_+loadUserInfo()_+Login()_+connectServer()_+ShowResult()_-serialTrans_+login_LoadUI_+login_LinkManControl_+GetList()_+ShowList()_+ListenForOnline_Offline_+SendOnline()_+SendOffline()_+StartListen()_+GetList_+ShowList_+StartListen()5.2影響軟件體系結構的重要設計包[在本小節(jié)中，將從邏輯視圖中選擇有重要意義的設計包，每個設計包有一個小節(jié)來描述，說明這些包的名稱、簡要的說明、該包中的主要類和相關的類圖。對于包中的重要的類，還應該說明其名稱、簡要說明、主要職責、操作、屬性等。]6.進程視圖[本節(jié)主要描述該軟件體系結構下，系統(tǒng)運行態(tài)的情況。描述系統(tǒng)在執(zhí)行時，包括哪些進程（包括線程、進程、進程組），以及它們之間是如何進行通信的、如何進行消息傳遞、接口如何。并且來說明如何進行組織。]7.部署視圖[本節(jié)主要描述該軟件系統(tǒng)部署后的樣子，需要哪些硬件、支撐軟件、網(wǎng)絡環(huán)境。在每個物理節(jié)點上所運行的模塊，它們之間是如何連接的，這些物理節(jié)點與進程之間的映射關系等等。]_LoginControl__LoginControl_-newID:string_+GetUserinfo_+Login()_+InfoChanges()_LoginUILoadUI_+Register_-+login()選擇欲傳輸?shù)奈募x擇欲傳輸?shù)奈募ntry/選擇欲傳輸?shù)奈募l(fā)送傳輸文件請求發(fā)送文件接收到反饋信息處理好友反饋信息好友拒絕接收exit/退出傳輸文件TalkMachine--活動圖：傳輸文件發(fā)送文件結束exit/成功發(fā)送，退出接收好友請求處理好友請求同意接收文件拒絕接收文件返回同意信息返回拒絕信息exit/拒絕接收，退出接收文件接收文件結束exit/成功接收，退出文件發(fā)送方文件接收方8.實施視圖[本節(jié)主要從開發(fā)的角度來描述軟件系統(tǒng)架構，包括其整體結構、層次結構、子系統(tǒng)，以及要使用的第三方控件，自定義控件，以及它們之間的接口。]8.1概述[在本小節(jié)中，說明各個層的內容、邊界與交互，通常用UML中的構件圖進行表示。]8.2層[本小節(jié)則是在上一小節(jié)的基礎上，對每一個層進行說明，并給出每一個層的構件圖，幫助讀者分而治之。]詳細設計說明書1引言 21.1編寫目的 21.2背景 21.3定義 21.4參考資料 22程序系統(tǒng)的結構 33程序1（標識符）設計說明 43.1程序描述 43.2功能 53.3性能 53.4輸人項 53.5輸出項 63.6算法 63.7流程邏輯 73.8接口 83.9存儲分配 83.10注釋設計 83.11限制條件 83.12測試計劃 83.13尚未解決的問題 94程序2（標識符）設計說明 91引言1.1編寫目的對軟件需求的全面、深入的理解是軟件開發(fā)工作獲得成功的前提條件，作為軟件定義時期的最后一個階段，需求分析的任務是明確用戶對目標系統(tǒng)的需求，主要是確定對系統(tǒng)的綜合要求，同時分析系統(tǒng)的數(shù)據(jù)要求。它能提高軟件開發(fā)過程的能見度，便于實現(xiàn)軟件開發(fā)人員對開發(fā)過程的工程化管理與控制，便于項目管理人員、開發(fā)人員、測試人員、維護人員之間更好地交流與協(xié)作。1.2背景開發(fā)軟件系統(tǒng)的名稱：實驗室設備管理系統(tǒng)本項目的任務提出者：第五組開發(fā)者：第五組d.用戶：實驗室設備管理員e.運行系統(tǒng)的計算中心：實驗室電腦1.3定義報廢：管理人員發(fā)現(xiàn)設備因某些原因損壞而導致設備不能使用時，就將該設備記錄下來，并記錄報廢原因。維修：管理人員發(fā)現(xiàn)設備因某些原因損壞需要維修時，就將該設備記錄下來，并提出維修意見。查詢：隨時對現(xiàn)有設備及其修理、報廢情況進行統(tǒng)計、查詢，要求能夠按類別和時間段（某日期之前）查詢1.4參考資料《軟件工程導論》張海藩清華大學出版社實驗室設備管理系統(tǒng)可行性研究報告第五組實驗室設備管理系統(tǒng)需求分析報告第五組實驗室設備管理系統(tǒng)概要設計報告第五組2程序系統(tǒng)的結構用一系列圖表列出本程序系統(tǒng)內的每個程序（包括每個模塊和子程序）的名稱、標識符和它們之間的層次結構關系。設備管理員操作模塊如下圖所示：合法性檢測合法性檢測有效登錄信息？操作界面NY開始終止用戶名及密碼系統(tǒng)功能操作模塊如下圖所示：操作界面操作界面檢查系統(tǒng)NY開始終止選擇操作類型設備操作界面3程序1（標識符）設計說明從本章開始，逐個地給出各個層次中的每個程序的設計考慮。以下給出的提綱是針對一般情況的。對于一個具體的模塊，尤其是層次比較低的模塊或子程序，其很多條目的內容往往與它所隸屬的上一層模塊的對應條目的內容相同，在這種情況下，只要簡單地說明這一點即可。3.1程序描述及時的對購買新設備、維修設備、報廢設備進行審批核實。以及方便的維護管理現(xiàn)有設備。3.2功能說明該程序應具有的功能，可采用IPO圖（即輸入一處理一輸出圖）的形式。IPO表IPO表用戶名事務文件設備名事務文件輸入處理1、信息校驗2、事務處理3、數(shù)據(jù)更新輸出1、設備信息用戶信息2、有效信息輸出3、數(shù)據(jù)更新文件3.3性能說明對該程序的全部性能要求，包括對精度、靈活性和時間特性的要求。3.4輸人項給出對每一個輸入項的特性，包括名稱、標識、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸入的方式。數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)的來源和安全保密條件等等。名稱標識類型數(shù)量數(shù)據(jù)的組織頻度管理員用戶工作請求申請管理員文檔文檔+表格申請購買設備表管理員表格{X}表格+說明維修設備申請表管理員表格{X}表格+說明新設備信息管理員表格{X}表格+說明報廢設備信息管理員表格{X}表格+說明3.5輸出項給出對每一個輸出項的特性，包括名稱、標識、數(shù)據(jù)的類型和格式，數(shù)據(jù)值的有效范圍，輸出的形式、數(shù)量和頻度，輸出媒體、對輸出圖形及符號的說明、安全保密條件等等。用途頻度接口設備情況為管理員用戶和上級領導提供實驗室內設備的具體情況管理員、用戶每次查詢實驗室設備的頻度類別、設備名、型號、規(guī)格、單價、數(shù)量、購買日期、生產(chǎn)廠家、借出情況使用設備的人員信息為管理員用戶和上級領導提供設備使用者的具體情況管理員、用戶每次查詢實驗室設備使用者的頻度設備類別、設備名、設備型號、使用人姓名、使用人單位、借用時間、歸還時間購買設備管理員給出需要購買的設備的信息需要購買設備的頻度類別、設備名、型號、規(guī)格、單價、數(shù)量、購置日期、生產(chǎn)廠家、購買人非法請求信息提示管理員、用戶此次借用非法每次產(chǎn)生非法申請的頻度設備名、設備型號、借用情況修理/報廢/注銷設備資金統(tǒng)計表向單位顯示設備修理/報廢注銷資金統(tǒng)計情況每月一次設備類別、設備名、設備型號、設備規(guī)格、修理/報廢/注銷情況、生產(chǎn)廠家、使用資金3.6算法詳細說明本程序所選用的算法，具體的計算公式和計算步驟。3.7流程邏輯程序流程圖如下圖所示：設備基本信息表開始設備基本信息表開始用戶名及密碼身份驗證選擇操作類型查詢信息°維修設備°新設備信息°實驗室信息°維修記錄表實驗室信息表設備報廢信息表退出NY3.8接口