系統(tǒng)架構(gòu)設(shè)計(jì)說明書模板

1、系統(tǒng)架構(gòu)設(shè)計(jì)說明書模板錯(cuò)誤未指定書簽。XX系統(tǒng)架構(gòu)設(shè)計(jì)說明書 文檔編號 版本 A1 密級 商密 AXx系統(tǒng)軟件研發(fā)部項(xiàng)目名稱項(xiàng)目來源 QR-RD-035(V1.0)XX 系統(tǒng)架構(gòu)設(shè)計(jì)說明書( 內(nèi)部資料 請勿外傳 ) 編 寫 : 日 期: 檢 查 : 日 期: 審 核 : 日 期: 批 準(zhǔn) : 日 期: 聚融鑫科科技有限公司 版權(quán)所有 不得復(fù)制 內(nèi)部使用 第 1 頁 共 15 頁 錯(cuò)誤未指定書簽。 XX 系統(tǒng)架構(gòu)設(shè)計(jì)說明書 文檔變更記錄序號 變更(+/-) 說明 作者 版本號 日期 批準(zhǔn) 1 2 內(nèi)部使用 第 2 頁 共 15 頁錯(cuò)誤未指定書簽。 XX 系統(tǒng)架構(gòu)設(shè)計(jì)說明書 目錄1、引 51.1

2、背景 51.2 術(shù)語和縮略語 51.3 參考資料 52、總體設(shè)計(jì) 62.1 需求規(guī)定 52.2 架構(gòu)設(shè)計(jì)目標(biāo)和約束 62.2.1 運(yùn)行環(huán)境 62.2.2 開發(fā)環(huán)境 6 2.3設(shè)計(jì)思 想 62.4 架構(gòu)體系 62.5 重要業(yè)務(wù)流程 72.5.1 流程1 72.5.2 流程2 72.5.3 流程3 72.6 模塊劃分 72.6.1 模塊 82.6.2 模塊 93、接口設(shè)計(jì) 93.1 系統(tǒng)外部接口 103.1.1 數(shù)據(jù)庫接口 103.1.2 第三方接口 113.1.3 通信接口 系統(tǒng)內(nèi)部接 11 3.2 口 113.2.1 系統(tǒng)數(shù)據(jù)流 錯(cuò)誤未定義書簽。133.2.2 系統(tǒng)狀態(tài)機(jī) 錯(cuò)誤未定義書簽。 1

3、53.2.3 系統(tǒng)部署圖 錯(cuò)誤未定義書簽。 154、運(yùn)行設(shè)計(jì) 124.1 進(jìn)程/ 任務(wù)的設(shè)計(jì) 12內(nèi)部使用 第 3 頁 共 15 頁錯(cuò)誤未指定書簽。 xx 系統(tǒng)架構(gòu)設(shè)計(jì)說明書4.1.1 前臺RCP客戶端 124.1.2 后臺系統(tǒng) 12 4.2數(shù)據(jù)存 儲 124.2.1 數(shù)據(jù)庫模型 124.2.2 文件 124.2.3 系統(tǒng)參數(shù) 134.2.4 其它數(shù)據(jù) 13 4.3出錯(cuò)處 理 135、特性設(shè)計(jì) 135.1 性能 135.1.1 規(guī)模分析與實(shí)現(xiàn) 135.1.2 性能分析與實(shí)現(xiàn) 135.1.3 內(nèi)存占用 135.1.4 響應(yīng)速度要求 可靠 13 5.2性 135.3 安全性 135.4 可維護(hù)性

4、146、部 146.1 部署模式 146.1.1 部署方式 146.1.2 部署方式 15 6.2 許可協(xié) 議 157、附錄 15內(nèi)部使用 第 4 頁 共 15 頁錯(cuò)誤未指定書簽。XX系統(tǒng)架構(gòu)設(shè)計(jì)說明書1、引言描述本文的參考依據(jù)、資料以及大概內(nèi)容。 1.1 背景 項(xiàng)目產(chǎn)生或者開發(fā)背景，必要性等。 1.2 術(shù)語和縮略語 縮略語、系統(tǒng)主用名詞、術(shù)語等解釋 1.3 參考資料 編寫本文和閱讀本文是需要查閱的資料有關(guān)文檔，注明出處、作者和版本。（ 架構(gòu)設(shè)計(jì)重點(diǎn)在于將系統(tǒng)分層并產(chǎn)生層次內(nèi)的模塊、闡明模塊之間的關(guān)系）2、范圍2.1 軟件名稱英文名稱 :TopEng-CSP中文名稱 : 客戶服務(wù)平臺2.2 軟

