20XX軟件架構(gòu)設(shè)計(jì)模板講解

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

2、深圳）有限公司版權(quán)所有注意保密內(nèi)部資料.文檔存盤名稱修訂記錄:版本號修訂人修訂日期修訂描述V1.0A王巍2004-5-11創(chuàng)建初稿V1.0B周旳2006-4-23CMMI新流程予以修訂根據(jù)V1.0CENG-TWG2006-8-9要求予以修訂根據(jù) CMMI注意保密頁2第內(nèi)部資料.文檔存盤名稱派發(fā)清單:發(fā)文人/部門日期電話/傳真受文人/部門動作類型*日期電話/傳真*動作類型：批準(zhǔn)、審核、通知、歸檔、參與會議，其它（請說明）注意保密頁3第內(nèi)部資料.文檔存盤名稱目錄1簡介61.1目的61.2文檔范圍 61.3預(yù)期的讀者和閱讀建議 61.4參考文檔 8包含文檔8相關(guān)文檔81.5縮略語和術(shù)語82總體設(shè)計(jì)思

3、路92.1設(shè)計(jì)方法 92.2設(shè)計(jì)可選方案93系統(tǒng)邏輯結(jié)構(gòu)103.1總體結(jié)構(gòu) 103.2子系統(tǒng)定義 10子系統(tǒng)一 11322子系統(tǒng)二113.3接口設(shè)計(jì) 11產(chǎn)品外部接口 11子系統(tǒng)間接口 113.4主要數(shù)據(jù)模型 114系統(tǒng)物理結(jié)構(gòu) 124.1總體結(jié)構(gòu) 124.2組件定義 124.2.1 組件一 124.3組件接口設(shè)計(jì)124.4組件與子系統(tǒng)對應(yīng)關(guān)系 125系統(tǒng)部署135.1網(wǎng)絡(luò)結(jié)構(gòu)圖 135.2部署模式 136關(guān)鍵技術(shù)及公用機(jī)制 136.1關(guān)鍵技術(shù)設(shè)計(jì) 136.2公用機(jī)制說明137系統(tǒng)重用設(shè)計(jì)137.1第三方硬件設(shè)備說明 15注意保密頁4第內(nèi)部資料.文檔存盤名稱7.2第三方軟件說明 158系統(tǒng)非功

4、能特性設(shè)計(jì)158.1可擴(kuò)展性 158.2可維護(hù)性 158.3安全168.4容錯性 168.5可移植性 168.6可部署性 168.7 169總體約束 169.1遵循標(biāo)準(zhǔn) 169.2文件約定 179.3目錄約定 179.4對后續(xù)設(shè)計(jì)的約束 179.51710風(fēng)險(xiǎn)1711附錄17注意保密頁5第內(nèi)部資料.文檔存盤名稱1簡介1.1目的描述本架構(gòu)設(shè)計(jì)文檔的主要目的。架構(gòu)文檔從構(gòu)架方面對系統(tǒng)進(jìn)行綜合概述，描述了系統(tǒng)最高層次上的邏輯結(jié)構(gòu)、物理結(jié)構(gòu)以及各種指南。它用于記錄并表述已在構(gòu)架方面對系統(tǒng)作出的重要 決定，并對相關(guān)子系統(tǒng)的設(shè)計(jì)起總體上的指導(dǎo)作用。1.2文檔范圍簡要說明此文檔的范圍：它的相關(guān)項(xiàng)目以及受到此

5、文檔影響的任何其它事物例如，本文檔適用的產(chǎn)品、模塊，覆蓋的范圍等，受這份文檔影響的相關(guān)產(chǎn)品、模塊等，不在該文檔覆蓋范圍內(nèi)的 但可能引起疑義的問題。1.3預(yù)期的讀者和閱讀建議說明此文檔的閱讀對象，簡要說明此文檔中其它章節(jié)包含的內(nèi)容與文檔組織方式，對于不同讀者的閱讀方式建議。如：系統(tǒng)開發(fā)過程的各角色：產(chǎn)品角色、系統(tǒng)分析架構(gòu)角色、項(xiàng)目管理角色、代碼角色、XXX測試角色、文檔角色系統(tǒng)的部署角色、培訓(xùn)角色、維護(hù)角色；XXX公司售前技術(shù)支持角色 XXX此文檔的第章描述2.系統(tǒng)體系結(jié)構(gòu)圖注意保密頁6第內(nèi)部資料.文檔存盤名稱系婉子系統(tǒng)、It組件進(jìn)程、純積類崖等邏輯上劃分：物理上劃分:模塊4子模塊單元例如：本文

