軟件架構(gòu)設計模板講解

1、架構(gòu)設計說明書產(chǎn)品發(fā)布標識填寫說明：模板中用方括號括起來并以藍色斜體顯示的文本，用于向作者提供指導，在 文檔編輯完成后應該將其刪除。文檔正文應使用常規(guī)、黑色、五號字體即系統(tǒng)設置的“正文” 樣式文檔頁眉處的” xxxx系統(tǒng)”和“版本號”僅為示例，請注意更新封頁與頁眉符合實際情況。 此處的版本號指的是產(chǎn)品版本號封頁簡要表中的產(chǎn)品名，如無可以不填寫。當某一章/節(jié)沒有內(nèi)容時，必須注明N/A，同時標注理由。例如：本章/節(jié)內(nèi)容無需考慮。 特別說明：當某章/節(jié)內(nèi)容參見其它文檔時，不能注明 N/A，而應該寫明參見某文檔的具體章 節(jié)。文檔版本號：文檔編號：文檔密級：歸屬部門/項目：產(chǎn)品名：子系統(tǒng)名：編寫人：編寫

2、日期：華為科技（深圳）有限公司版權(quán)所有內(nèi)部資料注意保密修訂記錄:版本號修訂人修訂日期修訂描述V1.0A王巍2004-5-11創(chuàng)建初稿V1.0B周旳2006-4-23根據(jù)CMMI新流程予以修訂V1.0CENG-TWG2006-8-9根據(jù)CMMI要求予以修訂派發(fā)清單:發(fā)文人/部門日期電話/傳真受文人/部門動作類型*日期電話/傳真*動作類型：批準、審核、通知、歸檔、參與會議，其它（請說明）目錄1簡介61.1目的61.2文檔范圍61.3預期的讀者和閱讀建議 61.4參考文檔81.4.1包含文檔81.4.2相關(guān)文檔81.5縮略語和術(shù)語82總體設計思路92.1設計方法92.2設計可選方案93系統(tǒng)邏輯結(jié)構(gòu)1

3、03.1總體結(jié)構(gòu)103.2子系統(tǒng)定義 103.2.1子系統(tǒng)一 113.2.2子系統(tǒng)二113.3接口設計113.3.1產(chǎn)品外部接口 113.3.2子系統(tǒng)間接口 113.4主要數(shù)據(jù)模型114系統(tǒng)物理結(jié)構(gòu)124.1總體結(jié)構(gòu)124.2組件定義124.2.1 組件一 124.3組件接口設計124.4組件與子系統(tǒng)對應關(guān)系 125系統(tǒng)部署135.1網(wǎng)絡結(jié)構(gòu)圖 135.2部署模式136關(guān)鍵技術(shù)及公用機制136.1關(guān)鍵技術(shù)設計 136.2公用機制說明137系統(tǒng)重用設計137.1 第三方硬件設備說明 157.2第三方軟件說明158系統(tǒng)非功能特性設計158.1可擴展性158.2可維護性158.3安全168.4容錯性

4、168.5可移植性168.6可部署性168.7 169總體約束169.1遵循標準169.2文件約定179.3目錄約定179.4對后續(xù)設計的約束179.51710風險1711附錄171簡介1.1目的描述本架構(gòu)設計文檔的主要目的。架構(gòu)文檔從構(gòu)架方面對系統(tǒng)進行綜合概述，描述了系統(tǒng)最高層次上的邏輯結(jié)構(gòu)、物理結(jié) 構(gòu)以及各種指南。它用于記錄并表述已在構(gòu)架方面對系統(tǒng)作出的重要決定，并對相關(guān)子系統(tǒng) 的設計起總體上的指導作用。1.2文檔范圍簡要說明此文檔的范圍：它的相關(guān)項目以及受到此文檔影響的任何其它事物例如，本文檔適用的產(chǎn)品、模塊，覆蓋的范圍等，受這份文檔影響的相關(guān)產(chǎn)品、模塊等, 不在該文檔覆蓋范圍內(nèi)的但可能

