軟件架構(gòu)設(shè)計(jì)文檔模板說(shuō)課材料

1、項(xiàng)目名稱(chēng)軟件架構(gòu)設(shè)計(jì)文檔版本項(xiàng)目名稱(chēng)版本：軟件架構(gòu)設(shè)計(jì)文檔日期：修訂歷史記錄日期版本說(shuō)明作者日/月/年詳細(xì)信息姓名目錄目錄簡(jiǎn)介目的范圍定義、首字母縮寫(xiě)詞和縮略語(yǔ)參考資料概述整體說(shuō)明簡(jiǎn)介構(gòu)架表示方式構(gòu)架目標(biāo)和約束用例視圖核心用例用例實(shí)現(xiàn)邏輯視圖邏輯視圖分層應(yīng)用層業(yè)務(wù)層中間層系統(tǒng)層4.3架構(gòu)模式設(shè)計(jì)機(jī)制公用元素及服務(wù)進(jìn)程視圖部署視圖實(shí)施視圖概述層部署數(shù)據(jù)視圖5555555555666666677777777888888大小和性能10.質(zhì)量811.其它說(shuō)明812.附錄A指南813.附錄B規(guī)范914.附錄C模版915.附錄D示例9軟件架構(gòu)設(shè)計(jì)文檔簡(jiǎn)介軟件構(gòu)架文檔的簡(jiǎn)介應(yīng)提供整個(gè)軟件構(gòu)架文檔的概述。它應(yīng)

2、包括此軟件構(gòu)架文檔的目的、范圍、定義、首字母縮寫(xiě)詞、縮略語(yǔ)、參考資料和概述目的本文檔將從構(gòu)架方面對(duì)系統(tǒng)進(jìn)行綜合概述，其中會(huì)使用多種不同的構(gòu)架視圖來(lái)描述系統(tǒng)的各個(gè)方面。它用于記錄并表述已對(duì)系統(tǒng)的構(gòu)架方面作出的重要決策本節(jié)確定此軟件構(gòu)架文檔在整個(gè)項(xiàng)目文檔中的作用或目的，并對(duì)此文檔的結(jié)構(gòu)進(jìn)行簡(jiǎn)要說(shuō)明。應(yīng)確定此文檔的特定讀者，并指出他們應(yīng)該如何使用此文檔范圍簡(jiǎn)要說(shuō)明此軟件構(gòu)架文檔適用的范圍和影響的范圍定義、首字母縮寫(xiě)詞和縮略語(yǔ)本小節(jié)應(yīng)提供正確理解此軟件構(gòu)架文檔所需的全部術(shù)語(yǔ)的定義、首字母縮寫(xiě)詞和縮略語(yǔ)。這些信息可以通過(guò)引用項(xiàng)目詞匯表來(lái)提供參考資料本小節(jié)應(yīng)完整地列出此軟件構(gòu)架文檔中其他部分所引用的所有文

3、檔。每個(gè)文檔應(yīng)標(biāo)有標(biāo)題、報(bào)告號(hào)（如果適用）、日期和出版單位。列出可從中獲取這些參考資料的來(lái)源。這些信息可以通過(guò)引用附錄或其他文檔來(lái)提供概述本小節(jié)應(yīng)說(shuō)明此軟件構(gòu)架文檔中其他部分所包含的內(nèi)容，并解釋此軟件構(gòu)架文檔的組織方式整體說(shuō)明簡(jiǎn)介在此簡(jiǎn)單介紹軟件架構(gòu)的整體情況，包括用例視圖、邏輯視圖、進(jìn)程視圖、實(shí)施視圖和部署視圖的簡(jiǎn)單介紹。另外，簡(jiǎn)要介紹各種視圖的作用和針對(duì)的用戶(hù)構(gòu)架表示方式本節(jié)說(shuō)明當(dāng)前系統(tǒng)所使用的軟件構(gòu)架及其表示方式。還會(huì)從用例視圖、邏輯視圖、進(jìn)程視圖、部署視圖和實(shí)施視圖中列出必需的那些視圖，并分別說(shuō)明這些視圖包含哪些類(lèi)型的模型元素構(gòu)架目標(biāo)和約束本節(jié)說(shuō)明對(duì)構(gòu)架具有某種重要影響的軟件需求和目標(biāo)