5、件功能請參考XXX子系統(tǒng)軟件需求規(guī)格說明書.doc2.3軟件應(yīng)用 請參考系統(tǒng) 軟件需求規(guī)格說明書 .doc 2.4 需求邊界 明確范圍邊界，做什么，不做什么。內(nèi)部使用 第 5 頁 共 15 頁錯(cuò)誤未指定書簽。XX系統(tǒng)架構(gòu)設(shè)計(jì)說明書3、總體設(shè)計(jì)3.1 架構(gòu)設(shè)計(jì)目標(biāo)和約束 架構(gòu)設(shè)計(jì)總體目標(biāo)和一些有關(guān)架構(gòu)方面的約束，比如技術(shù)約束或者設(shè)計(jì)上約束。 3.1.1 運(yùn)行環(huán)境序號 項(xiàng)目 詳細(xì)信息后臺軟件環(huán)境 LinuX, JRE1.6 以上 Tomcat5.5 容器, mysql4.0/ 以上 前臺軟件環(huán)境 Windows XP, Windows 2000 ， windows vista 數(shù)據(jù)庫3.1.2 開

6、發(fā)環(huán)境序號 項(xiàng)目 詳細(xì)信息1 操作系統(tǒng) 開發(fā)編譯系統(tǒng) :JDK 1.6, 操作系統(tǒng) : windows 系列2 編程語言 JAVA、 Java Javascript 、 HTM、L CSS3 Eclipse 3.4 編程工具4 100M Ethernet 網(wǎng)絡(luò)平臺3.2設(shè)計(jì)思想闡明進(jìn)行架構(gòu)設(shè)計(jì)的思想，可參考一些架構(gòu)設(shè)計(jì)的模式，需結(jié)合當(dāng)前系統(tǒng)的實(shí) 際情況而定。3.3架構(gòu)體系根據(jù)架構(gòu)分析和設(shè)計(jì)思想產(chǎn)生系統(tǒng)的架構(gòu)圖，并對架構(gòu)圖進(jìn)行描述，說明分層 的原因、層次的職責(zé)，并根據(jù)架構(gòu)圖繪制系統(tǒng)的物理部署圖，描述系統(tǒng)的部署體系。內(nèi)部使用第6頁共15頁錯(cuò)誤未指定書簽。xx系統(tǒng)架構(gòu)設(shè)計(jì)說明書應(yīng)用客戶端瀏覽器數(shù)據(jù)提

7、供層數(shù)據(jù)記錄文件3.4重要業(yè)務(wù)流程（有多少個(gè)就寫多少個(gè)流程圖）流程圖類型不做嚴(yán)格要求，只要圖和描述表達(dá)設(shè)計(jì)思想即可；重要業(yè)務(wù)流程數(shù)據(jù)流向等。3.4.1流程13.4.2流程23.4.3流程33.5 模塊劃分根據(jù)架構(gòu)圖進(jìn)行模塊的劃分并闡明模塊劃分的理由，繪制模塊物理圖以及模塊 依賴圖。有多少模塊就寫多少個(gè)模塊內(nèi)部使用 第 7 頁 共 15 頁錯(cuò)誤未指定書簽。XX系統(tǒng)架構(gòu)設(shè)計(jì)說明書3.5.1 模塊一3.5.1.1 模塊一描述根據(jù)模塊物理圖描述各模塊的職責(zé)，并聲明其對其他模塊的接口要求。這是本系統(tǒng)中的上層應(yīng)用，包括提供各種功能的插件以及用戶界面，主要為用 戶提供輸入條件和輸出結(jié)果，也就是查詢條件的輸入