6、檔組織方式：簡介，描述文檔的目的；第一章描述總體設(shè)計(jì)思路，包括設(shè)計(jì)方法及備選設(shè)計(jì)方案和方案的選擇；第二章描述系統(tǒng)的邏輯結(jié)構(gòu)。從最高層次上描述系統(tǒng)的邏輯組成；第三章描述系統(tǒng)的物理結(jié)構(gòu)。從最高層次上描述系統(tǒng)的物理組成；第四章 描述系統(tǒng)的部署情況；第五章對系統(tǒng)架構(gòu)中的關(guān)鍵技術(shù)及公用設(shè)計(jì)機(jī)制進(jìn)行描述；第六章如何重用以往設(shè)計(jì)產(chǎn)物及現(xiàn)有設(shè)計(jì)如何對將來重用產(chǎn)生影響進(jìn)行描述；第七章對系統(tǒng)中重要的用例或者有技術(shù)難度的部分進(jìn)行功能實(shí)現(xiàn)的描述，以方便設(shè)計(jì)人第八章員在進(jìn)行設(shè)計(jì)、開發(fā)時進(jìn)行參考；對系統(tǒng)依賴的第三方軟硬件進(jìn)行描述；第九章對系統(tǒng)的非功能特性設(shè)計(jì)進(jìn)行描述；產(chǎn)品經(jīng)理應(yīng)當(dāng)關(guān)注該部分的描述是否與產(chǎn)品第十章需求中產(chǎn)品

7、的非功能性需求一致；開發(fā)人員應(yīng)當(dāng)在后續(xù)設(shè)計(jì)過程中對這部分設(shè)計(jì)進(jìn)行關(guān)注，避免遺漏； 測試人員應(yīng)當(dāng)根據(jù)這部分的描述制定測試案例，驗(yàn)證是否可以達(dá)到產(chǎn)品需求的要求。描述系統(tǒng)架構(gòu)設(shè)計(jì)中的約束條件；第十一章描述架構(gòu)設(shè)計(jì)中識別的風(fēng)險(xiǎn)，產(chǎn)品經(jīng)理、設(shè)計(jì)人員、開發(fā)人員和測試人員第十二章都應(yīng)當(dāng)隨時關(guān)注這些風(fēng)險(xiǎn)，避免風(fēng)險(xiǎn)發(fā)生并及時采取規(guī)避、減輕措施。附錄第十三章注意保密頁7第內(nèi)部資料.文檔存盤名稱1.4參考文檔同時，文檔中說明為引用、參考架構(gòu)設(shè)計(jì)的參考文檔應(yīng)當(dāng)包括但不限于：產(chǎn)品需求說明書等; 的文檔也應(yīng)該在這里列出。參考文檔需要按包含、相關(guān)的關(guān)系分別在下面的小節(jié)中列出。包含文檔當(dāng)本文有包含文檔時，需要提供相關(guān)的包含文

8、檔列表。包含文檔：作為本架構(gòu)設(shè)計(jì)的一部分，是不可分割的組成部分，讀者閱讀本架構(gòu)設(shè)計(jì)時必須同時也閱讀的文檔。如當(dāng)架構(gòu)設(shè)計(jì)非常復(fù)雜 而有分冊時，則分冊就屬于本文檔的包含文檔。142相關(guān)文檔當(dāng)本文有相關(guān)文檔時，需要提供相關(guān)文檔列表。相關(guān)文檔：具有關(guān)聯(lián)關(guān)系的文檔。讀者在閱讀架構(gòu)說明書時如果有必要可以參考閱讀的文檔。1.5縮略語和術(shù)語適當(dāng)時，提供與此文檔相關(guān)的術(shù)語及縮略語的定義。明說全術(shù)語縮略語/稱注意保密頁8第內(nèi)部資料.文檔存盤名稱2總體設(shè)計(jì)思路2.1設(shè)計(jì)方法本軟件系統(tǒng)所采取的設(shè)計(jì)方法，以及主要的設(shè)計(jì)原則。設(shè)計(jì)方法可包括但不限于：）采用的設(shè)計(jì)方法論； RUP1 ）采用從業(yè)務(wù)而下的系統(tǒng)分解，從技術(shù)至上的

