《軟件架構(gòu)設(shè)計文檔》模板

1、fl00Version <1.0>i歡迎下載Revision HistoryvProject Name>Software Architecture Docume nt0卮DateVersio nDescripti onAuthor< yyyy-mm-dd ><x.x><details><n ame>精品文檔精品文檔目錄1.文檔簡介51.1文檔目的51.2文檔范圍51.3定義、縮寫詞和縮略語51.4參考資料52.架構(gòu)描述方式52.1架構(gòu)視圖閱讀指南52.2圖表與模型閱讀指南53.架構(gòu)設(shè)計目標(biāo)63.1關(guān)鍵功能63.2關(guān)鍵質(zhì)量屬性63

2、.3業(yè)務(wù)需求和約束因素64.架構(gòu)設(shè)計原則74.1架構(gòu)設(shè)計原則74.2備選架構(gòu)設(shè)計方案及被否原因74.3架構(gòu)設(shè)計對后續(xù)工作的限制（詳設(shè)，部署等）75.邏輯架構(gòu)視圖75.1職責(zé)劃分與職責(zé)確定85.2接口設(shè)計與協(xié)作機(jī)制85.3重要設(shè)計包86.開發(fā)架構(gòu)視圖96.1Project 劃分96.2Project 196.2.1 Project目錄結(jié)構(gòu)指導(dǎo)96.2.2程序單元組織96.2.3框架與應(yīng)用之間的關(guān)系（可選）96.3Project 2106.4Project n 107.運(yùn)行架構(gòu)視圖107.1控制流組織107.2控制流的創(chuàng)建、銷毀、通信117.3加鎖設(shè)計118.物理架構(gòu)視圖118.1物理拓?fù)?18.

3、2軟件到硬件的映射128.3優(yōu)化部署12精品文檔9.數(shù)據(jù)架構(gòu)視圖139.1持久化機(jī)制的選擇139.2持久化存儲方案139.3數(shù)據(jù)同步與復(fù)制策略1310.關(guān)鍵質(zhì)量屬性的設(shè)計原理14精品文檔1. 文檔簡介幫助讀者對本文檔建立基本印象，并為閱讀后續(xù)內(nèi)容掃清障礙。1.1文檔目的文檔目的，非項目目的。否則造成同一項目多個文檔之間的內(nèi)容重復(fù)，不利于文檔維護(hù)。本 小節(jié)應(yīng)指明文檔針對的讀者對象，最好列出各種讀者角色，并說明每種讀者角色應(yīng)該重點閱讀 的章節(jié)。1.2 文檔范圍文檔的Scope，非項目的Scope。否則造成同一項目多個文檔之間的內(nèi)容重復(fù)，不利于文檔維 護(hù)。1.3定義、縮寫詞和縮略語集中列舉文檔中的定

4、義、縮寫詞和縮略語。1.4參考資料本項目經(jīng)審核的計劃書、合同、上級批文；本項目的其他已發(fā)表文件；本文檔引用的文件資 料，如軟件開發(fā)標(biāo)準(zhǔn)。具體而言，應(yīng)包括參考資料的題目（必須）、編號、版本號（必須）、 發(fā)表日期、發(fā)布方，必要時還可以說明如何使用這些資料。2. 架構(gòu)描述方式為了讓讀者更好地理解架構(gòu)文檔，在本節(jié)應(yīng)當(dāng)說明文檔涉及的架構(gòu)視圖，并指明為了描 述設(shè)計決策用到了哪些圖表和模型。2.1架構(gòu)視圖閱讀指南以多視圖的方式來組織架構(gòu)文檔是大勢所趨。推薦的是經(jīng)過優(yōu)化的5視圖方法，如下圖所示。直向控制淹直向更件謖輯架構(gòu)、職貴間協(xié)柞面向Table 或文件運(yùn)行架構(gòu)控制流控制謊組£程序單元 稈吊單元組織

