軟件架構設計文檔模板

1、: :r rvProject NameSoftware Architecture DocumentVersion Revision HistoryDateVersio nDescripti onAuthorV yyyy-mm-dd vn ame8.關鍵功能關鍵質量屬性業(yè)務需求和約束因素架構設計原則備選架構設計方案及被否原因架構設計對后續(xù)工作的限制（詳設，部署等）職責劃分與職責確定 接口設計與協(xié)作機制 重要設計包vPreject Name)Versio n:Software Architecture Docume ntDate: V yyyy-mm-dd vdocument identifier

2、文檔簡介1.1文檔目的文檔范圍定義、縮寫詞和縮略語參考資料1.21.31.444442.架構描述方式2.1架構視圖閱讀指南2.2圖表與模型閱讀指南3,架構設計目標3.13.23.34.架構設計原則4.14.24.35.邏輯架構視圖5.15.25.36.開發(fā)架構視圖8.6.1Project劃分1峠6.2Project 116.2.1 Project目錄結構指導16.2.2程序單元組織16.2.3框架與應用之間的關系（可選）16.3Project 2.1亠6.4Project n .131運行架構視圖37.1控制流組織1O7.2控制流的創(chuàng)建、銷毀、通信17.3加鎖設計14物理架構視圖148.1物理

3、拓撲1A8.2軟件到硬件的映射18.3優(yōu)化部署1Page 2 of 187.vPreject Name)Versio n:Software Architecture Docume ntDate: V yyyy-mm-dd vdocument identifier9.數(shù)據(jù)架構視圖10.9.19.29.3持久化機制的選擇 持久化存儲方案 數(shù)據(jù)同步與復制策略171717關鍵質量屬性的設計原理1716vPreject Name)Versio n:v1 0Software Architecture Docume ntDate: V yyyy-mm-dd vdocument identifier圖表與模型

4、閱讀指南對后續(xù)文檔內(nèi)容中所用到的建模語言 說明。”八、/七輯架棟、/舛職吾論q q分職IIII向對彖；或結構化貢耐仍件、嘯脇、0 0、/程序單兀毎已.單尤組織/、直向更件、廣、 雨1 1向TableTable或文件、/數(shù)據(jù)架構、/茅久教據(jù)單兀.數(shù)捱存儲格式-、/、行架構、控制流控制虎組旺X XUi ir r詢控制墻物理架構物湮節(jié)點亠挾舉節(jié)克峯寸心= L 孑弁n向節(jié)點jQ3.架構設計目標功能、質量、約束，一個都不能少。3.1關鍵功能對架構設計至關重要的功能，包括如下4 4類：核心功能、必做功能、高風險功能、獨特功 能。所謂獨特功能，指這個功能覆蓋了上述3 3類功能沒有涉及到的職責。3,2關鍵質量

5、屬性人之所以痛苦，很多時候是因為追求錯誤的東西。下圖是確定關鍵質量的 路圖。5 5大原則的整體思2.2（例如UMLUML）、表格（例如目標-場景-決策表）等進行絹戶架構設計原則投標時經(jīng)常講架構設計原則,但到了架構文檔,這些著眼大局的考慮卻丟了O O檔模板，認為應當把它們“找回來O OvPreject Name)Versio n:v1 0Software Architecture Docume ntDate: V yyyy-mm-dd vdocument identifier3.3業(yè)務需求和約束因素創(chuàng)造性地提出約束需求的4 4大類型，這是一種極為實用的分類方式。特別是業(yè)務需求對架構 設計而言是一

6、種約束的觀點，解決了很多架構師的現(xiàn)實困惑。下圖標明了4 4類約束在次-需求方面矩陣中的位置，可以幫助我們理解產(chǎn)生約束需求的根源。廣義功能業(yè)務級/需求業(yè)務壞境用戶級需求環(huán)境開護團饑蔭繹JS開發(fā)圾需求彳為需求發(fā)期質量構建環(huán)境4.1架構設計原則著重描述重大的權衡取舍考慮。4.2備選架構設計方案及被否原因在概念架構一級，對備選架構設計方案進行描述，并闡述它們未被采用的原因。這有利于團 架構設計方案的來龍去脈，提高團隊對當前架構設計方案的認可度。隊了解當前4.3架構設計對后續(xù)工作的限制（詳設，部署等）架構設計不僅應該包含指導”,也應該包含重要的邙艮制”O(jiān) O例如，一份只是說明性能都重要的架構文檔，實際上

