《軟件架構設計文檔》模板_第1頁
《軟件架構設計文檔》模板_第2頁
《軟件架構設計文檔》模板_第3頁
《軟件架構設計文檔》模板_第4頁
《軟件架構設計文檔》模板_第5頁
已閱讀5頁,還剩12頁未讀 繼續免費閱讀

下載本文檔

版權說明:本文檔由用戶提供并上傳,收益歸屬內容提供方,若內容存在侵權,請進行舉報或認領

文檔簡介

1、目 錄1.文檔簡介41.1文檔目的41.2文檔范圍41.3定義、縮寫詞和縮略語41.4參考資料42.架構描述方式42.1架構視圖閱讀指南42.2圖表與模型閱讀指南53.架構設計目標53.1關鍵功能53.2關鍵質量屬性53.3業務需求和約束因素64.架構設計原則64.1架構設計原則64.2備選架構設計方案及被否原因64.3架構設計對后續工作的限制(詳設,部署等)65.邏輯架構視圖75.1職責劃分與職責確定75.2接口設計與協作機制85.3重要設計包106.開發架構視圖116.1Project劃分116.2Project 111Project目錄結構指導12程序單元組織12框架與應用之間的關系(可

2、選)126.3Project 2136.4Project n137.運行架構視圖137.1控制流組織137.2控制流的創建、銷毀、通信147.3加鎖設計148.物理架構視圖148.1物理拓撲148.2軟件到硬件的映射158.3優化部署169.數據架構視圖169.1持久化機制的選擇179.2持久化存儲方案179.3數據同步與復制策略1710.關鍵質量屬性的設計原理17 1. 文檔簡介幫助讀者對本文檔建立基本印象,并為閱讀后續內容掃清障礙。1.1 文檔目的文檔目的,非項目目的。否則造成同一項目多個文檔之間的內容重復,不利于文檔維護。本小節應指明文檔針對的讀者對象,最好列出各種讀者角色,并說明每種讀

3、者角色應該重點閱讀的章節。1.2 文檔范圍文檔的Scope,非項目的Scope。否則造成同一項目多個文檔之間的內容重復,不利于文檔維護。1.3 定義、縮寫詞和縮略語集中列舉文檔中的定義、縮寫詞和縮略語。1.4 參考資料本項目經審核的計劃書、合同、上級批文;本項目的其他已發表文件;本文檔引用的文件資料,如軟件開發標準。具體而言,應包括參考資料的題目(必須)、編號、版本號(必須)、發表日期、發布方,必要時還可以說明如何使用這些資料。2. 架構描述方式 為了讓讀者更好地理解架構文檔,在本節應當說明文檔涉及的架構視圖,并指明為了描述設計決策用到了哪些圖表和模型。2.1 架構視圖閱讀指南以多視圖的方式來

4、組織架構文檔是大勢所趨。ADMEMS推薦的是經過優化的5視圖方法,如下圖所示。2.2 圖表與模型閱讀指南對后續文檔內容中所用到的建模語言(例如UML)、表格(例如目標-場景-決策表)等進行說明。3. 架構設計目標功能、質量、約束,一個都不能少。3.1 關鍵功能對架構設計至關重要的功能,包括如下4類:核心功能、必做功能、高風險功能、獨特功能。所謂獨特功能,指這個功能覆蓋了上述3類功能沒有涉及到的職責。3.2 關鍵質量屬性人之所以痛苦,很多時候是因為追求錯誤的東西。下圖是ADMEMS方法確定關鍵質量的5大原則的整體思路圖。3.3 業務需求和約束因素ADMEMS方法創造性地提出約束需求的4大類型,這

5、是一種極為實用的分類方式。特別是業務需求對架構設計而言是一種約束的觀點,解決了很多架構師的現實困惑。下圖標明了4類約束在“需求層次-需求方面矩陣(又稱ADMEMS矩陣)”中的位置,可以幫助我們理解產生約束需求的根源。4. 架構設計原則投標時經常講“架構設計原則”,但到了架構文檔,這些著眼大局的考慮卻“丟了”。ADMEMS方法推薦的本文檔模板,認為應當把它們“找回來”。4.1 架構設計原則著重描述重大的權衡取舍考慮。4.2 備選架構設計方案及被否原因在概念架構一級,對備選架構設計方案進行描述,并闡述它們未被采用的原因。這有利于團隊了解當前架構設計方案的來龍去脈,提高團隊對當前架構設計方案的認可度