5、數(shù)據(jù)架構(gòu)、持久數(shù)單元 鶴馮存儲格式'珞理架分 物湮節(jié)點 、/面向節(jié)點或毎構(gòu)化2.2圖表與模型閱讀指南精品文檔UML、表格（例如目標(biāo)-場景-決策表）等進(jìn)行對后續(xù)文檔內(nèi)容中所用到的建模語言（例如 說明。3. 架構(gòu)設(shè)計目標(biāo)3.1關(guān)鍵功能對架構(gòu)設(shè)計至關(guān)重要的功能，包括如下能。所謂獨特功能，指這個功能覆蓋了上述4類：核心功能、必做功能、高風(fēng)險功能、獨特功3類功能沒有涉及到的職責(zé)。3.25大原則的整體思很多時候是因為追求錯誤的東西。下圖是確定關(guān)鍵質(zhì)量的3.3關(guān)鍵質(zhì)量屬性人之所以痛苦,功能、質(zhì)量、約束，一個都不能少。種極為實用的分類方式。特別是業(yè)務(wù)需求對架構(gòu) 是一種約束的觀點，解決了很多架構(gòu)師的現(xiàn)實

6、困惑。下圖標(biāo)明了4類約束在“需求層創(chuàng)造性地提出約束需求的 4大類型，這是設(shè)計而言次-需求方面矩陣”中的位置，可以幫助我們理解產(chǎn)生約束需求的根源。精品文檔4. 架構(gòu)設(shè)計原則投標(biāo)時經(jīng)常講“架構(gòu)設(shè)計原則”，但到了架構(gòu)文檔，這些著眼大局的考慮卻“丟了”。 推薦的本文檔模板，認(rèn)為應(yīng)當(dāng)把它們“找回來”。4.1架構(gòu)設(shè)計原則著重描述重大的權(quán)衡取舍考慮。4.2備選架構(gòu)設(shè)計方案及被否原因在概念架構(gòu)一級，對備選架構(gòu)設(shè)計方案進(jìn)行描述，并闡述它們未被采用的原因。這有利于團(tuán) 隊了解當(dāng)前架構(gòu)設(shè)計方案的來龍去脈，提高團(tuán)隊對當(dāng)前架構(gòu)設(shè)計方案的認(rèn)可度。4.3架構(gòu)設(shè)計對后續(xù)工作的限制（詳設(shè)，部署等）架構(gòu)設(shè)計不僅應(yīng)該包含“指導(dǎo)”，也

7、應(yīng)該包含重要的“限制”。例如，一份只是說明“性能 和可擴(kuò)展性都重要”的架構(gòu)文檔，實際上忽視了“可擴(kuò)展性和性能之間存在的矛盾關(guān) 系”。此時，最有效的辦法就是在架構(gòu)文檔中明確說明“任何提升可擴(kuò)展性的架構(gòu)設(shè)計和 詳細(xì)設(shè)計，都應(yīng)通過架構(gòu)團(tuán)隊的評審才能引入，以確保性能目標(biāo)不受重大影響”。5. 邏輯架構(gòu)視圖關(guān)注點：此架構(gòu)設(shè)計視圖的關(guān)注點是職責(zé)劃分。注意：邏輯架構(gòu)視圖無疑是最重要的，但同時也應(yīng)避免“架構(gòu)=模塊+接口”等以偏概全的認(rèn)識。 參考：任何復(fù)雜系統(tǒng)的架構(gòu)設(shè)計都不是一蹴而就的，所以架構(gòu)師需要理性思維過程的指導(dǎo)。針對邏輯架構(gòu)設(shè)計這個關(guān)鍵環(huán)節(jié)，一線架構(gòu)師實踐指南一書給出了2條建議：一是“以質(zhì)廣義功能庾量約束

8、疑驅(qū)動的螺旋思維”，二是相對分離地考慮“結(jié)構(gòu)方面的切分”和“行為方面的定義”。下圖精品文檔5.1職責(zé)劃分與職責(zé)確定內(nèi)容：將系統(tǒng)切分成更小的單元，并明確這些單元的職責(zé)具體而言，職責(zé)單元可以 子系統(tǒng)、模塊、關(guān)鍵類等。''"意義：一句話，職責(zé)劃分不合理，功能和質(zhì)量都會受到求無一不和職責(zé)劃分相關(guān)：一方面，每個功能都是由一條職責(zé)協(xié)作鏈完成的；另一方面 劃分方式也影響著質(zhì)量，于是需要職責(zé)模型針對特定質(zhì)量屬性求做出相應(yīng)調(diào)整和優(yōu)化。彳 人認(rèn)為架構(gòu)設(shè)計就是職責(zé)劃分的藝術(shù)，雖略顯片面，但足以表明職責(zé)劃分的重要性。特殊功能場景支持嗎？影響。也就是說，功能需求和,結(jié)構(gòu)方直壬曰 質(zhì)量需如下f