5、引起疑義的問題。1.3預期的讀者和閱讀建議說明此文檔的閱讀對象，簡要說明此文檔中其它章節(jié)包含的內(nèi)容與文檔組織方式，對于 不同讀者的閱讀方式建議。如：XXX系統(tǒng)開發(fā)過程的各角色：產(chǎn)品角色、系統(tǒng)分析架構(gòu)角色、項目管理角色、代碼角色、 測試角色、文檔角色XXX系統(tǒng)的部署角色、培訓角色、維護角色；XXX公司售前技術(shù)支持角色此文檔的第2章描述系統(tǒng)體系結(jié)構(gòu)圖系統(tǒng)子系統(tǒng)邏輯上劃分:物理上劃分:模塊組件類庫等子模塊V羊元例如：本文檔組織方式:第一章 簡介，描述文檔的目的；第二章 描述總體設計思路，包括設計方法及備選設計方案和方案的選擇；第三章描述系統(tǒng)的邏輯結(jié)構(gòu)。從最高層次上描述系統(tǒng)的邏輯組成；第四章描述系統(tǒng)的

6、物理結(jié)構(gòu)。從最高層次上描述系統(tǒng)的物理組成；第五章描述系統(tǒng)的部署情況；第六章 對系統(tǒng)架構(gòu)中的關(guān)鍵技術(shù)及公用設計機制進行描述；第七章如何重用以往設計產(chǎn)物及現(xiàn)有設計如何對將來重用產(chǎn)生影響進行描述；第八章 對系統(tǒng)中重要的用例或者有技術(shù)難度的部分進行功能實現(xiàn)的描述，以方便設計人 員在進行設計、開發(fā)時進行參考；第九章對系統(tǒng)依賴的第三方軟硬件進行描述；第十章對系統(tǒng)的非功能特性設計進行描述；產(chǎn)品經(jīng)理應當關(guān)注該部分的描述是否與產(chǎn)品 需求中產(chǎn)品的非功能性需求一致；開發(fā)人員應當在后續(xù)設計過程中對這部分設計 進行關(guān)注，避免遺漏；測試人員應當根據(jù)這部分的描述制定測試案例，驗證是否 可以達到產(chǎn)品需求的要求。第十一章描述系

7、統(tǒng)架構(gòu)設計中的約束條件；第十二章描述架構(gòu)設計中識別的風險，產(chǎn)品經(jīng)理、設計人員、開發(fā)人員和測試人員都應當隨時關(guān)注這些風險，避免風險發(fā)生并及時采取規(guī)避、減輕措施。第十三章 附錄1.4參考文檔架構(gòu)設計的參考文檔應當包括但不限于：產(chǎn)品需求說明書等；同時，文檔中說明為引用、參考的文檔也應該在這里列出。參考文檔需要按包含、相關(guān)的關(guān)系分別在下面的小節(jié)中列出。1.4.1包含文檔當本文有包含文檔時，需要提供相關(guān)的包含文檔列表。包含文檔：作為本架構(gòu)設計的一部分，是不可分割的組成部分，讀者閱讀本架構(gòu)設計時 必須同時也閱讀的文檔。如當架構(gòu)設計非常復雜而有分冊時，貝分冊就屬于本文檔的包含文 檔。1.4.2相關(guān)文檔當本文