6、。4.3 架構設計對后續工作的限制(詳設,部署等)架構設計不僅應該包含“指導”,也應該包含重要的“限制”。例如,一份只是說明“性能和可擴展性都重要”的架構文檔,實際上忽視了“可擴展性和性能之間存在的矛盾關系”。此時,最有效的辦法就是在架構文檔中明確說明“任何提升可擴展性的架構設計和詳細設計,都應通過架構團隊的評審才能引入,以確保性能目標不受重大影響”。5. 邏輯架構視圖 關注點:此架構設計視圖的關注點是職責劃分。注意:邏輯架構視圖無疑是最重要的,但同時也應避免“架構 = 模塊 + 接口”等以偏概全的認識。參考:任何復雜系統的架構設計都不是一蹴而就的,所以架構師需要理性思維過程的指導。針對邏輯架

7、構設計這個關鍵環節,一線架構師實踐指南一書給出了2條建議:一是“以質疑驅動的螺旋思維”,二是相對分離地考慮“結構方面的切分”和“行為方面的定義”。下圖所示即為ADMEMS方法推薦的邏輯架構設計理性思維過程。 5.1 職責劃分與職責確定內容:將系統切分成更小的單元,并明確這些單元的職責。具體而言,職責單元可以是層、子系統、模塊、關鍵類等。意義:一句話,職責劃分不合理,功能和質量都會受到影響。也就是說,功能需求和質量需求無一不和職責劃分相關:一方面,每個功能都是由一條職責協作鏈完成的;另一方面,職責劃分方式也影響著質量,于是需要職責模型針對特定質量屬性要求做出相應調整和優化。很多人認為架構設計就是

8、職責劃分的藝術,雖略顯片面,但足以表明職責劃分的重要性。參考:基于對業界大量案例的研究,ADMEMS方法梳理出了“模塊劃分的3種必用手段”,如下圖所示,更多內容可參考一線架構師實踐指南一書。 5.2 接口設計與協作機制內容:本節描述接口的定義,以及協作的方式和規范。意義:恰恰是因為有了各模塊之間“未來合作的契約”,分頭開發各模塊才有了基本保證。參考:ADMEMS方法推薦利用“包-接口”圖,來識別接口。下圖為一個“包-接口”圖的示例。 參考:ADMEMS方法推薦使用序列圖,建議少用、甚至杜絕使用協作圖。下圖為一個序列圖的示例。 5.3 重要設計包內容:對重要子系統的設計進行“灰盒”級描述。意義:

9、“每個子系統在架構設計中都應保持黑盒子”的觀點,過于理想化了。對于業務層、通用協作機制而言,經常需要在架構設計期間就引入“灰盒”級描述。參考:類圖和灰盒包圖,在本節中較多出現。下圖為一灰盒包圖示例。 6. 開發架構視圖關注點:此架構設計視圖的關注點是程序單元組織。注意:此架構設計視圖是必須的、不應“剪裁”掉的。但實際情況卻是,很多架構師不關注開發架構視圖,導致很多程序開發人員抱怨“架構師就知道高來高去,架構對編程工作沒什么指導性”。6.1 Project劃分內容:本節說明整個系統將劃分成哪幾個Project來開發,其中,Project指開發環境所感知到的“工程”。意義:基本好處是,有利于開發的

10、組織;而對一些大型的集成系統而言,由于同時涉及了Web應用、桌面應用、嵌入式應用等軟件形態,所以此時Project劃分其實是不得不做的;最后,我們推薦核心代碼應主動地切分到單獨的Project以進行獨立的軟件配置管理(SCM),以降低核心代碼外泄的風險。參考:Project劃分必然是屬于“架構設計”的工作,嚴格來講僅靠“需求分析”劃分的業務域(Business Area)直接映射到Project經常意味著工作內容的遺漏。其實,業界不少有見地的專家已經認識到WBS(工作分解結構)做得太早太草率危害很大,就與“Project劃分不到位”不無關系。 6.2 Project 1內容:對Project劃

11、分后的每個Project進行目錄結構、程序單元組織、框架與應用關系的說明。6.2.1 Project目錄結構指導內容:關于該Project一級目錄、二級目錄等基本目錄結構的約定。意義:為團隊并行開發提供必要基礎,讓不同程序小組看到自己應該負責的程序目錄。參考:不要把所有程序目錄的約定都定義得太細,否則這份架構文檔就要天天更新了。 6.2.2 程序單元組織內容:源碼、程序庫、框架、目標碼等類型程序單元之間的編譯依賴關系。意義:或許有人認為這沒什么技術含量,但架構設計本來就不是只關心技術含量最高問題的。君不見,很多軟件工程師跳槽到新的企業之后,竟然連一個能正常編譯源碼的開發環境都建不起來其實,他們

12、“不知道Project所依賴的Library有哪些”是其中重要原因這本應在架構文檔中給出明確描述的。 6.2.3 框架與應用之間的關系(可選)內容:框架(Framework)。意義:既然不適用Framework的開發越來越少了,既然程序員犯的很多錯誤都和對Framework理解不到位有關,架構師就有責任明確說明Framework和待開發系統之間的關系。 參考:下圖描述了JGraph框架和待開發應用的關系。 參考:下圖描述了Struts框架和待開發應用的關系。 6.3 Project 2內容:對Project劃分后的每個Project進行目錄結構、程序單元組織、框架與應用關系的說明。6.4 Pr