9、系統(tǒng)抽象方法2以及具體應(yīng)用系統(tǒng)的特定設(shè)計(jì)方法等。2.2設(shè)計(jì)可選方案對本系統(tǒng)的幾種設(shè)計(jì)方案進(jìn)行分析、比較，并確定所采用的方案。 可選方案不僅是對同一需求 的不同處理方式，也可以是需求與設(shè)計(jì)元素之間配置的不同思考， 包括新研發(fā)的技術(shù)，或者是不 同應(yīng)用的成熟技術(shù)及維持現(xiàn)有方法，目標(biāo)是將整體的解決方案最佳化，而非個別設(shè)計(jì)的優(yōu)劣?？蛇x解決方案涵蓋可接受的成本、計(jì)劃、效能的范圍。產(chǎn)品關(guān)鍵需求與設(shè)計(jì)問題、限制及準(zhǔn)則一 起用于開發(fā)備選方案。評選的準(zhǔn)則通常必須強(qiáng)調(diào)成本（例如：時間、人員、費(fèi)用）、效益（例如： 性能、有效性）及風(fēng)險(xiǎn)（例如：技術(shù)、成本、計(jì)劃）。詳細(xì)的可選解決方案及評選的準(zhǔn)則可包括 但不限于：成本（研

10、發(fā)、購買、支持、產(chǎn)品生命周期）技術(shù)性能技術(shù)限制產(chǎn)品的擴(kuò)展及成長性需求與技術(shù)的演進(jìn)最終用戶及操作者的能力與限制構(gòu)建方法與材料的敏感度風(fēng)險(xiǎn)以上為最基本的考慮因素，研發(fā)團(tuán)隊(duì)?wèi)?yīng)該開發(fā)與目標(biāo)一致的備選方案節(jié)選準(zhǔn)則， 以縮小可選清單， 并可以通過決策分析的方法來進(jìn)行評估選擇。注意保密頁9第內(nèi)部資料.文檔存盤名稱例如:可選方案一 1）可選方案二2）方案的評選策略及準(zhǔn)則 3）D:需要包括決策分析單。appscrvcrscIcctd最佳化的方案4)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)劃

11、分以及子系統(tǒng)之間的依賴關(guān)系。 為了統(tǒng)一與便于 理解，當(dāng)用圖形化表示子系統(tǒng)、子系統(tǒng)之間的依賴關(guān)系時，建議采用 UML的符號與表示方法。3.2子系統(tǒng)定義本節(jié)明確定義各個子系統(tǒng)的功能以及子系統(tǒng)的設(shè)計(jì)思路，本節(jié)通常按照子系統(tǒng)進(jìn)行組織。注意保密頁io第內(nèi)部資料.文檔存盤名稱321子系統(tǒng)一包括：子系統(tǒng)概述 子系統(tǒng)功能子系統(tǒng)設(shè)計(jì)思路322子系統(tǒng)二3.3接口設(shè)計(jì)定義接口設(shè)計(jì)的策略，識別接口，以及接口完成的功能，具體接口定義另行定義文檔承載，采用接口設(shè)計(jì)說明書模板。331產(chǎn)品外部接口描述產(chǎn)品對外接口的相關(guān)定義。子系統(tǒng)間接口描述產(chǎn)品內(nèi)部子系統(tǒng)間接口的相關(guān)定義。3.4主要數(shù)據(jù)模型本節(jié)在邏輯層面上定義系統(tǒng)所包含的主要

12、數(shù)據(jù)模型，通常以圖形式來表現(xiàn)。具體的E-R數(shù)據(jù)字典及數(shù)據(jù)結(jié)構(gòu)在數(shù)據(jù)庫設(shè)計(jì)文檔中定義，在高層設(shè)計(jì)階段完成。注意保密頁11第內(nèi)部資料.文檔存盤名稱4系統(tǒng)物理結(jié)構(gòu)定義系統(tǒng)總體物理結(jié)構(gòu)、包括組件劃分及依賴關(guān)系定義，每個組件中要完成的功能及組件間接口。如功能已經(jīng)在前面的子系統(tǒng)分解中有描述，則重點(diǎn)描述本組件完成了哪些子系統(tǒng)的哪些功能。組件是物理上的運(yùn)行結(jié)構(gòu)元素。例如：進(jìn)程、線程等。4.1總體結(jié)構(gòu)本節(jié)定義系統(tǒng)的總體物理結(jié)構(gòu)，定義組件劃分以及組件之間的關(guān)系。4.2組件定義組件一包括：組件名稱組件類型組件功能4.3組件接口設(shè)計(jì)定義接口設(shè)計(jì)的策略，組件間的接口主要是描述一些共享內(nèi)存，協(xié)議數(shù)據(jù)，消息等，具體接口如有