4、，例如：安全性、保密性、市售產(chǎn)品的使用、可移植性、分銷(xiāo)和重復(fù)使用。還應(yīng)記錄可能適用的特殊約束：設(shè)計(jì)與實(shí)施策略、開(kāi)發(fā)工具、團(tuán)隊(duì)結(jié)構(gòu)、時(shí)間表、遺留代碼等用例視圖本節(jié)列出用例模型中的一些用例或場(chǎng)景，這些用例或場(chǎng)景應(yīng)體現(xiàn)最終系統(tǒng)中重要的、核心的功能；或是在構(gòu)架方面涉及范圍很廣（使用了許多構(gòu)架元素）；或強(qiáng)調(diào)或闡明了構(gòu)架的某一具體的細(xì)微之處在此可以直接引用需求中的相關(guān)文檔，比如ROSE莫型；用例描述等對(duì)于本系統(tǒng)和其它系統(tǒng)的關(guān)系，在用例圖上可以清楚的看到，因?yàn)槠渌到y(tǒng)在用例圖上被表示為主角根據(jù)項(xiàng)目的實(shí)際情況，此節(jié)可以省略不寫(xiě)核心用例在此引用ROSE模型中的用例圖即可用例實(shí)現(xiàn)本節(jié)通過(guò)幾個(gè)精選的用例（場(chǎng)景）實(shí)現(xiàn)

5、來(lái)闡述軟件的實(shí)際工作方式，并解釋不同的設(shè)計(jì)模型元素如何促成其功能的實(shí)現(xiàn)邏輯視圖邏輯視圖在此用圖形的方式顯示此軟件架構(gòu)的分層、子系統(tǒng)、包之間的關(guān)系，并且加入必要的文字說(shuō)明，特別是架構(gòu)的分層、機(jī)制和模式的說(shuō)明在此，還需要將和本系統(tǒng)有接口關(guān)系的其它系統(tǒng)都表示出來(lái)，這樣可以清楚的看到本系統(tǒng)和其它系統(tǒng)的接口邏輯視圖，并且還需要將在本系統(tǒng)中負(fù)責(zé)接口的子系統(tǒng)表示出來(lái)分層在此說(shuō)明邏輯分層的每一層和每一層中的包、子系統(tǒng)。對(duì)于每個(gè)重要的包，都用一個(gè)小節(jié)來(lái)加以說(shuō)明，其中應(yīng)包括該包的名稱(chēng)、簡(jiǎn)要說(shuō)明以及顯示該包中所有重要的類(lèi)和包的圖。對(duì)于該包中的每個(gè)重要類(lèi)，應(yīng)包括其名稱(chēng)、簡(jiǎn)要說(shuō)明，還可選擇包括對(duì)其部分主要職責(zé)、操作和屬

6、性的說(shuō)明下面預(yù)先設(shè)置應(yīng)用層、業(yè)務(wù)層、中間層和系統(tǒng)層，實(shí)際使用中可以根據(jù)需要進(jìn)行修改應(yīng)用層在此說(shuō)明軟件架構(gòu)子系統(tǒng)的高層組織，是系統(tǒng)面向外部（主角）、面向功能（用例）的子系統(tǒng)。在這一層中的子系統(tǒng)，要根據(jù)中間層的約定繼續(xù)分區(qū)（tier）業(yè)務(wù)層在此說(shuō)明軟件架構(gòu)子系統(tǒng)的高層組織，是應(yīng)用層子系統(tǒng)公用的、為應(yīng)用層子系統(tǒng)提供服務(wù)的、和業(yè)務(wù)相關(guān)的子系統(tǒng)。在這一層中的子系統(tǒng)，要根據(jù)中間層的約定繼續(xù)分區(qū)中間層在此說(shuō)明軟件架構(gòu)子系統(tǒng)的底層組織，是面向系統(tǒng)內(nèi)部（技術(shù)）、面向非功能（補(bǔ)充規(guī)約）的子系統(tǒng)（框架、包、機(jī)制、模式）。在這一層的子系統(tǒng)，通常包括分區(qū)、支持分區(qū)的框架、架構(gòu)模式、設(shè)計(jì)機(jī)制（事務(wù)、存儲(chǔ)等）、公用元素及服

7、務(wù)（郵件、翻頁(yè)、列表控件、樹(shù)控件、按鈕控件等）等系統(tǒng)層在此說(shuō)明軟件架構(gòu)的操作系統(tǒng)、運(yùn)行平臺(tái)（應(yīng)用服務(wù)器、數(shù)據(jù)庫(kù)等）、開(kāi)發(fā)語(yǔ)言、第三方技術(shù)（比如GIS、CORB、AJ2EE、COM、.net）等架構(gòu)模式在此說(shuō)明軟件架構(gòu)采用的核心模式，此模式形成整個(gè)軟件架構(gòu)的骨架，在此以一次交互為主來(lái)表達(dá)設(shè)計(jì)機(jī)制在此說(shuō)明軟件架構(gòu)各相關(guān)設(shè)計(jì)機(jī)制的處理方案，包括2個(gè)部分，一是全局的設(shè)計(jì)機(jī)制，包括事務(wù)的處理、持續(xù)性的處理等；二是特殊、局部的設(shè)計(jì)機(jī)制，包括權(quán)限管理、OID生成、連接池，JSP2SB等，初始化操作、功能表等公用元素及服務(wù)在此說(shuō)明軟件架構(gòu)通用的設(shè)計(jì)元素及提供的和相關(guān)服務(wù)進(jìn)程視圖本節(jié)說(shuō)明將系統(tǒng)分解為輕量級(jí)進(jìn)程（