13、oject n內容:對Project劃分后的每個Project進行目錄結構、程序單元組織、框架與應用關系的說明。7. 運行架構視圖 關注點:此架構設計視圖的關注點是控制流組織。注意:進程和線程是廣為人知的控制流實現技術,但在架構設計思維當中,對于系統軟件和嵌入式軟件極為重要的中斷服務程序也是控制流,這樣利于架構師統一利用不同控制流手段設計并行和并發。7.1 控制流組織內容:控制流有哪些,每條控制流各是何種形式(例如進程、線程、中斷服務程序),哪些軟件單元是控制流的起點,整條控制流中分別調用了哪些軟件單元。意義:這是對系統運行時結構的刻畫,主要反映系統的動態結構。7.2 控制流的創建、銷毀、通信

14、內容:描述進程、線程和中斷服務程序的創建和銷毀,以及多條控制流之間的通信關系的定義。意義:一旦引入了多條控制流,附加工作就產生了此時控制流的創建和銷毀、以及控制流之間的通信關系往往是必須考慮的。7.3 加鎖設計內容:系統中有多條控制流在同時運行的情況下,一個經典問題是多于一條控制流可能會同時修改某些數據結構,而造成數據的不一致。為此,架構師需要關注加鎖設計,合理引入臨界區或同步機制。意義:加鎖設計事關系統的正確性。值得注意的是,忽略加鎖設計造成的問題往往以“不易重現的Bug”的形式出現,困惑的程序員會對測試人員說,“你看你報的Bug在我機器上根本就不存在呀”。參考:對通用組件、通用模塊的設計而

15、言,加鎖設計應予以專門關注,思維要點是研究未來通用模塊的各種可能使用場景。8. 物理架構視圖 關注點:此架構設計視圖的關注點是物理節點(Node)分布,以及軟件到硬件的具體映射關系。注意:物理節點即可以是PC機或服務器,也可以是單片機、單板機或專用機,從而物理架構視圖既適用于描述企業信息系統,也適合于描述嵌入式軟件系統。8.1 物理拓撲內容:一為硬件選型,二為硬件之間的拓撲連接關系。意義:對于分布式系統的設計,此節極為重要、而且是必須的。參考:下圖是某企業級系統的物理拓撲圖。參考:下圖是某嵌入式系統的物理拓撲圖。8.2 軟件到硬件的映射內容:明確每個物理節點上有哪些(一到多個)軟件的目標單元,

16、并說明具體的“映射方式”是安裝、是部署、還是燒寫、抑或是下載。意義:如果把此節漏了,就無法表明本文檔的主題軟件系統和上述硬件、硬件拓撲的關系。參考:下圖所示為設備調試系統中,軟件到硬件的映射關系。8.3 優化部署內容:為達降低成本、提高性能和可靠性等等目標,應特別關注的部署考慮。意義:物理架構設計的優劣,造成的成本差異和質量差異,可能是天壤之別。所以必須重視。參考:下圖展示的,是ADMEMS方法重點推薦的“物理架構設計思維要點”,更多內容可參考一線架構師實踐指南一書。9. 數據架構視圖關注點:此架構設計視圖的關注點是持久化。具體而言,場景化可以借助扁平文件、關系數據庫、實時數據庫、Flash等

17、方式中的一種或多種完成。注意:本視圖單獨歸檔時,請在此節注明其文檔名稱等信息。9.1 持久化機制的選擇內容:如下持久化機制的一種或多種:扁平文件、關系數據庫、實時數據庫、Flash。意義:不要假設在你的系統中,持久化只需一種機制;隨著如今的系統變得越來越復雜,我們經常需要綜合利用不同持久化機制。9.2 持久化存儲方案內容:持久化數據的格式定義。意義:統一定義表、文件格式、Flash數據結構等內容。9.3 數據同步與復制策略內容:由于數據分布所引起的,包含數據分布、同步、復制等內容的重要設計決策。意義:在數據分布的情況下,此節為必須。參考:在實際中,數據分布的策略絕大多數情況下不會超越下圖所示的6種手段,更多內容可參考一線架構師實踐指南一書。10

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯系上傳者。文件的所有權益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網頁內容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
  • 4. 未經權益所有人同意不得將文件中的內容挪作商業或盈利用途。
  • 5. 人人文庫網僅提供信息存儲空間,僅對用戶上傳內容的表現方式做保護處理,對用戶上傳分享的文檔內容本身不做任何修改或編輯,并不能對任何下載內容負責。
  • 6. 下載文件中如有侵權或不適當內容,請與我們聯系,我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論