7、忽視了 “可擴展性和性能之間存在的矛盾關系”O(jiān) O此時，最有效的辦法 就是在架構文檔中明確說明任何提升可擴展性的架構設計和 詳細設計，都應通過架構團隊的評審才 能引入，以確保性能目標不受重大影響O O和可擴展性5.邏輯架構視圖關注點：此架構設計視圖的關注點是職責劃分。4.推薦的本文參考：任何復雜系統(tǒng)的架構設計都不是一蹴而就的，所以架構師需要理性思維過程的指導。針對邏輯架構設計這個關鍵環(huán)節(jié)，一線架構師實踐指南一書給出了2 2條建議：一是“以質疑驅動的螺旋思維”,二是相對分離地考慮結構方面的切分和行為方面的定義O O下圖 所示即為椎薦的謬輻架構設計理件思維過稈。1 1質戦冃已的哎訃特殊功能場杲支持

8、嗎？耦合性.重用性咋樣?5.1職責劃分與職責確定內(nèi)容：將系統(tǒng)切分成更小的單元, 塊、關鍵類等。意義：一句話，職責劃分不合理，職責劃分相關：一方面，每個功能都是由一條職責協(xié)作鏈完成的；另一方面，職責劃分方式也影響著質 量，于是需要職責模型針對特定質量屬性要求做出相應調(diào)整和優(yōu)化。很多人認為架構設計就是職責劃分的 藝術，雖略顯片面，但足以表明職責劃分的重要性。參考：基于對業(yè)界大量案例的研究，梳理出了 “模塊劃分的3 3種必用手段,如下圖所示,更多內(nèi)容可參考一線架構師實踐指南一書。 vProject Name)Vdrifolfti的切Software Architecture Docume ntDat

9、e: V yyyy-mm-dd vdocument identifier二模塊+接口”等以偏概全的注意： 邏輯架構視圖無疑是最重要的， 但同時也應避免架 構認識。 并明確這些單元的職責。具體而言，職責單元可以是層、子系統(tǒng)、模功能和質量都會受到影響。也就是說，功能需求和質量需 求無一不和vPreject Name)Versio n:v1 0Software Architecture Docume ntDate: V yyyy-mm-dd vdocument identifier裁哨性原則5.2接口設計與協(xié)作機制內(nèi)容：本節(jié)描述接口的定義，以及協(xié)作的方式和規(guī)范。意義：恰恰是因為有了各模塊之間“未來合

10、作的契約”,分頭開發(fā)各模塊才有了基本保證。參考：推薦利用“包-接口圖，來識別接口。下圖為一個“包 -接口圖的示例。分層的絡化/ / /F /職貴分原則架構本身考耄分區(qū)的引入Software Architecture Docume ntDate: V yyyy-mm-dd vdocument identifier窗口界面共享畀面I IWindowsWindows外殼#展FacadeFacade命令描述進度展規(guī)蟻沖接口再能耀沖機制爪啣$控制解IR的押制介卄爪竭句伏 1 1 玄的艸 V V內(nèi)容縄沖達倔頤喀址対相應擅口進fj啊調(diào)畀肚按門對超出額電価I】容鞍泊內(nèi)容址汀H H征肚“壓粥實現(xiàn)足實現(xiàn)里1字符耶