9、JJ 二二.序列圖曲層的毎化完善呼列圏行為方面的約定機(jī)制的彊取枝能分離原則分區(qū)的引入工作均術(shù)原則人的因素考烹決定性原処E'，職責(zé)參考：基于對業(yè)界大量案例的研究，梳理出了 “模塊劃分的 更多內(nèi)容可參考一線架構(gòu)師實踐指南一書。3種必用手段”址職責(zé)協(xié) 驗證能否完 助能完威再影哨住阪則所示即為推薦的邏輯架構(gòu)設(shè)計理性思維過程。5.2接口設(shè)計與協(xié)作機(jī)制內(nèi)容：本節(jié)描述接口的定義，以及協(xié)作的方式和規(guī)范。意義：恰恰是因為有了各模塊之間“未來合作的契約”，分頭開發(fā)各模塊才有了基本保證。參考：推薦利用“包-接口”圖，來識別接口。下圖為一個“包-接口”圖的示例。Winda圖的示例口門鎌和解mb共用上稈序和外殼

10、擴(kuò)廉共字的賓用畀曲共字界而參考：推薦使用序列圖，建議少用、甚至杜絕使用協(xié)作圖。下圖為一個序列選頂茂買5.3重要設(shè)計包內(nèi)容：對重要子系統(tǒng)的設(shè)計進(jìn)行“灰盒”級描述。Facade進(jìn)廐展于見 回調(diào)擢口壓堀捽剤層-壓縮的擰制種I悴創(chuàng)精品文檔意義：“每個子系統(tǒng)在架構(gòu)設(shè)計中都應(yīng)保持黑盒子”的觀點，過于理想化了。對于業(yè)務(wù)層、通用協(xié)作機(jī)制而言，經(jīng)常需要在架構(gòu)設(shè)計期間就引入“灰盒”級描述。參考：類圖和灰盒包圖，在本節(jié)中較多出現(xiàn)。下圖為一灰盒包圖示例。6.開發(fā)架構(gòu)視圖關(guān)注點：此架構(gòu)設(shè)計視圖的關(guān)注點是程序單元組織。注意：此架構(gòu)設(shè)計視圖是必須的、不應(yīng)“剪裁”掉的開發(fā)架構(gòu)視圖，導(dǎo)致很多程序開發(fā)人員抱怨“架構(gòu)師就知道高來高