13、需要可另行定義文檔承載，采用接口設(shè)計(jì)說明書模板4.4組件與子系統(tǒng)對應(yīng)關(guān)系定義組件與子系統(tǒng)的關(guān)系，即各組件實(shí)現(xiàn)哪些子系統(tǒng)功能，可通過列表的形式定義，如有需要, 可通過圖示的形式加以說明。注意保密頁12第內(nèi)部資料.文檔存盤名稱5系統(tǒng)部署本章描述系統(tǒng)部署，說明用來部署并運(yùn)行該系統(tǒng)的一種或多種物理網(wǎng)絡(luò)（硬件）配置。 對于每 種配置，應(yīng)該指出執(zhí)行該系統(tǒng)的物理節(jié)點(diǎn)（計(jì)算機(jī)、網(wǎng)絡(luò)設(shè)備）配置情況（包括硬件、操作系統(tǒng)、 支撐軟件）、節(jié)點(diǎn)之間的連接方式、采用何種通信協(xié)議、網(wǎng)絡(luò)帶寬。另外還要包括各進(jìn)程到物理 節(jié)點(diǎn)的映射。5.1網(wǎng)絡(luò)結(jié)構(gòu)圖描述系統(tǒng)所處的整體網(wǎng)絡(luò)結(jié)構(gòu)。5.2部署模式描述系統(tǒng)幾種可能的部署模式，并解釋在定

14、義配置時要遵循的一般映射規(guī)則。例如：在不同的業(yè)務(wù)規(guī)模情況下，存在的不同部署模式。6關(guān)鍵技術(shù)及公用機(jī)制6.1關(guān)鍵技術(shù)設(shè)計(jì)描述系統(tǒng)的關(guān)鍵技術(shù)設(shè)計(jì)，以解決重要或高風(fēng)險(xiǎn)的問題 6.2公用機(jī)制說明描述系統(tǒng)實(shí)現(xiàn)所需要的公用機(jī)制，例如采用的中間件技術(shù)、通用緩存等7系統(tǒng)重用設(shè)計(jì)軟件重用是指通過對已有軟件的各種有關(guān)知識來建立新的軟件，這些知識包括：領(lǐng)域知識、開發(fā)經(jīng)驗(yàn)、設(shè)計(jì)經(jīng)驗(yàn)、設(shè)計(jì)決定、體系結(jié)構(gòu)、需求、設(shè)計(jì)、編碼、測試和文檔等。這個定義蘊(yùn)含著 軟件重用所必須包含的兩個方面：系統(tǒng)地開發(fā)可重用的軟件產(chǎn)品。1.系統(tǒng)地使用這些軟件產(chǎn)品作為構(gòu)筑新的軟件產(chǎn)品，來建立新的系統(tǒng)。2.軟件重用目的是降低軟件開發(fā)和維護(hù)的成本，提高

15、軟件開發(fā)效率，提高軟件的質(zhì)量。軟件重用的過程一般包括，抽象、選取、特化、集成：抽象，對已有軟件產(chǎn)品的概念描述，從中抽取該產(chǎn)品的本質(zhì)信息（即可重用部分）。注意保密頁13第內(nèi)部資料.文檔存盤名稱選?。河脩舾鶕?jù)已有軟件產(chǎn)品的抽象，尋找、比較和選擇最適合需要的軟件產(chǎn)品（可重用件）。特化：對已有軟件產(chǎn)品（可重用件）的修改或形成它的一個實(shí)例（實(shí)例化后的重用件）。集成：將實(shí)例化后的重用件集成到應(yīng)用系統(tǒng)。軟件重用的形式，常用的為垂直式重用和水平式重用：垂直式重用：指在一類具有較多公共性的應(yīng)用領(lǐng)域之間進(jìn)行軟件重用，由于存在許多共性或相似性，因此重用面較廣，且有助于獲得系統(tǒng)的通用模型。首先進(jìn)行領(lǐng)域分析，根據(jù)應(yīng)用領(lǐng)

