《軟件架構(gòu)說明書》模板

XXXX系統(tǒng)軟件架構(gòu)說明書第4頁XXXX系統(tǒng)軟件架構(gòu)說明書作者：___XXXXXX___________審核：___XXXXXXXX____________批準：_____XXXX__________完成時間：___2014-06-17_______文件建立/修改記錄序號版本建立或修改建立/修改人日期審核人日期批準人日期11.0建立XXXX年X月X日21.1修改XXXX年X月X日目錄1 簡介 41.1 文檔編寫目的 41.2 文檔范圍 41.3 術(shù)語和省略語 41.4 參考資料 42 架構(gòu)表示方式 43 架構(gòu)設(shè)計目標與約束 43.1 關(guān)鍵功能需求 53.2 關(guān)鍵質(zhì)量需求 53.2.1 有效性 53.2.2 性能 53.2.3 性能可擴展 53.2.4 功能可擴展 53.3 系統(tǒng)設(shè)計原則 53.4 開發(fā)策略 53.4.1 軟件復用策略 53.4.2 使用開源架構(gòu) 53.4.3 使用商業(yè)構(gòu)件 53.5 其它設(shè)計約束 54 用例視圖 64.1 概述 64.2 關(guān)鍵用例 64.2.1 關(guān)鍵的系統(tǒng)參與者 64.2.2 關(guān)鍵的系統(tǒng)用例 64.3 關(guān)鍵系統(tǒng)用例簡述 65 邏輯視圖 65.1 概述 65.2 系統(tǒng)層次模型 75.3 主要的設(shè)計包和子系統(tǒng) 76 進程視圖 76.1 概述 76.2 總體進程架構(gòu) 77 部署視圖 77.1 概述 77.2 部署方案1 87.3 部署方案2 87.4 部署方案N 88 實施視圖 88.1 概述 88.2 實施模型總體架構(gòu) 89 數(shù)據(jù)視圖 89.1 概述 89.2 數(shù)據(jù)域模型設(shè)計 8簡介文檔編寫目的本文檔全面與系統(tǒng)地表述目標軟件系統(tǒng)的構(gòu)架，并通過使用多種視圖來從不同角度描述系統(tǒng)的各個主要方面，以滿足相關(guān)涉眾（客戶、設(shè)計人員等）對目標系統(tǒng)的不同關(guān)注焦點。本文檔記錄并表述了架構(gòu)師對系統(tǒng)構(gòu)架方面做出的重要決策；項目經(jīng)理將根據(jù)構(gòu)架定義的構(gòu)件結(jié)構(gòu)制定項目的開發(fā)計劃；設(shè)計員將據(jù)此進行各構(gòu)件的詳細設(shè)計；測試設(shè)計員按照構(gòu)架設(shè)計系統(tǒng)的總體測試框架；另外構(gòu)架文檔還用于指導各構(gòu)件的實施、集成及測試。文檔范圍本文檔適合XXXX系統(tǒng)的總體應用架構(gòu)。術(shù)語和省略語參考資料《XXXX系統(tǒng)》架構(gòu)表示方式本文檔以一系列的視圖（View）來表示系統(tǒng)的軟件構(gòu)架，主要包括用例視圖、邏輯視圖、進程視圖、部署視圖、實施視圖（即RUP推薦的4+1視圖）等；每個視圖擁有一個或多個模型（Model）（例如邏輯視圖包含分析模型、設(shè)計模型和數(shù)據(jù)模型等）；并圍繞相關(guān)視圖來描述系統(tǒng)的基本結(jié)構(gòu)、組成機制與工作原理等。本文檔還將系統(tǒng)的構(gòu)架機制描述也放在了邏輯視圖之下。本文檔主要使用統(tǒng)一建模語言（UML）來充當相關(guān)模型的表達語言；主要圖表（Diagram）引用自目標系統(tǒng)的RoseModel。架構(gòu)設(shè)計目標與約束描述構(gòu)架設(shè)計必須滿足的關(guān)鍵系統(tǒng)功能需求和質(zhì)量約束，這些功能需求和質(zhì)量要求對軟件構(gòu)架有重大的影響，并決定了構(gòu)架的設(shè)計。本節(jié)同時還列明影響構(gòu)架的其他相關(guān)因素，如軟件的復用策略、使用商業(yè)構(gòu)件、設(shè)計與實施的策略等。關(guān)鍵功能需求內(nèi)部用戶、系統(tǒng)管理員在安全性較高的內(nèi)網(wǎng)中使用系統(tǒng)的功能。關(guān)鍵質(zhì)量需求有效性系統(tǒng)平均可用時間大于99.99%。性能系統(tǒng)并發(fā)用戶在線數(shù)大于50。普通數(shù)據(jù)錄入、查找等操作，每單步操作最大延遲時間應小于5秒。一般查詢統(tǒng)計，結(jié)果集在100條記錄以內(nèi)情況下，最大延遲時間不超過30秒。所有統(tǒng)計，其最大延遲時間不超過2分鐘。性能可擴展支持硬件系統(tǒng)性能升級與數(shù)量擴充。功能可擴展系統(tǒng)應支持新的管理模塊業(yè)務(wù)。系統(tǒng)設(shè)計原則開發(fā)策略軟件復用策略系統(tǒng)中重要基礎(chǔ)構(gòu)件應當具備較高的設(shè)計與構(gòu)建質(zhì)量，可以在產(chǎn)品中復用。使用開源架構(gòu)系統(tǒng)基礎(chǔ)框架主要采用業(yè)界的一些主流開源框架，包括：struts、spring、hibernate、log4j等。單元測試使用junit框架。使用商業(yè)構(gòu)件不適用。其它設(shè)計約束目標構(gòu)架總體上應采用分層結(jié)構(gòu)，并全面應用面向?qū)ο笤O(shè)計、編程技術(shù)使系統(tǒng)具有較好的擴展性與重用性。本系統(tǒng)支持與其他系統(tǒng)進行集成，所以要提取出良好的集成接口。用例視圖概述用例視圖從用戶使用的角度描述系統(tǒng)構(gòu)架的基本外部行為特性，通常包含業(yè)務(wù)用例模型與系統(tǒng)用例模型。業(yè)務(wù)用例模型不適用于本系統(tǒng)，這里只關(guān)注系統(tǒng)用例。這里選取了用例模型中對系統(tǒng)構(gòu)架的內(nèi)容產(chǎn)生重大影響的應用場景與用例集合，這些用例代表了系統(tǒng)主要的核心功能，往往決定了系統(tǒng)構(gòu)架的基本組成元素。有些用例強調(diào)或決定了構(gòu)架的某些具體然而重要的細節(jié)，通常也可以列在本節(jié)內(nèi)，總之所列的用例集合應基本覆蓋系統(tǒng)構(gòu)架的主要方面。關(guān)鍵用例關(guān)鍵的系統(tǒng)參與者關(guān)鍵的系統(tǒng)用例關(guān)鍵系統(tǒng)用例簡述描述系統(tǒng)用例場景。邏輯視圖概述邏輯視圖從系統(tǒng)內(nèi)在邏輯結(jié)構(gòu)的角度描述系統(tǒng)的基本結(jié)構(gòu)與動態(tài)行為，通常包括分析模型（AnalysisModel）、設(shè)計模型（DesignModel）以及數(shù)據(jù)模型（DataModel）等。設(shè)計模型說明了系統(tǒng)的組成元素、組織架構(gòu)和關(guān)系，并描述了各組成元素的協(xié)作以及狀態(tài)轉(zhuǎn)換關(guān)系等（通過用例實現(xiàn)UseCaseRealization予以表達）。本節(jié)將分別在系統(tǒng)層次結(jié)構(gòu)模型中描述系統(tǒng)的層次組織結(jié)構(gòu)；在主要的包和子系統(tǒng)中說明系統(tǒng)的具體組成；并在架構(gòu)機制中詳述系統(tǒng)中的各種構(gòu)架機制；最后在關(guān)鍵用例實現(xiàn)中通過描述最重要的用例實現(xiàn)，來說明構(gòu)架的典型協(xié)作（動態(tài)行為）。分析模型對等于設(shè)計模型，是在更高的抽象層次上定義系統(tǒng)的結(jié)構(gòu)，作為可選項，本文檔將不予說明。系統(tǒng)層次模型主要的設(shè)計包和子系統(tǒng)對每一層進行描述進程視圖概述進程視圖從系統(tǒng)運行時刻的角度，描述系統(tǒng)劃分為進程、線程的結(jié)構(gòu)，及其動態(tài)關(guān)系。模型主要說明進程、線程的分類，系統(tǒng)構(gòu)架敏感的主要邊界類、控制類對象等在進程、線程中的分布，以及它們之間的創(chuàng)建、交互與消息通訊關(guān)系等?？傮w進程架構(gòu)部署視圖概述部署視圖從系統(tǒng)軟硬件物理配置的角度，描述系統(tǒng)的網(wǎng)絡(luò)邏輯拓撲結(jié)構(gòu)。模型包括各個物理節(jié)點的硬件與軟件配置，網(wǎng)絡(luò)的邏輯拓撲結(jié)構(gòu)，節(jié)點間的交互與通訊關(guān)系等。同時還表達了進程視圖中的各個進程具體分配到物理節(jié)點的映射關(guān)系。部署方案1部署