11、去，架構(gòu)對編程工作沒什么 指導(dǎo)性”。(interfacedJI L AGanttChart。但實際情況卻是，很多架構(gòu)師不關(guān)注CanttChartlmpImi6.1Project 劃分內(nèi)容：知到的意義:本節(jié)說明整個系統(tǒng)將劃分成哪幾個“工程”?；竞锰幨?，有利于開發(fā)的組織；而對一些大ProjeCt 來開發(fā)，其屮，Project指開發(fā)環(huán)境所感型的集成系統(tǒng)而言，由于同時涉及了粧據(jù)Web應(yīng)用、桌面應(yīng)用、嵌入式應(yīng)用等軟件形態(tài)，所以此時Project劃分其實是不得不做的；最roject以進(jìn)行獨立的軟件配置管理（SCMI 乍，嚴(yán)格來講僅靠“需求一后，我們推薦核心代碼應(yīng)主動地切分到單獨的 以降低核心代碼外泄的風(fēng)

12、險。參考：Project劃分必然是屬于“架構(gòu)設(shè)計” 務(wù)域（Bus in ess Area ）直接映射到 Project 見地的專家已經(jīng)認(rèn)識到 WBS（工作分解結(jié)構(gòu)） 不到位”不無關(guān)系。的工經(jīng)常意味著工作內(nèi)容的遺漏。其實，業(yè)界不少有 做得太早太草率危害很大，就與“Project劃分6.2 Project 1內(nèi)容：對Project劃分后的每個 Project進(jìn)行目錄結(jié)構(gòu)、程序單元組織、框架與應(yīng)用關(guān)系的 說明。6.2.1 Project目錄結(jié)構(gòu)指導(dǎo)內(nèi)容：關(guān)于該P(yáng)roject 一級目錄、二級目錄等基本目錄結(jié)構(gòu)的約定。意義：為團(tuán)隊并行開發(fā)提供必要基礎(chǔ)，讓不同程序小組看到自己應(yīng)該負(fù)責(zé)的程序目錄。參考：不要

13、把所有程序目錄的約定都定義得太細(xì)，否則這份架構(gòu)文檔就要天天更新了。6.2.2 程序單元組織內(nèi)容：源碼、程序庫、框架、目標(biāo)碼等類型程序單元之間的編譯依賴關(guān)系。意義：或許有人認(rèn)為這沒什么技術(shù)含量，但架構(gòu)設(shè)計本來就不是只關(guān)心技術(shù)含量最高問題 的。君不見，很多軟件工程師跳槽到新的企業(yè)之后，竟然連一個能正常編譯源碼的開發(fā)環(huán)境都 建不起來一一其實，他們“不知道Project所依賴的Library 有哪些”是其中重要原因一一這本應(yīng)在架構(gòu)文檔中給出明確描述的。6.2.3 框架與應(yīng)用之間的關(guān)系（可選）內(nèi)容：框架（Framework）。精品文檔意義：既然不適用 Framework的開發(fā)越來越少了，既然程序員犯的很

14、多錯誤都和對Framework理解不到位有關(guān)，架構(gòu)師就有責(zé)任明確說明Framework和待開發(fā)系統(tǒng)之間的關(guān)系。 參考：下圖描述了 JGraph框架和待開發(fā)應(yīng)用的關(guān)系。6.3 Project 2內(nèi)容：對Project劃分后的每個 Project進(jìn)行目錄結(jié)構(gòu)、程序單元組織、框架與應(yīng)用關(guān)系的 說明。6.4 Project n 內(nèi)容：對Project劃分后的每個 Project進(jìn)行目錄結(jié)構(gòu)、程序單元組織、框架與應(yīng)用關(guān)系的 說明。7. 運(yùn)行架構(gòu)視圖關(guān)注點：此架構(gòu)設(shè)計視圖的關(guān)注點是控制流組織。 注意：進(jìn)程和線程是廣為人知的控制流實現(xiàn)技術(shù)，但在架構(gòu)設(shè)計思維當(dāng)中，對于系統(tǒng)軟件和 嵌入式軟件極為重要的中斷服務(wù)程

15、序也是控制流，這樣利于架構(gòu)師統(tǒng)一利用不同控制流手段設(shè) 計并行和并發(fā)。7.1控制流組織精品文檔內(nèi)容：控制流有哪些，每條控制流各是何種形式（例如進(jìn)程、線程、中斷服務(wù)程序），哪些 軟件單元是控制流的起點，整條控制流中分別調(diào)用了哪些軟件單元。意義：這是對系統(tǒng)運(yùn)行時結(jié)構(gòu)的刻畫，主要反映系統(tǒng)的動態(tài)結(jié)構(gòu)。7.2控制流的創(chuàng)建、銷毀、通信內(nèi)容：描述進(jìn)程、線程和中斷服務(wù)程序的創(chuàng)建和銷毀，以及多條控制流之間的通信關(guān)系的定 義。意義：一旦引入了多條控制流，附加工作就產(chǎn)生了一一此時控制流的創(chuàng)建和銷毀、以及控制 流之間的通信關(guān)系往往是必須考慮的。7.3加鎖設(shè)計內(nèi)容：系統(tǒng)中有多條控制流在同時運(yùn)行的情況下，一個經(jīng)典問題是多于

16、一條控制流可能會同 時修改某些數(shù)據(jù)結(jié)構(gòu)，而造成數(shù)據(jù)的不一致。為此，架構(gòu)師需要關(guān)注加鎖設(shè)計，合理引入臨界 區(qū)或同步機(jī)制。意義：加鎖設(shè)計事關(guān)系統(tǒng)的正確性。值得注意的是，忽略加鎖設(shè)計造成的問題往往以“不易 重現(xiàn)的Bug”的形式出現(xiàn)，困惑的程序員會對測試人員說，“你看你報的Bug在我機(jī)器上根本就不存在呀”。參考：對通用組件、通用模塊的設(shè)計而言，加鎖設(shè)計應(yīng)予以專門關(guān)注，思維要點是研究未來 通用模塊的各種可能使用場景。8. 物理架構(gòu)視圖關(guān)注點：此架構(gòu)設(shè)計視圖的關(guān)注點是物理節(jié)點（Node）分布，以及軟件到硬件的具體映射關(guān)系。注意：物理節(jié)點即可以是 PC機(jī)或服務(wù)器，也可以是單片機(jī)、單板機(jī)或?qū)Ｓ脵C(jī)，從而物理架構(gòu)