16、域的特征及相似性預(yù)測軟件的可重用性；然后進(jìn)行相應(yīng)的軟件開發(fā)。一旦確認(rèn)了軟件的重用 價值，即可進(jìn)行通用化，以便能夠適應(yīng)新的類似的應(yīng)用領(lǐng)域；最后，對軟件及其文檔進(jìn)行管理， 成為可供后續(xù)項(xiàng)目使用的可重用資源。水平式重用：重用不同應(yīng)用領(lǐng)域中的軟件元素，例如數(shù)據(jù)結(jié)構(gòu)、分類算法、人機(jī)界面構(gòu)件等。標(biāo) 準(zhǔn)函數(shù)庫是一種典型的原始的水平式重用機(jī)制。軟件重用的粒度主要有以下幾種：源代碼模塊或者類一級的重用。這是最基本的軟件重用形式。1.二進(jìn)制形式的重用。如組件重用。2.組裝式重用。比如：把好幾個應(yīng)用程序的功能集成在一起。例如，要建立一個門3.戶站點(diǎn)應(yīng)用，登陸用戶既可以查詢天氣情況，又可以查看股市行情，還可以在線購物

17、。這些功能 由不同網(wǎng)絡(luò)應(yīng)用服務(wù)供應(yīng)商提供，通過這種組裝式重用，就可以非常容易地把上述功能都集成到 新的門戶站點(diǎn)中。分析級別重用。4.設(shè)計(jì)級別重用。5.軟件文檔重用。6.軟件重用技術(shù)軟件重用技術(shù)包括庫函數(shù)，模板，面向?qū)ο?、設(shè)計(jì)模式、構(gòu)件、體系架構(gòu)、體系架構(gòu)模：式風(fēng)格等。/庫函數(shù)1.對于庫函數(shù)的使用者，只要知道函數(shù)的名稱，返回值的類型函數(shù)參數(shù)和函數(shù)功能就可，以對其進(jìn)行調(diào)用。面向?qū)ο?.面向?qū)ο蠹夹g(shù)通過方法、消息、類、繼承、封裝、和實(shí)例等機(jī)制構(gòu)造軟件系統(tǒng)，并為軟件重用 提供強(qiáng)有力的支持。如中的。VC+MFC模板3.模板相當(dāng)于工業(yè)生產(chǎn)中所用的“模具”。有各種各樣的模板（如文檔模板，網(wǎng)頁模板等），注意保

18、密頁14第內(nèi)部資料.文檔存盤名稱利用這些模板可以比較快速地建立對應(yīng)的軟件產(chǎn)品。 模板把不變的封裝在內(nèi)部，對可能變化本號, 運(yùn)行環(huán)境，參數(shù)以及簡要描述7.1第三方硬件設(shè)備說明描述系統(tǒng)可使用的第三方硬件需求，以及第三方硬件的簡要描述。例如：需要加密卡提供高速邏輯加密功能；需要網(wǎng)絡(luò)交換機(jī)提供四層交換功能等。7.2第三方軟件說明描述系統(tǒng)可使用的第三方軟件需求，以及第三方軟件的簡要描述。8系統(tǒng)非功能特性設(shè)計(jì)本章描述系統(tǒng)的整體性能、安全性、可用性、可擴(kuò)展性、容錯等非功能特性設(shè)計(jì)。8.1可擴(kuò)展性描述系統(tǒng)可擴(kuò)展性設(shè)計(jì)與實(shí)現(xiàn)方案。需要對性能、功能、網(wǎng)管審計(jì)、報(bào)表的可擴(kuò)展性進(jìn)/行描述。 例如：考慮組件化設(shè)計(jì)，以使系統(tǒng)能夠適應(yīng)將來可能出現(xiàn)的新業(yè)務(wù)和可能出現(xiàn)的一些變化。新增業(yè)務(wù)功能時不應(yīng)需要改造原軟件系統(tǒng)，可通過動態(tài)加載新增組件的方式實(shí)現(xiàn)。描述系統(tǒng)性能設(shè)計(jì)與實(shí)現(xiàn)方案。例如：采用多種數(shù)據(jù)對象的緩存機(jī)制；采用并發(fā)處理機(jī)制；采用異步處理方式等。/8.2可維護(hù)性描述系統(tǒng)可維護(hù)性設(shè)計(jì)與實(shí)現(xiàn)方案。系統(tǒng)可維護(hù)性包括系統(tǒng)監(jiān)控與告警、系統(tǒng)配置、數(shù)據(jù)備份及清理。例如：考慮在線修改配置信息，而不中斷業(yè)務(wù)的設(shè)計(jì)機(jī)制。注意保密頁15第內(nèi)部資料.文檔存盤名稱8.3安全描述系統(tǒng)安全性設(shè)計(jì)與實(shí)現(xiàn)方案。系統(tǒng)安全性包括網(wǎng)絡(luò)安全、系統(tǒng)安全、數(shù)據(jù)安全、交易安全等。例如：地址鑒權(quán)；各類數(shù)據(jù)加密機(jī)制；各類通訊加密機(jī)制；身