8、和數(shù)據(jù)展示，也包括基本數(shù)據(jù)的錄 入和管理功能，由如下的插件應(yīng)用構(gòu)成，子模塊 描述實(shí)時(shí)監(jiān)控插件 負(fù)責(zé)提供實(shí)時(shí)監(jiān)控功能3.5.1.2 模塊一業(yè)務(wù)流程說明圖 +文字描述。樣例 ;DonwinActionL內(nèi)部使用第8頁共15頁錯(cuò)誤未指定書簽。xx系統(tǒng)架構(gòu)設(shè)計(jì)說明書3.5.1.3 模塊一接口設(shè)計(jì)對模塊接口進(jìn)行設(shè)計(jì)，并提供一定的偽代碼。3.5.2模塊二3.5.2.1 模塊二描述根據(jù)模塊物理圖描述各模塊的職責(zé)，并聲明其對其他模塊的接口要求。這是本系統(tǒng)中的上層應(yīng)用，包括提供各種功能的插件以及用戶界面，主要為用 戶提供輸入條件和輸出結(jié)果，也就是查詢條件的輸入和數(shù)據(jù)展示，也包括基本數(shù)據(jù)的錄 入和管理功能，由如下

9、的插件應(yīng)用構(gòu)成,子模塊描述實(shí)時(shí)監(jiān)控插件 負(fù)責(zé)提供實(shí)時(shí)監(jiān)控功能3.522 模塊二業(yè)務(wù)流程說明圖+文字描述。樣例；內(nèi)部使用第9頁共15頁錯(cuò)誤未指定書簽。xx系統(tǒng)架構(gòu)設(shè)計(jì)說明書ArtinnDonuanT-J3.5.2.3 模塊二接口設(shè)計(jì)對模塊接口進(jìn)行設(shè)計(jì)，并提供一定的偽代碼。4、接口設(shè)計(jì)對場景以及問題域進(jìn)行分析，構(gòu)成系統(tǒng)的架構(gòu)級設(shè)計(jì)，闡明對于系統(tǒng)的分層思 想。4.1系統(tǒng)外部接口4.1.1數(shù)據(jù)庫接口本系統(tǒng)未使用數(shù)據(jù)庫連接池技術(shù)，但軟件中存在Apache Dbcp數(shù)據(jù)庫連接池JAR包,后臺服務(wù)采用JDBC連接MYSQ數(shù)據(jù)庫，由于本系統(tǒng)存在多個(gè)數(shù)據(jù)庫，每活 動線程最多擁有一個(gè)數(shù)據(jù)庫連接，外部請求在使用完成

10、后不需要顯式關(guān)閉。內(nèi)部使用 第 10 頁 共 15 頁錯(cuò)誤未指定書簽。xx系統(tǒng)架構(gòu)設(shè)計(jì)說明書4.1.2 第三方接口4.1.3 通信接口4.2 系統(tǒng)內(nèi)部接口, 應(yīng)用子系統(tǒng)這是本系統(tǒng)中的上層應(yīng)用，包括提供各種功能的插件以及用戶界面，主要為用 戶提供輸入條件和輸出結(jié)果，也就是查詢條件的輸入和數(shù)據(jù)展示，也包括基本數(shù)據(jù)的錄 入和管理功能，由如下的插件應(yīng)用構(gòu)成，模塊 描述實(shí)時(shí)監(jiān)控插件負(fù)責(zé)提供實(shí)時(shí)監(jiān)控功能虛擬身份插件負(fù)責(zé)提供真實(shí) / 虛擬身份的查詢，軌跡查詢的功能案件管理插件負(fù)責(zé)提供對案件的管理和報(bào)警等功能線索分析插件負(fù)責(zé)提供同時(shí)上下機(jī)查詢，碰撞分析和 CCIC庫管理等功能情報(bào)分析插件負(fù)責(zé)提供對內(nèi)容的查詢和

11、QQ子友分析等功能實(shí)名登記插件負(fù)責(zé)提供對實(shí)名登記查詢和違規(guī)卡的管理功能場所管理插件負(fù)責(zé)提供對上網(wǎng)場所的管理和運(yùn)行狀態(tài)綜合統(tǒng)計(jì)信息等功能系統(tǒng)管理插件負(fù)責(zé)完成整個(gè)系統(tǒng)的管理，包括用戶密碼，和基本數(shù)據(jù)的管理能 , 后臺子系統(tǒng)相對與應(yīng)用插件，后臺數(shù)據(jù)子系統(tǒng)的主要功能是接受來自插件應(yīng)用的請求，并 為請求提供實(shí)際操作功能。模塊 描述實(shí)時(shí)監(jiān)控后臺 負(fù)責(zé)提供實(shí)時(shí)監(jiān)控虛擬身份后臺 負(fù)責(zé)提供真實(shí) / 虛擬身份的查詢，軌跡查詢的功能案件管理后臺 負(fù)責(zé)提供對案件的管理和報(bào)警等功能線索分析后臺負(fù)責(zé)提供同時(shí)上下機(jī)查詢，碰撞分析和 CCIC庫管理等功能實(shí)名登記后臺 負(fù)責(zé)提供對實(shí)名登記查詢和違規(guī)卡的管理功能場所管理后臺 負(fù)責(zé)