17、 視圖既適用于描述企業(yè)信息系統(tǒng)，也適合于描述嵌入式軟件系統(tǒng)。8.1物理拓?fù)鋬?nèi)容：一為硬件選型，二為硬件之間的拓?fù)溥B接關(guān)系。意義：對于分布式系統(tǒng)的設(shè)計，此節(jié)極為重要、而且是必須的。參考：下圖是某企業(yè)級系統(tǒng)的物理拓?fù)鋱D。r仝.廿參考:F圖是某嵌入式系統(tǒng)的物理拓?fù)鋱D。額饒方詛勞器精品文檔27調(diào)試機(jī)L茫嵌入部分 1 tsxt.hex LRS2328.2軟件到硬件的映射內(nèi)容：明確每個物理節(jié)點上有哪些（一到多個）軟件的目標(biāo)單元，并說明具體的"映射方 式”是安裝、是部署、還是燒寫、抑或是下載。意義：如果把此節(jié)漏了，就無法表明本文檔的主題一一軟件系統(tǒng)一一和上述硬件、硬件拓?fù)?的關(guān)系。參考：下圖所示為

18、設(shè)備調(diào)試系統(tǒng)中，軟件到硬件的映射關(guān)系。8.3優(yōu)化部署內(nèi)容：為達(dá)降低成本、提高性能和可靠性等等目標(biāo)，應(yīng)特別關(guān)注的部署考慮。意義：物理架構(gòu)設(shè)計的優(yōu)劣，造成的成本差異和質(zhì)量差異，可能是天壤之別。所以必須重 視。參考：下圖展示的，是 ADMEM方法重點推薦的“物理架構(gòu)設(shè)計思維要點”，更多內(nèi)容可參考 一線架構(gòu)師實踐指南一書。精品文檔O 0/0口多方滲金最終目標(biāo)投瓷與維護(hù)感 本合理碇注能目標(biāo)的滿丘經(jīng)濟(jì)性技木可行性易維護(hù)性性能持續(xù)可用性可伸縮性目標(biāo)層集設(shè)臚容節(jié)點選擇份布楣撲 軟件單元和數(shù)據(jù)單 元的職責(zé)與分韋 tjncduiiu 等沒計架構(gòu)師腱醸辱占計算和逋信奔肖小信時內(nèi)和硬敘CPM 麟各沖竇通信開銷:網(wǎng)緒爭

19、用H I計算開銷內(nèi)厚爭州硬盤爭用CPU爭州數(shù)據(jù)爭用rIj田i I P'Lli* Ii層|數(shù)據(jù)單元物理節(jié)點9. 數(shù)據(jù)架構(gòu)視圖關(guān)注點：此架構(gòu)設(shè)計視圖的關(guān)注點是持久化。具體而言，場景化可以借助扁平文件、關(guān)系數(shù) 據(jù)庫、實時數(shù)據(jù)庫、Flash等方式中的一種或多種完成。注意：本視圖單獨歸檔時，請在此節(jié)注明其文檔名稱等信息。9.1持久化機(jī)制的選擇內(nèi)容：如下持久化機(jī)制的一種或多種：扁平文件、關(guān)系數(shù)據(jù)庫、實時數(shù)據(jù)庫、Flash。意義：不要假設(shè)在你的系統(tǒng)中，持久化只需一種機(jī)制；隨著如今的系統(tǒng)變得越來越復(fù)雜，我們經(jīng)常需要綜合利用不同持久化機(jī)制。9.2持久化存儲方案內(nèi)容：持久化數(shù)據(jù)的格式定義。意義：統(tǒng)一定義表、文件格式、Flash數(shù)據(jù)結(jié)構(gòu)等內(nèi)容。9.3數(shù)據(jù)同步與復(fù)制策略內(nèi)容：由于數(shù)據(jù)分布所引起的，包含數(shù)據(jù)分布、同步、復(fù)制等內(nèi)容的重要設(shè)計決策。意義：在數(shù)據(jù)分布的情況下，此節(jié)為必須。參考：在實際中，數(shù)據(jù)分布的策略絕大多數(shù)情況下不會超越下圖所示的6種手段，更多內(nèi)容可參考一線架構(gòu)師實踐指