軟件項目名稱架構(gòu)設(shè)計書

1 軟件項目名稱架構(gòu)設(shè)計書 說明： 1. 本文件中“ ”中內(nèi)容為舉例和說明文字，請在文件擬制時替換或刪除； 2. 若文中某章節(jié)內(nèi)容可省略、不需要或適用，請保留該標題，并根據(jù)實際在內(nèi)容部分寫明“略”、“勿需”或“不適用”等，同時適當說明原因 錯誤 !未指定書簽。 當前版本 密級 機密 文檔編號 總頁數(shù) 正文頁數(shù) 附錄頁數(shù) 編制人 評審人 批準人 編制日期 評審日期 批準日期 模板文檔編號 1 頁，共 15 頁 修改履歷 序號 狀態(tài) 版本 修改內(nèi)容 修改位置 修改人 日期 評審人 日期 批準人 日期 1 C 建 全文 文藝 2010/11/8 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 狀態(tài)： C 創(chuàng)建文檔， A 增加內(nèi)容， M 修改內(nèi)容， D 刪除內(nèi)容 2 頁，共 15 頁 目 錄 1. 文檔概述 . 4 目標 . 4 范圍 . 4 術(shù)語和縮略語 . 4 2. 整體說明 . 4 方案 . 4 架構(gòu)約束 . 5 整體概要 . 5 統(tǒng)上下文 . 5 體架構(gòu) . 6 3. 應(yīng)用層 . 6 設(shè)計思路 . 6 結(jié)構(gòu)視圖 . 6 構(gòu)框架 . 6 部服務(wù) . 6 配置視圖 . 6 置視圖 . 7 置描述 . 7 行為視圖 . 7 鍵問題的技術(shù)解決方案 . 7 署視圖 . 7 心架構(gòu)模式及設(shè)計模式 . 8 型用例流程 . 8 進程視圖 . 8 升級注意事項 . 8 集成方案 . 8 4. 虛擬平臺層 . 8 5. 應(yīng)用基礎(chǔ)層 . 8 固化在平臺中的機制 . 9 自定義機制 . 9 軟件要求 . 9 6. 企業(yè)服務(wù)層 . . 9 配置視圖 . 9 升級注意事項 . 9 7. 計算 &存儲層 . 9 升級注意事項 . 11 8. 網(wǎng)絡(luò)基礎(chǔ)層 . 11 配置視圖 . 11 9. 設(shè) 備 . 11 3 頁，共 15 頁 10. 服務(wù)級別需求 . 11 列舉服務(wù)級別需求 . 11 能、吞吐量和可伸縮性 . 12 用性和可靠性 . 12 全性 . 12 管理性 . 12 用性 . 12 維護性 . 12 展性和靈活性 . 13 重用性 . 13 11. 容災(zāi)設(shè)計 . 13 容災(zāi)目標值 . 13 容災(zāi)環(huán)境 . 13 關(guān)聯(lián)系統(tǒng)容災(zāi)要求 . 14 其他補充說明 . 14 12. 風(fēng)險 . 14 技術(shù)風(fēng)險列表 . 14 風(fēng)險識別 . 14 4 頁，共 15 頁 1. 文檔概述 建立上下文，提出所有讀者在下面章節(jié)期望看到的內(nèi)容。 目標 請說明此系統(tǒng)完成后，達到什么架構(gòu)目標，產(chǎn)生什么架構(gòu)意義?；蛘邔e的系統(tǒng)架構(gòu)可以提供什么借簽 . 例如，構(gòu)建 2用的開發(fā)框架，使所有系統(tǒng)能規(guī) 范開發(fā)組件，提高開發(fā)效率，易于統(tǒng)一升級和維護 范圍 列出本系統(tǒng)支持的業(yè)務(wù)范圍，包括時間使用年限，業(yè)務(wù)需求范圍，包括已確定支持的業(yè)務(wù)需求和未明確確定的業(yè)務(wù)需求。如果有未明確的業(yè)務(wù)需求，需要說明如果需求變更的話，采取什么措施 列出所有和當前架構(gòu)有關(guān)的參考文檔，包括每一個確定的標題、版本、日期以及發(fā)布組織。詳細說明資料的出處，也可以通過一個附件或另一個文檔提供。需求分析可參看需求分析文檔 術(shù)語和縮略語 定義本文檔中所有的術(shù)語和縮略語。 序號 術(shù)語 /縮略詞 說明 1 2 3 4 5 表 錯誤 !文檔中沒有指定樣式的文字。 1 術(shù)語表 2. 整體說明 方案 概述架構(gòu)設(shè)計的方法，包括簡要的方法論描述。定義系統(tǒng)中不同的視圖，然后敘述本系統(tǒng)架構(gòu)說明書中使用到的那些視圖。 的架構(gòu)方案是基于 架構(gòu)方法論，由可伸縮性、安全性、可維護性等服務(wù)級別需求所驅(qū)動。依次分析邏輯層 技術(shù)層 下圖的圖示： 5 頁，共 15 頁 圖 1 架構(gòu)框架 系統(tǒng)描述是通過一組架 構(gòu)視圖來組織的，每一個視圖都是從不同觀點描繪系統(tǒng)特征的一個方面。系統(tǒng)層由大量的視圖組織起來。 以每個或組服務(wù)級別需求作為一個次標題，加入架構(gòu)設(shè)計中如何達到其需求的描述，需要的話引用其它視圖；最后用一個總的服務(wù)級別需求視圖把這些內(nèi)容串聯(lián)起來。 視圖對讀者是很有幫助的。不同的讀者在特定的時間可能只對部分的視圖感興趣。 以下章節(jié)描述架構(gòu)建立目標和約束，以及高層次系統(tǒng)整體概要。本節(jié)也描述后續(xù)章節(jié)從不同側(cè)面檢驗系統(tǒng)架構(gòu)的上下文環(huán)境。 架構(gòu)約束 本節(jié)需描述四方面的內(nèi)容。 1）本系統(tǒng)最受關(guān)注的前幾個服務(wù)級別需求對架構(gòu) 的要求。（詳細的服務(wù)級別需求可以在服務(wù)級別需求部分表述） 2）是否是基于外購系統(tǒng)。（全部基于或部分基于外購系統(tǒng)或全部自主研發(fā)） 3）本系統(tǒng)的架構(gòu)適用范圍。（只適用本系統(tǒng)還是可以適用于其余系統(tǒng)或者部分可適用于其余系統(tǒng)。如果是部分可適用于其余系統(tǒng)，則需要描述架構(gòu)模式） 4）本系統(tǒng)的技術(shù)約束（需依賴的技術(shù)），對團隊成員的約束（如成員需要掌握的技能），軟硬件約束等。 整體概要 提供一個架構(gòu)的整體性說明。因為在后續(xù)的章節(jié)中，都是按層（ 組織該層（ 視圖，本概述章節(jié)就更適合把所有層（ 作為一個整體來考慮，而不是分層（ 描述。通常，劃分層 (很有用的，突出（加亮）每級的關(guān)鍵點，這些關(guān)鍵點包括主要的外部實體（如終止用戶訪問的節(jié)點和遺留系統(tǒng)）。主要的架構(gòu)特征列表，如：獨立供應(yīng)商、一致的行業(yè)標準、產(chǎn)物的構(gòu)思等。同一類架構(gòu)特征應(yīng)該放進整體說明中描述。 統(tǒng)上下文 描述本系統(tǒng)與參與者（內(nèi)部、外部）的關(guān)聯(lián)關(guān)系 6 頁，共 15 頁 體架構(gòu) 描述系統(tǒng)整體架構(gòu) 3. 應(yīng)用層 本節(jié)在均衡考慮架構(gòu)統(tǒng)一原則的基礎(chǔ)上 ,通過分解對應(yīng)用層的功能進行討論。從概要地描述應(yīng)用層各獨立視圖開始， 例如：分別對比靜態(tài)和動態(tài)的結(jié)構(gòu)視圖，分別對比靜態(tài)和動態(tài)的配置視圖。 設(shè)計思路 整體描述應(yīng)用層整體的設(shè)計思路 ,例如使用 構(gòu)作為基礎(chǔ)框架代碼 ;存在 其原因等 . 結(jié)構(gòu)視圖 當需要進行開發(fā)時，描述架構(gòu)上重要的包和它們之間編譯時的靜態(tài)依賴關(guān)系。選擇的分解應(yīng)該詳細闡述每條定義明確的分解規(guī)則，例如：分層、分類、概括等。一旦包括各等級的小節(jié)，就可以用一個等級分層的概要圖表作為開始，然后用更加詳細的圖表描述架構(gòu)上比較重要的部分。所有的圖表中對每個包的描述，應(yīng)該包括它們的職責和 資源（自定義的、可重用的、成本等）的描述。 本小節(jié)可以放到本節(jié)開頭部分，但是要先于各小節(jié)提出。無論是放在此處還是其他地方，推薦保留次級標題，即使內(nèi)容是空的，也要作為詳盡闡述的占位符。 構(gòu)框架 描述 統(tǒng)的所有代碼框架結(jié)構(gòu) 部服務(wù) 描述調(diào)用的外部接口或?qū)ν馓峁┑耐獠拷涌?用關(guān)聯(lián)系統(tǒng)的服務(wù) 描述使用關(guān)聯(lián)系統(tǒng)的服務(wù) 關(guān)聯(lián)系統(tǒng)提供的服務(wù) 描述為關(guān)聯(lián)提供提供的服務(wù) ,可以參見接口文檔的服務(wù) 配置視圖 逐條描述各應(yīng)用模塊的配置 ，包括這些模塊的物理位置、運行時的交互。為此，可以使用模塊結(jié)構(gòu)圖覆蓋展開圖。為不同的配置提供適合的多樣的圖表，可能需要產(chǎn)品的例子、或配置于不同環(huán)境中的產(chǎn)品的例子、決定支持配置與交易配置不同之處的例子。當描述各種配置時，應(yīng)當定義為每項配置所選的配置策略。 注明底層的詳細信息將在稍后的獨立配置視圖中獲取，所以最好在此贅述一下相關(guān)的視圖信息。 7 頁，共 15 頁 置視圖 置描述 如果有需要，可以在視圖后加入對配置的描述 行為視圖 當某些架構(gòu)設(shè)計對子系統(tǒng)的功能有影響，而不是影響子系統(tǒng)的劃分 時，本節(jié)描述對子系統(tǒng)的功能有影響的架構(gòu)設(shè)計；這些設(shè)計不會影響子系統(tǒng)的劃分。以下小節(jié)可以使用，也可以適當?shù)膭h減。 本節(jié)是下面小節(jié)的代表。推薦保留次級標題，即使內(nèi)容是空的，也要作為詳盡闡述的占位符。 鍵問題的技術(shù)解決方案 描述架構(gòu)上在各層的關(guān)鍵決定和架構(gòu)設(shè)計方案在系統(tǒng)各層的考慮，以及架構(gòu)重要用例涉及的技術(shù)解決方案 ,也包括可重用組件設(shè)計方案。下面是一個簡單的格式例子。 決方案的分層描述 下表通過分層概述通用的設(shè)計方法，每行對應(yīng)一個架構(gòu)上的決定和在各層的解決方案。 關(guān)鍵問題 /組件 表示層 業(yè)務(wù)層 資源層 示 集合處理 查詢 導(dǎo)航 完整性管理 事務(wù)控制 表 1 關(guān)鍵問題技術(shù)解決方案 決方案詳述 如果有需要，可以詳細描述關(guān)鍵問題的解決方案和思路。對于可重用組件，需要描述詳細解決方案。 署視圖 署邏輯圖 署注意 事項 8 頁，共 15 頁 心架構(gòu)模式及設(shè)計模式 心架構(gòu)模式 描述系統(tǒng)特有的架構(gòu)模式，例如使用 構(gòu)等 心架構(gòu)模式中使用到的設(shè)計模式 描述架構(gòu)模式中使用到的設(shè)計模式 型用例流程 描述所有保留的典型的或比較有價值的系統(tǒng)里動態(tài)（基于時間）相互作用的例子的詳細設(shè)計。 典型用例的目的是讓設(shè)計人員可以參考典型用例來對其他用例進行詳細設(shè)計。例如抽取報表模塊中的一個典型的用例進行詳細設(shè)計，其他報表詳細設(shè)計可以參考此用例。 架構(gòu)重要用例必須在典型用例流程中有詳細描述 . 進程視圖 說明貫穿系統(tǒng)的交互流程同步和異步的方式，焦點是影響質(zhì)量上的（如：吞吐量、可靠性、實用性等）宏命令。 本節(jié)是小節(jié)中的典型。推薦保留次級標題，即使內(nèi)容是空的，也要作為詳盡闡述的占位符。 升級注意事項 描述系統(tǒng)升級時應(yīng)用層的架構(gòu)應(yīng)該隨之做出的改進。例如，可能預(yù)先增加一項參數(shù)或增加對另一個系統(tǒng)的接口，將功能性從中分離出來。 集成方案 描述系統(tǒng)內(nèi)部和外部需要集成的組件；集成的順序；集成的工具等 4. 虛擬平臺層 如果存在為獨立供應(yīng)商訪問應(yīng)用基礎(chǔ)架構(gòu)層而提供的標準層，應(yīng)當描述標準層。最好的例子使 也可以包括其他的標準，如基于 標準。（需要說明的是，應(yīng)用程序可能以任何格式提供服務(wù)器，但是這些應(yīng)該放在應(yīng)用層里進行描述，本節(jié)的焦點僅僅是應(yīng)用程序使用什么到達下一層。） 選 2 的服務(wù)器平臺。 開發(fā)多級企業(yè)應(yīng)用軟件的工業(yè)標準平臺。它提供一個位于中間層機制的頂端的虛擬平臺，解開很多機制的限制 ，同時簡化和加快了整個開發(fā)過程。同時提供了對現(xiàn)有應(yīng)用程序集成最強有力的支持，最大化將來變更的選擇權(quán)。 5. 應(yīng)用基礎(chǔ)層 本章描述前面所述各層的基礎(chǔ)層，但要注意是從前面沒提到過的角度來描述。例如，供應(yīng)商提供的產(chǎn)品架構(gòu)上的描述，可能更有價值。 固化在平臺中的機制 描述系統(tǒng)要求的各種機制。包括一個關(guān)于機制的列表 9 頁，共 15 頁 用程序中。對運行的機制、訪問和管理應(yīng)用程序接口的機制，如下的列表可以作為一個大致的輪廓。 容器 平臺 接口 (管理接口(機制(客戶端 表示層 業(yè)務(wù)層 集成層 資源層 圖 5舉所有機制 自定義機制 如果有任何自定義的機制上一節(jié)中沒有說到，就在本節(jié)描述。為此，可以使用靜態(tài)和動態(tài)的 描述各種機制，同時可以包含必要的改進注意事項。 軟件要求 描述部署邏輯實體的軟件版本信息 部署邏輯實體 軟件版本信息 6. 企業(yè)服務(wù)層 . 描述支持與本系統(tǒng)相關(guān)的或依賴的服務(wù)器環(huán)境。 配置視圖 描述在應(yīng)用層下，直接或間接支持應(yīng)用層的配置。包括應(yīng)用層整合 不太明顯的一些細節(jié)，如： 用配置圖，隨意地描繪一下架構(gòu)上的重要過程或行為視圖中的主線。 升級注意事項 描述架構(gòu)預(yù)期到的改進 ,如何配合計算 &存儲層預(yù)的架構(gòu)升級做調(diào)整。 7. 計算 &存儲層 列舉計算設(shè)備和封裝格式存儲器等硬件 /系統(tǒng)級的組件 注意事項： 1. 評估指南參考基礎(chǔ)架構(gòu)資源需求評估單 A,礎(chǔ)架構(gòu)討論再確定。 4. 除明確說明外 , 生產(chǎn)對應(yīng)的災(zāi)備資源會由公式計算獲得 . 詳細的公式參考 基礎(chǔ)架構(gòu)資源需求評估單 5. 非平安標準的 軟件版本需要特別說明，參考平臺軟件版本清單表 下表為系統(tǒng)運行的硬件 /軟件組件 : 10 頁，共 15 頁 資源名稱 適用范圍 評估點 評估結(jié)果 評估依據(jù) 高端生產(chǎn) 001 普通 用的1)業(yè)務(wù)數(shù)據(jù)量 (2)索引數(shù)據(jù)量 ( 生產(chǎn)： 高端生產(chǎn) 002 性能要求較高的 磁盤組的整體 I/3 1)業(yè)務(wù)數(shù)據(jù)量 (2)索引數(shù)據(jù)量 ( 生產(chǎn)： 中端 001 普通文件的存放，非關(guān)鍵系統(tǒng) 1) 需 要 評 估 生 產(chǎn) 和個環(huán)境 2)業(yè)務(wù)所需的存儲空間數(shù)量 ( 生產(chǎn)： 業(yè)務(wù)所需的存儲空間數(shù)量( 中端 002 對性能和可用性要求較高的應(yīng)用，如 B、) 需 要 評 估 生 產(chǎn) 和個環(huán)境 2)業(yè)務(wù)所需的存儲空間數(shù)量 (生產(chǎn)： 001 歸檔應(yīng)用，如郵件歸檔、影像歸檔、日志歸檔、備份歸檔等應(yīng)用，配置 性能和可用性要求較低 1) 需 要 評 估 生 產(chǎn) 和個環(huán)境 2)業(yè)務(wù)所需的存儲空間數(shù)量 (生產(chǎn)： 002 通用的 保存、 置光纖盤柜 1) 需 要 評 估 生 產(chǎn) 和個環(huán)境 2)業(yè) 務(wù)所需的存儲空間數(shù)量 (生產(chǎn)： 生產(chǎn) 1)網(wǎng)絡(luò)分區(qū) 2)需要的 3)非平安標準的 生產(chǎn)： 非 所使用的應(yīng)用軟件需要運行在 1)網(wǎng)絡(luò)分區(qū) 2)依據(jù)廠商針對平安的業(yè)務(wù)規(guī)模提供的硬件配置要求，和資源負責人討論后決定 3)非平安標準的 4)需要評估生產(chǎn) ,災(zāi)備和個環(huán)境 生產(chǎn)： 災(zāi)備 : 1、應(yīng)用以 22、服務(wù)器不進行大量消耗I/統(tǒng)主要資源需求為內(nèi)存（ 1)網(wǎng)絡(luò)分區(qū) 2)3)4)非平安標準的 生產(chǎn)： 非 1、應(yīng)用架構(gòu)中有外購軟件需要部署在 、應(yīng)用架構(gòu)自行開發(fā)部分有非標準架構(gòu)、或不符合 1)網(wǎng)絡(luò) 分區(qū) 2)需要的 3)非平安標準的 1 1個 應(yīng)用要求的 包含系統(tǒng)盤空間 生產(chǎn)： 升級注意事項 預(yù)期的改進明細表，例如：所選模塊的擴展性或升級能力，或者系統(tǒng)在某些地方的設(shè)計更易于添部分加可復(fù)制的節(jié)點等等。 11 頁，共 15 頁 8. 網(wǎng)絡(luò)基礎(chǔ)層 配置視圖 描述物理上的配置，包括運算和存儲資源，以及它們之間相互連接的網(wǎng)絡(luò)。細分應(yīng)包括路由器、防火墻、子網(wǎng)、主要的 /次級的服務(wù)器等等。本視圖應(yīng)該補充應(yīng)用層 /配置視圖，以確保各組件在本視圖中描繪得更加詳 細。例如：用框圖代替視圖中的抽象概念。 9. 設(shè)備 論述設(shè)備要求，如：空間維度、馬力、熱量等環(huán)境要求，以及進入場地的安全要求（如身份技術(shù)鑒定）等。 10. 服務(wù)級別需求 本節(jié)包含所有和服務(wù)級別需求相關(guān)的因素，可以增加副標題分別列舉各項。本節(jié)以下是選取格式的一個提綱。 列舉服務(wù)級別需求 詳細闡述各項重要的服務(wù)級別需求參數(shù)（像需求規(guī)格說明書中標識一樣）?？梢允褂昧Ⅲw視圖，附加一些文字描述。以下是各個服務(wù)級別需求參數(shù)都應(yīng)當提到的幾項。 直接需求和衍生需求。直接需求就是在需求規(guī)格說明書中列出的那些需求，在此只是對 這些信息必要的重復(fù)。衍生需求雖然沒有在需求規(guī)格說明書中列出，但卻是滿足直接需求的技術(shù)上的必要條件。例如，架構(gòu)里使用一個遺留組件時，一個直接的吞吐量需求可能隱藏著一個衍生的吞吐量需求。 使用的策略。架構(gòu)怎樣提出這些系統(tǒng)性能？參考其他視圖，并避免對已提出的性能進行考證所產(chǎn)生的冗余。 將來的變更。確定為了支持版本預(yù)期的升級而在架構(gòu)里合并的內(nèi)容。例如，可伸縮性對吞吐量。 12 頁，共 15 頁 能、吞吐量和可伸縮性 求 構(gòu)解決方案 進注意事項 用 性和可靠性 求 構(gòu)解決方案 進注意事項 全性 求 構(gòu)解決方案 進注意事項 管理性 求 構(gòu)解決方案 進注意事項 用性 求 構(gòu)解決方案 進注意事項 維護性 求 構(gòu)解決方案 進注意事項 13 頁，共 15 頁 展性和靈活性 求 構(gòu)解決方案 進注意事項 重用性 求 構(gòu)解決方案 進注意事項 11. 容災(zāi)設(shè)計 本節(jié)描述本系統(tǒng)的容災(zāi)目標和容災(zāi)方案，容災(zāi)方案需列出支持本系統(tǒng)容災(zāi)的各支持環(huán)節(jié)的容災(zāi)要求，各環(huán)節(jié)容災(zāi)方案默認為 臺容災(zāi)方案，不同于平臺方案的地方要做說明。 容災(zāi)目標值 容災(zāi)環(huán)境 描述本系統(tǒng)依賴的環(huán)境容災(zāi)方案要求，如果同 臺容災(zāi)方案要求一樣可以填寫同標準，需說明本系統(tǒng)不同于 臺容災(zāi)方