8、有相關(guān)文檔時，需要提供相關(guān)文檔列表。相關(guān)文檔：具有關(guān)聯(lián)關(guān)系的文檔。讀者在閱讀架構(gòu)說明書時如果有必要可以參考閱讀的 文檔。1.5縮略語和術(shù)語適當時，提供與此文檔相關(guān)的術(shù)語及縮略語的定義?？s略語/術(shù)語全稱說明2總體設計思路2.1設計方法本軟件系統(tǒng)所采取的設計方法，以及主要的設計原則。設計方法可包括但不限于：1）采用RUP的設計方法論；2）采用從業(yè)務而下的系統(tǒng)分解，從技術(shù)至上的系統(tǒng)抽象方法以及具體應用系統(tǒng)的特定設計方法等。22設計可選方案對本系統(tǒng)的幾種設計方案進行分析、比較，并確定所采用的方案?？蛇x方案不僅是對同一需求的不同處理方式，也可以是需求與設計元素之間配置的不同 思考，包括新研發(fā)的技術(shù)，或者

9、是不同應用的成熟技術(shù)及維持現(xiàn)有方法，目標是將整體的解 決方案最佳化，而非個別設計的優(yōu)劣。可選解決方案涵蓋可接受的成本、計劃、效能的范圍。產(chǎn)品關(guān)鍵需求與設計問題、限制 及準則一起用于開發(fā)備選方案。評選的準則通常必須強調(diào)成本（例如：時間、人員、費用）、 效益（例如：性能、有效性）及風險（例如：技術(shù)、成本、計劃）。詳細的可選解決方案及 評選的準則可包括但不限于：成本（研發(fā)、購買、支持、產(chǎn)品生命周期）技術(shù)性能技術(shù)限制產(chǎn)品的擴展及成長性需求與技術(shù)的演進最終用戶及操作者的能力與限制構(gòu)建方法與材料的敏感度風險以上為最基本的考慮因素，研發(fā)團隊應該開發(fā)與目標一致的備選方案節(jié)選準則，以縮小 可選清單，并可以通過決

10、策分析的方法來進行評估選擇。例如：1）可選方案一2）可選方案二3）方案的評選策略及準則 需要包括決策分析單。D：appseT verselectd4）最佳化的方案3系統(tǒng)邏輯結(jié)構(gòu)本章描述系統(tǒng)的總體邏輯結(jié)構(gòu)，包括子系統(tǒng)的劃分與依賴關(guān)系定義、子系統(tǒng)之間的接口 定義、子系統(tǒng)功能定義。3.1總體結(jié)構(gòu)本節(jié)定義系統(tǒng)的總體邏輯結(jié)構(gòu)，定義子系統(tǒng)劃分以及子系統(tǒng)之間的依賴關(guān)系。為了統(tǒng)一與便于理解，當用圖形化表示子系統(tǒng)、子系統(tǒng)之間的依賴關(guān)系時，建議采用UML 的符號與表示方法。3.2子系統(tǒng)定義本節(jié)明確定義各個子系統(tǒng)的功能以及子系統(tǒng)的設計思路，本節(jié)通常按照子系統(tǒng)進行組織。321子系統(tǒng)一包括：子系統(tǒng)概述子系統(tǒng)功能子系統(tǒng)設

11、計思路322子系統(tǒng)二3.3接口設計定義接口設計的策略，識別接口，以及接口完成的功能，具體接口定義另行定義文檔承 載，采用接口設計說明書模板。3.3.1產(chǎn)品外部接口描述產(chǎn)品對外接口的相關(guān)定義。3.3.2子系統(tǒng)間接口描述產(chǎn)品內(nèi)部子系統(tǒng)間接口的相關(guān)定義。3.4主要數(shù)據(jù)模型本節(jié)在邏輯層面上定義系統(tǒng)所包含的主要數(shù)據(jù)模型，通常以E-R圖形式來表現(xiàn)。具體的 數(shù)據(jù)字典及數(shù)據(jù)結(jié)構(gòu)在數(shù)據(jù)庫設計文檔中定義，在高層設計階段完成。4系統(tǒng)物理結(jié)構(gòu)定義系統(tǒng)總體物理結(jié)構(gòu)、包括組件劃分及依賴關(guān)系定義，每個組件中要完成的功能及組 件間接口。如功能已經(jīng)在前面的子系統(tǒng)分解中有描述，則重點描述本組件完成了哪些子系統(tǒng) 的哪些功能。組件是