11、列的用瓠解川纏鼻法 久戚不冷兀們息的兒堀結果接口接口以字荷漬歷式讀文件 牛咸文件鍍沖扳曾包格式分曲燈沖參考，推薦使用序列圖，建議少用、甚至杜絕使用協(xié)作圖。下圖為一個序列圖的示例。r r界IlliIlli選項進用WuWu (Jk(Jk端機解丿k k縮共用4 稈序和夕、空擴展共亨.的歡用界面支持-乍縮vProject Name)Versio n:v1 0Software Architecture Docume ntDate: V yyyy-mm-dd vdocument identifieridid ZipHLnePZipHLneP HajHaj5.3重要設計包內(nèi)容：對重要子系統(tǒng)的設計進行灰盒”級

12、描述。意義：“每個子系統(tǒng)在架構設計中都應保持黑盒子”的觀點，過于理想化了。對于業(yè)務層、通用協(xié)作機 制而言，經(jīng)常需要在架構設計期間就引入“灰盒級描述。參考：類圖和灰盒包圖，在本節(jié)中較多出現(xiàn)。下圖為一灰盒包圖示例。Software Architecture Docume ntDate: V yyyy-mm-dd vdocument identifier/ / AdapterMtAdapterMt ；dtdt詢用4c-inter!act-inter!act? ?1 1X X1驚GanttChartImpIGanttChartImpI歲調(diào)用來自第三方的片特聞繪制包述取數(shù)抓屮卜intcTfaccAint

13、cTfaccAP6.開發(fā)架構視圖關注點：此架構設計視圖的關注點是程序單元組織。注意：此架構設計視圖是必須的、不應剪裁掉的。但實際情況卻是，很多架構師不關注 開發(fā)架構視 圖，導致很多程序開發(fā)人員抱怨架構師就知道高來高去，架構對編程工作沒什么指導性O O6.1Project劃分內(nèi)容：本節(jié)說明整個系統(tǒng)將劃分成哪幾個ProjectProject來開發(fā)，其中，ProjectProject指開發(fā)環(huán)境所感知到的工程O O 意義：基本好處是，有利于開發(fā)的組織；而對一些大型的集成系統(tǒng)而言，由于同時涉及了 恥b b應用、桌面應用、嵌入式應用等軟件形態(tài)， 后，我們推薦核心代碼應主動地切分到單獨的 以降低核心代碼外泄

14、的風險。所以此時ProjectProject劃分其實是不得不做的；最ProjectProject以進行獨立的軟件配置管理（SCMSCM）, ,參考：ProjectProject劃分必然是屬于架構設計inin essess AreaArea）直接映射到ProjectProject經(jīng)常意味著工作內(nèi)容的遺漏。其實，業(yè)界不少有見地的專家已經(jīng)認識 到WBSWBS（工作分解結構）做得太早太草率危害很大，就與“ProjectProject劃分不到位”不無關系。的工作，嚴格來講僅靠需求分析劃分的業(yè)務域（BusBus6.2Project 1內(nèi)容：對ProjectProject劃分后的每個ProjectProje

15、ct進行目錄結構、程序單元組織、框架與應用關系的說明。莊現(xiàn)層么7 7意義：為團隊并行開發(fā)提供必要基礎，讓不同程序小組看到自己應該負責的程序目錄。參考：不要把所有程序目錄的約定都定義得太細，否則這份架構文檔就要天天更新了。程序單元組織內(nèi)容：源碼、程序庫、框架、目標碼等類型程序單元之間的編譯依賴關系。意義：或許有人認為這沒什么技術含量，但架構設計本來就不是只關心技術含量最高問題的。君不見， 很多軟件工程師跳槽到新的企業(yè)之后，竟然連一個能正常編譯源碼的開發(fā)壞境都建不起來一一其實，他們不知道ProjectProject所依賴的LibraryLibrary有哪些是其中重要原因一一這本應在架構文檔中給出明

16、確描述的?？蚣芘c應用之間的關系(可選)內(nèi)容：框架(Framework(Framework)。意義：既然不適用FrameworkFramework的開發(fā)越來越少了，既然程序員犯的很多錯誤都和對FrameworkFramework理解不到位有關，架構師就有責任明確說明FrameworkFramework和待開發(fā)系統(tǒng)之間的關系。參考：下圖描述了JGraphJGraph框架和待開發(fā)應用的關系。vPreject Name)Versio n:v1 0Software Architecture Docume ntDate: V yyyy-mm-dd vdocument identifierProject目錄

17、結構指導內(nèi)容：關于該ProjectProject一級目錄、二級目錄等基本目錄結構的約定。6226.2.3621參考：下圖描述了StrutsStruts框架和待開發(fā)應用的關系。vPreject Name)Versio n:v1 0Software Architecture Docume ntDate: V yyyy-mm-dd vdocument identifierGruGru詆框茱【V6.36.47.7.1Project n.內(nèi)容：對ProjectProject劃分后的每個PrejectPreject進行目錄結構、程序單元組織、框架與應用關系的說明。運行架構視圖關注點：此架構設計視圖的關注點

18、是控制流組織。注意：進程和線程是廣為人知的控制流實現(xiàn)技術，但在架構設計思維當中，對于系統(tǒng)軟件和嵌入式軟件 極為重要的中斷服務程序也是控制流，這樣利于架構師統(tǒng)一利用不同控制流手段設計并行和并發(fā)?？刂屏鹘M織內(nèi)容：控制流有哪些，每條控制流各是何種形式（例如進程、線程、中斷服務程序），哪些軟件單元是 控制流的起點，整條控制流中分別調(diào)用了哪些軟件單元。vProject Name)Versio n:v1 0Software Architecture Docume ntDate: V yyyy-mm-dd Project 2.內(nèi)容：對ProjectProject劃分后的每個PrejectPreject進行目