12、提供對上網(wǎng)場所的管理和運(yùn)行狀態(tài)綜合統(tǒng)計(jì)信息等功能 系 統(tǒng)管理后臺 負(fù)責(zé)完成整個(gè)系統(tǒng)的管理，包括用戶密碼，和基本數(shù)據(jù)的管理功內(nèi)部使用 第 11 頁 共 15 頁錯(cuò)誤未指定書簽。xx系統(tǒng)架構(gòu)設(shè)計(jì)說明書能, 文本分析子系統(tǒng)負(fù)責(zé)對協(xié)議文本文件的索引，包括IM聊天記錄文件，POST內(nèi)容記錄文件等的 索引和查詢功能模塊 描述文本索引模塊負(fù)責(zé)提供對文本文件的索引，采用 LUCENC技術(shù)索引查詢模塊負(fù)責(zé)提供對內(nèi)容的查詢和QQ子友分析等功能, 配置中心子系統(tǒng)配置中心子系統(tǒng)負(fù)責(zé)為后臺服務(wù)和客戶端配置文件的配置提供GUI 的配置途徑5、運(yùn)行設(shè)計(jì)本系統(tǒng)在設(shè)計(jì)時(shí)為了保證客戶端的響應(yīng)動態(tài)響應(yīng)前臺的請求而動態(tài)生成任務(wù) 外，

13、同時(shí)啟動多個(gè)后臺服務(wù)。5.1 進(jìn)程/ 任務(wù)的設(shè)計(jì)5.1.1前臺RCP客戶端取客戶端配置放內(nèi)存（經(jīng)配置可以使用JAR包XML配置文件而省略這一步）刪除5.1.2 后臺系統(tǒng)對于多表查詢，使用任務(wù)方式委托 JDK線程池對不同表進(jìn)行查詢。整個(gè)后臺服務(wù)初始完成以后，將生成以下任務(wù) （或線程），此任務(wù)為單一線程， 并未做線程池并發(fā)處理，任務(wù)線程串行處理任務(wù)5.2 數(shù)據(jù)存儲5.2.1 數(shù)據(jù)庫模型重要數(shù)據(jù)模型5.2.2 文件系統(tǒng)用文件系統(tǒng)結(jié)果、接口等。內(nèi)部使用 第 12 頁 共 15 頁錯(cuò)誤未指定書簽。xx系統(tǒng)架構(gòu)設(shè)計(jì)說明書5.2.3 系統(tǒng)參數(shù)配置參數(shù)、環(huán)境參數(shù)等datasource.config 數(shù)據(jù)源列表

14、serverlist.config 報(bào)警的服務(wù)器列表system-id 自識別的城市 ID5.2.4 其它數(shù)據(jù)內(nèi)存等5.3 出錯(cuò)處理本章節(jié)應(yīng)列出出錯(cuò)原因及提示信息6、特性設(shè)計(jì)特性設(shè)計(jì)可以根據(jù)產(chǎn)品用途、行業(yè)標(biāo)準(zhǔn)等實(shí)際情況對章節(jié)進(jìn)行調(diào)整。 6.1 性 能描述系統(tǒng)常態(tài)下系統(tǒng)要求，重要有代表業(yè)務(wù)性能指標(biāo)。以及在架構(gòu)設(shè)計(jì)中保證 性能，方案和設(shè)計(jì)要求6.1.1 規(guī)模分析與實(shí)現(xiàn)6.1.2 性能分析與實(shí)現(xiàn)6.1.3 內(nèi)存占用6.1.4 響應(yīng)速度要求6.2 可靠性標(biāo)準(zhǔn)是 72小時(shí)無故障。例如為保證 72 小時(shí)，在故障處理設(shè)計(jì)實(shí)現(xiàn)方式、要求 等。還有異常處理6.3 安全性用戶和權(quán)限管理、數(shù)據(jù)范圍權(quán)限的控制、通訊是否加密，加密方式強(qiáng)度和