12、物理上的運行結(jié)構(gòu)元素。例如：進程、線程等。4.1總體結(jié)構(gòu)本節(jié)定義系統(tǒng)的總體物理結(jié)構(gòu)，定義組件劃分以及組件之間的關(guān)系。4.2組件定義4.2.1組件一包括：組件名稱組件類型組件功能4.3組件接口設計定義接口設計的策略，組件間的接口主要是描述一些共享內(nèi)存，協(xié)議數(shù)據(jù)，消息等，具 體接口如有需要可另行定義文檔承載，采用接口設計說明書模板4.4組件與子系統(tǒng)對應關(guān)系定義組件與子系統(tǒng)的關(guān)系，即各組件實現(xiàn)哪些子系統(tǒng)功能，可通過列表的形式定義，如 有需要，可通過圖示的形式加以說明。5系統(tǒng)部署本章描述系統(tǒng)部署，說明用來部署并運行該系統(tǒng)的一種或多種物理網(wǎng)絡（硬件）配置。 對于每種配置，應該指出執(zhí)行該系統(tǒng)的物理節(jié)點（計

13、算機、網(wǎng)絡設備）配置情況（包括硬件、 操作系統(tǒng)、支撐軟件）、節(jié)點之間的連接方式、采用何種通信協(xié)議、網(wǎng)絡帶寬。另外還要包 括各進程到物理節(jié)點的映射。5.1網(wǎng)絡結(jié)構(gòu)圖描述系統(tǒng)所處的整體網(wǎng)絡結(jié)構(gòu)。5.2部署模式描述系統(tǒng)幾種可能的部署模式，并解釋在定義配置時要遵循的一般映射規(guī)則。例如：在 不同的業(yè)務規(guī)模情況下，存在的不同部署模式。6關(guān)鍵技術(shù)及公用機制6.1關(guān)鍵技術(shù)設計描述系統(tǒng)的關(guān)鍵技術(shù)設計，以解決重要或高風險的問題6.2公用機制說明描述系統(tǒng)實現(xiàn)所需要的公用機制，例如采用的中間件技術(shù)、通用緩存等 7系統(tǒng)重用設計軟件重用是指通過對已有軟件的各種有關(guān)知識來建立新的軟件，這些知識包括：領(lǐng)域知 識、開發(fā)經(jīng)驗、設

14、計經(jīng)驗、設計決定、體系結(jié)構(gòu)、需求、設計、編碼、測試和文檔等。這個 定義蘊含著軟件重用所必須包含的兩個方面：1. 系統(tǒng)地開發(fā)可重用的軟件產(chǎn)品。2. 系統(tǒng)地使用這些軟件產(chǎn)品作為構(gòu)筑新的軟件產(chǎn)品，來建立新的系統(tǒng)。軟件重用目的是降低軟件開發(fā)和維護的成本，提高軟件開發(fā)效率，提高軟件的質(zhì)量。軟件重用的過程一般包括，抽象、選取、特化、集成：抽象，對已有軟件產(chǎn)品的概念描述，從中抽取該產(chǎn)品的本質(zhì)信息（即可重用部分）。選?。河脩舾鶕?jù)已有軟件產(chǎn)品的抽象，尋找、比較和選擇最適合需要的軟件產(chǎn)品（可重 用件）。特化：對已有軟件產(chǎn)品（可重用件）的修改或形成它的一個實例（實例化后的重用件）。集成：將實例化后的重用件集成到應用