19、錄結構、程序單元組織、框架與應用關系的說明。意義：這是對系統(tǒng)運行時結構的刻畫，主要反映系統(tǒng)的動態(tài)結構。7,2控制流的創(chuàng)建、銷毀、通信意義：一旦引入了多條控制流，附加工作就產(chǎn)生了一一此時控制流的創(chuàng)建和銷毀、以及控制 流之間的通 信關系往往是必須考慮的。加鎖設計內(nèi)容：系統(tǒng)中有多條控制流在同時運行的情況下，一個經(jīng)典問題是多于一條控制流可能會同時修改某些 數(shù)據(jù)結構，而造成數(shù)據(jù)的不一致。為此，架構師需要關注加鎖設計，合理引入臨界區(qū)或同步機制。意義：加鎖設計事關系統(tǒng)的正確性。值得注意的是，忽略加鎖設計造成的問題往往以不易 重現(xiàn)的BugBug 的形式出現(xiàn)，困惑的程序員會對測試人員說，你看你報的BugBug在

20、我機器上根本就不存在呀O O參考：對通用組件、通用模塊的設計而言，加鎖設計應予以專門關注，思維要點是 研究未來通用模塊的各種可能使用場景。物理架構視圖關注點：此架構設計視圖的關注點是物理節(jié)點（NodeNode）分布，以及軟件到硬件的具體映射關 系。注意：物理節(jié)點即可以是PCPC機或服務器，也可以是單片機、單板機或專用機，從而物理架構視圖既適 用于描述企業(yè)信息系統(tǒng)，也適合于描述嵌入式軟件系統(tǒng)。物理拓撲內(nèi)容：一為硬件選型，二為硬件之間的拓撲連接關系。意義：對于分布式系統(tǒng)的設計，此節(jié)極為重要、而且是必須的。7.38.1參考：下圖是某企業(yè)級系統(tǒng)的物理拓撲圖。vPreject Name)Versio n

21、:v1 0Software Architecture Docume ntDate: V yyyy-mm-dd vdocument identifier游間層1 1參考：下圖是某嵌入式系統(tǒng)的物理拓撲圖。8.2軟件到硬件的映射內(nèi)容：明確每個物理節(jié)點上有哪些（一到多個）軟件的目標單元，并說明具體的“映射方 式是安裝、 是部署、還是燒寫、抑或是下載。意義：如果把此節(jié)漏了，就無法表明本文檔的主題一一軟件系統(tǒng)一一和上述硬件、硬件拓撲vPreject Name)Versio n:v1 0Software Architecture Docume ntDate: V yyyy-mm-dd vdocument i

22、dentifier的關系。意義：物理架構設計的優(yōu)劣，造成的成本差異和質量差異，可能是天壤之別。所以必須重視。關注點：此架構設計視圖的關注點是持久化。 數(shù)據(jù)庫、FlashFlash等方式中的一種或多種完成。 注明其文檔名稱等信息。8.3參考: 下圖所示為設備調(diào)試系統(tǒng)中，軟件到硬件的映射關系。PC機匚 n 桌面部分t5xtgui.exet5xtgui.exeIIIIIIRS.232RS.232 /調(diào)試機djj嵌入制分tsxt.hextsxt.hex丿優(yōu)化部署內(nèi)容:為達降低成本、提高性能和可靠性等等目標，應特別關注的部署考慮。9.參考：下圖展示的, 構師實踐指南一書。0 0o/b耳口多顯金是ADME

23、MSADMEMS方法重點推薦的特定為E E目標的滴丘“物理架構設計思維要點,更多內(nèi)容可參考一線架技木可行性易維護性性能持續(xù)可用性可伸縮性計算開銷內(nèi)萍爭閉碩盤爭用I I冊I層.軟件單元CPUCPU爭州數(shù)據(jù)爭用數(shù)據(jù)單元物理節(jié)點具體而言，場景化可以借助扁平文件、關系數(shù)據(jù)庫、實時注意：本視圖單獨歸檔時，請在此節(jié)經(jīng)濟性最終目標 投資與維護成內(nèi)容：如下持久化機制的一種或多種：扁平文件、關系數(shù)據(jù)庫、實時數(shù)據(jù)庫、持久化只需一種機制；隨著如今的系統(tǒng)變得越來越復雜，我們經(jīng)常需要關鍵質量屬性的設計原理內(nèi)容：因軟件系統(tǒng)的不同，性能、安全性、可伸縮性、互操作性、可擴展性、可測試性、可重用性、可 維護性等質量屬性，都可以是本系統(tǒng)的關鍵質量屬性。本文檔的前面部分已經(jīng)涉及了關鍵質量屬性的設計 決策，而本節(jié)更集中、更全面地描述這些架構設計決策，并且闡述“為什么這么設計。意義：只描述架構設計決策本身，不利于讀者理解為什么這么設計。而且，描述設計原理有利于在 整個軟件企業(yè)層面促進團隊的架構設計能力。vPreject Name）Versio n:v1 0Software Architecture Docume ntDate: V yyyy-mm-dd vdocument ide