8、單個(gè)控制線(xiàn)程）和重量級(jí)進(jìn)程（成組的輕量級(jí)進(jìn)程）的情況。本節(jié)的內(nèi)容按照各個(gè)通信或交互的進(jìn)程組來(lái)進(jìn)行組織。說(shuō)明進(jìn)程之間的主要通信模式，例如消息傳遞、中斷和會(huì)合根據(jù)項(xiàng)目的實(shí)際情況，此節(jié)可以省略不寫(xiě)部署視圖本節(jié)說(shuō)明用來(lái)部署和運(yùn)行該軟件的一種或多種物理網(wǎng)絡(luò)（硬件）配置。對(duì)于每種配置，它至少應(yīng)該指出執(zhí)行該軟件的物理節(jié)點(diǎn)（計(jì)算機(jī)、CPU及其互連情況（總線(xiàn)連接、LAN連接、點(diǎn)到點(diǎn)連接等）在此還需要包括在安裝部署時(shí)要注意的特殊問(wèn)題，可能還有和安裝部署有關(guān)的設(shè)計(jì)內(nèi)容在此還需要表示本系統(tǒng)和其它系統(tǒng)的在部署上的關(guān)系，比如本系統(tǒng)部署的物理節(jié)點(diǎn)和其它系統(tǒng)部署的物理節(jié)點(diǎn)之間的連接等實(shí)施視圖本節(jié)說(shuō)明實(shí)施模型的整體結(jié)構(gòu)、軟件分

9、解為實(shí)施模型中的層和子系統(tǒng)的情況，以及所有在構(gòu)架方面具有重要意義的構(gòu)件概述本小節(jié)指定并定義各個(gè)層及其內(nèi)容、添加到指定層時(shí)要遵循的規(guī)則以及各層之間的邊界。還應(yīng)包括一個(gè)顯示層間關(guān)系的構(gòu)件圖如果使用JAVA做為實(shí)施語(yǔ)言，要求明確指定各層各子系統(tǒng)的包前綴層對(duì)于每個(gè)層，都用一個(gè)小節(jié)來(lái)加以說(shuō)明，其中包括該層的名稱(chēng)和一個(gè)構(gòu)件圖，并列舉位于該層的子系統(tǒng)如果使用JAVA做為實(shí)施語(yǔ)言，要求明確指定各子系統(tǒng)內(nèi)分區(qū)的包前綴部署在此說(shuō)明各個(gè)部署單元、每個(gè)部署單元的實(shí)施元素。在J2EE中，即表示要將應(yīng)用打成多少個(gè)包，每個(gè)包的名稱(chēng)以及每個(gè)包包含的源文件數(shù)據(jù)視圖從永久性數(shù)據(jù)存儲(chǔ)方面來(lái)對(duì)系統(tǒng)進(jìn)行說(shuō)明。如果幾乎或根本沒(méi)有永久性數(shù)據(jù)，或者設(shè)計(jì)模型與數(shù)據(jù)模型之間的轉(zhuǎn)換并不重要，那么本節(jié)就為可選根據(jù)項(xiàng)目的實(shí)際情況，此節(jié)可以省略不寫(xiě)大小和性能說(shuō)明軟件中會(huì)對(duì)構(gòu)架產(chǎn)生影響的主要尺寸特征，以及目標(biāo)性能約束質(zhì)量說(shuō)明軟件構(gòu)架如何促成諸如可擴(kuò)展性、可靠性、可移植性等所有系統(tǒng)能力（而非功能）的實(shí)現(xiàn)。如果這些特征具有特殊的意義（例如在安全性或保密性方面的意義），則應(yīng)該對(duì)它們進(jìn)行詳細(xì)的說(shuō)明其它說(shuō)明在此說(shuō)明其它需要說(shuō)明的內(nèi)容附錄A指南在此包括設(shè)計(jì)指南、編程指南、部署和安裝指南，其中在編程指南上不僅包括傳統(tǒng)的諸如JAVA編程指南，還包括指導(dǎo)實(shí)現(xiàn)人員