15、系統(tǒng)。軟件重用的形式，常用的為垂直式重用和水平式重用：垂直式重用：指在一類具有較多公共性的應用領(lǐng)域之間進行軟件重用，由于存在許多共性或相似性，因此重用面較廣，且有助于獲得系統(tǒng)的通用模型。首先進行領(lǐng)域分析，根據(jù)應用領(lǐng)域的特征及相似性預測軟件的可重用性；然后進行相應的軟件開發(fā)。一旦確認了軟件的 重用價值，即可進行通用化，以便能夠適應新的類似的應用領(lǐng)域；最后，對軟件及其文檔進 行管理，成為可供后續(xù)項目使用的可重用資源。水平式重用：重用不同應用領(lǐng)域中的軟件元素，例如數(shù)據(jù)結(jié)構(gòu)、分類算法、人機界面構(gòu) 件等。標準函數(shù)庫是一種典型的原始的水平式重用機制。軟件重用的粒度主要有以下幾種：1. 源代碼模塊或者類一級

16、的重用。這是最基本的軟件重用形式。2. 二進制形式的重用。如組件重用。3. 組裝式重用。比如：把好幾個應用程序的功能集成在一起。例如，要建立一個門 戶站點應用，登陸用戶既可以查詢天氣情況，又可以查看股市行情，還可以在線購物。這些 功能由不同網(wǎng)絡應用服務供應商提供，通過這種組裝式重用，就可以非常容易地把上述功能 都集成到新的門戶站點中。4. 分析級別重用。5. 設計級別重用。6. 軟件文檔重用。軟件重用技術(shù)軟件重用技術(shù)包括：庫函數(shù)，模板，面向?qū)ο?、設計模式、構(gòu)件、體系架構(gòu)、體系架構(gòu)模 式/風格等。1. 庫函數(shù)對于庫函數(shù)的使用者，只要知道函數(shù)的名稱，返回值的類型，函數(shù)參數(shù)和函數(shù)功能就可 以對其進行

17、調(diào)用。2. 面向?qū)ο竺嫦驅(qū)ο蠹夹g(shù)通過方法、消息、類、繼承、封裝、和實例等機制構(gòu)造軟件系統(tǒng)，并為 軟件重用提供強有力的支持。如 VC+中的MFC。3. 模板模板相當于工業(yè)生產(chǎn)中所用的“模具”。有各種各樣的模板（如文檔模板，網(wǎng)頁模板等），利用這些模板可以比較快速地建立對應的軟件產(chǎn)品。模板把不變的封裝在內(nèi)部，對可能變化本號，運行環(huán)境，參數(shù)以及簡要描述7.1第三方硬件設備說明描述系統(tǒng)可使用的第三方硬件需求，以及第三方硬件的簡要描述。例如：需要加密卡提供高速邏輯加密功能；需要網(wǎng)絡交換機提供四層交換功能等。7.2第三方軟件說明描述系統(tǒng)可使用的第三方軟件需求，以及第三方軟件的簡要描述。8系統(tǒng)非功能特性設計本

18、章描述系統(tǒng)的整體性能、安全性、可用性、可擴展性、容錯等非功能特性設計。8.1可擴展性描述系統(tǒng)可擴展性設計與實現(xiàn)方案。需要對性能、功能、網(wǎng)管/審計、報表的可擴展性進 行描述。例如：考慮組件化設計，以使系統(tǒng)能夠適應將來可能出現(xiàn)的新業(yè)務和可能出現(xiàn)的一些變化。新增業(yè)務功能時不應需要改造原軟件系統(tǒng)，可通過動態(tài)加載新增組件的方式實現(xiàn)。描述系統(tǒng)性能設計與實現(xiàn)方案。例如：采用多種數(shù)據(jù)/對象的緩存機制；采用并發(fā)處理機制；采用異步處理方式等。8.2可維護性描述系統(tǒng)可維護性設計與實現(xiàn)方案。系統(tǒng)可維護性包括系統(tǒng)監(jiān)控與告警、系統(tǒng)配置、數(shù) 據(jù)備份及清理。例如：考慮在線修改配置信息，而不中斷業(yè)務的設計機制。8.3安全描述系統(tǒng)安全性設計與實現(xiàn)方案。系統(tǒng)安全性包括網(wǎng)絡安全、系