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

1、精選優(yōu)質(zhì)文檔-傾情為你奉上軟件研發(fā)部文檔編號版本A1密級商密A項目名稱Xx系統(tǒng)項目來源Xx系統(tǒng)架構(gòu)設(shè)計說明書(內(nèi)部資料 請勿外傳)編 寫：日 期：檢 查：日 期：審 核：日 期：批 準：日 期：XXXX科技有限公司版權(quán)所有 不得復(fù)制文檔變更記錄序號變更（+/-）說明作者版本號日期批準12目 錄1、 引言描述本文的參考依據(jù)、資料以及大概內(nèi)容。1.1 背景項目產(chǎn)生或者開發(fā)背景，必要性等。1.2 術(shù)語和縮略語縮略語、系統(tǒng)主用名詞、術(shù)語等解釋1.3 參考資料編寫本文和閱讀本文是需要查閱的資料有關(guān)文檔，注明出處、作者和版本。(架構(gòu)設(shè)計重點在于將系統(tǒng)分層并產(chǎn)生層次內(nèi)的模塊、闡明模塊之間的關(guān)系)2、 范圍2

2、.1 軟件名稱英文名稱：TopEng-CSP中文名稱：客戶服務(wù)平臺2.2 軟件功能請參考XXX子系統(tǒng) 軟件需求規(guī)格說明書.doc2.3 軟件應(yīng)用請參考系統(tǒng) 軟件需求規(guī)格說明書.doc2.4 需求邊界明確范圍邊界，做什么，不做什么。3、 總體設(shè)計3.1 架構(gòu)設(shè)計目標和約束架構(gòu)設(shè)計總體目標和一些有關(guān)架構(gòu)方面的約束，比如技術(shù)約束或者設(shè)計上約束。3.1.1 運行環(huán)境序號項目詳細信息后臺軟件環(huán)境Linux, JRE1.6以上 Tomcat5.5容器, mysql4.0/以上前臺軟件環(huán)境Windows XP, Windows 2000， windows vista數(shù)據(jù)庫3.1.2 開發(fā)環(huán)境序號項目詳細信息

3、1操作系統(tǒng)開發(fā)編譯系統(tǒng)：JDK 1.6, 操作系統(tǒng)： windows系列2編程語言JAVA、Java Javascript、HTML、CSS3編程工具Eclipse 3.44網(wǎng)絡(luò)平臺100M Ethernet3.2 設(shè)計思想闡明進行架構(gòu)設(shè)計的思想，可參考一些架構(gòu)設(shè)計的模式，需結(jié)合當前系統(tǒng)的實際情況而定。3.3 架構(gòu)體系根據(jù)架構(gòu)分析和設(shè)計思想產(chǎn)生系統(tǒng)的架構(gòu)圖，并對架構(gòu)圖進行描述，說明分層的原因、層次的職責(zé)，并根據(jù)架構(gòu)圖繪制系統(tǒng)的物理部署圖，描述系統(tǒng)的部署體系。3.4 重要業(yè)務(wù)流程（有多少個就寫多少個流程圖）流程圖類型不做嚴格要求，只要圖和描述表達設(shè)計思想即可;重要業(yè)務(wù)流程數(shù)據(jù)流向等。3.4.1

4、流程13.4.2 流程23.4.3 流程33.5 模塊劃分根據(jù)架構(gòu)圖進行模塊的劃分并闡明模塊劃分的理由，繪制模塊物理圖以及模塊依賴圖。有多少模塊就寫多少個模塊3.5.1 模塊一3.5.1.1 模塊一描述根據(jù)模塊物理圖描述各模塊的職責(zé)，并聲明其對其他模塊的接口要求。這是本系統(tǒng)中的上層應(yīng)用，包括提供各種功能的插件以及用戶界面，主要為用戶提供輸入條件和輸出結(jié)果，也就是查詢條件的輸入和數(shù)據(jù)展示，也包括基本數(shù)據(jù)的錄入和管理功能，由如下的插件應(yīng)用構(gòu)成，子模塊描述實時監(jiān)控插件負責(zé)提供實時監(jiān)控功能3.5.1.2 模塊一業(yè)務(wù)流程說明圖+文字描述。樣例;3.5.1.3 模塊一接口設(shè)計對模塊接口進行設(shè)計，并提供一定

5、的偽代碼。3.5.2 模塊二3.5.2.1 模塊二描述根據(jù)模塊物理圖描述各模塊的職責(zé)，并聲明其對其他模塊的接口要求。這是本系統(tǒng)中的上層應(yīng)用，包括提供各種功能的插件以及用戶界面，主要為用戶提供輸入條件和輸出結(jié)果，也就是查詢條件的輸入和數(shù)據(jù)展示，也包括基本數(shù)據(jù)的錄入和管理功能，由如下的插件應(yīng)用構(gòu)成，子模塊描述實時監(jiān)控插件負責(zé)提供實時監(jiān)控功能3.5.2.2 模塊二業(yè)務(wù)流程說明圖+文字描述。樣例;3.5.2.3 模塊二接口設(shè)計對模塊接口進行設(shè)計，并提供一定的偽代碼。4、 接口設(shè)計對場景以及問題域進行分析，構(gòu)成系統(tǒng)的架構(gòu)級設(shè)計，闡明對于系統(tǒng)的分層思想。4.1 系統(tǒng)外部接口4.1.1 數(shù)據(jù)庫接口本系統(tǒng)未使

6、用數(shù)據(jù)庫連接池技術(shù)，但軟件中存在Apache Dbcp 數(shù)據(jù)庫連接池JAR包l 后臺服務(wù)采用JDBC連接MYSQL數(shù)據(jù)庫，由于本系統(tǒng)存在多個數(shù)據(jù)庫，每活動線程最多擁有一個數(shù)據(jù)庫連接，外部請求在使用完成后不需要顯式關(guān)閉。4.1.2 第三方接口4.1.3 通信接口4.2 系統(tǒng)內(nèi)部接口l 應(yīng)用子系統(tǒng)這是本系統(tǒng)中的上層應(yīng)用，包括提供各種功能的插件以及用戶界面，主要為用戶提供輸入條件和輸出結(jié)果，也就是查詢條件的輸入和數(shù)據(jù)展示，也包括基本數(shù)據(jù)的錄入和管理功能，由如下的插件應(yīng)用構(gòu)成，模塊描述實時監(jiān)控插件負責(zé)提供實時監(jiān)控功能虛擬身份插件負責(zé)提供真實/虛擬身份的查詢，軌跡查詢的功能案件管理插件負責(zé)提供對案件的管

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

8、分析和CCIC庫管理等功能實名登記后臺負責(zé)提供對實名登記查詢和違規(guī)卡的管理功能場所管理后臺負責(zé)提供對上網(wǎng)場所的管理和運行狀態(tài)綜合統(tǒng)計信息等功能系統(tǒng)管理后臺負責(zé)完成整個系統(tǒng)的管理，包括用戶密碼，和基本數(shù)據(jù)的管理功能l 文本分析子系統(tǒng)負責(zé)對協(xié)議文本文件的索引，包括IM聊天記錄文件，POST內(nèi)容記錄文件等的索引和查詢功能模塊描述文本索引模塊負責(zé)提供對文本文件的索引，采用LUCENCE技術(shù)索引查詢模塊負責(zé)提供對內(nèi)容的查詢和QQ好友分析等功能l 配置中心子系統(tǒng)配置中心子系統(tǒng)負責(zé)為后臺服務(wù)和客戶端配置文件的配置提供GUI的配置途徑5、 運行設(shè)計本系統(tǒng)在設(shè)計時為了保證客戶端的響應(yīng)動態(tài)響應(yīng)前臺的請求而動態(tài)生成

9、任務(wù)外，同時啟動多個后臺服務(wù)。5.1 進程/任務(wù)的設(shè)計5.1.1 前臺RCP客戶端取客戶端配置放內(nèi)存（經(jīng)配置可以使用JAR包XML配置文件而省略這一步）刪除5.1.2 后臺系統(tǒng)對于多表查詢，使用任務(wù)方式委托JDK線程池對不同表進行查詢。整個后臺服務(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é)果、接口等。5.2.3 系統(tǒng)參數(shù)配置參數(shù)、環(huán)境參數(shù)等datasource.config 數(shù)據(jù)源列表serverlist.config 報警的服務(wù)器列表system-id 自識別的城市ID5.2.4 其它數(shù)據(jù)內(nèi)存等5.3 出錯處理本章節(jié)應(yīng)列出出錯原因及提示信息 6、 特性設(shè)計特性設(shè)計可以根據(jù)產(chǎn)品用途、行業(yè)標準等實際情況對章節(jié)進行調(diào)整。6.1 性能描述系統(tǒng)常態(tài)下系統(tǒng)要求，重要有代表業(yè)務(wù)性能指標。以及在架構(gòu)設(shè)計中保證性能，方案和設(shè)計要求6.1.1 規(guī)模分析與實現(xiàn)6.1.2 性能分析與實現(xiàn)6.1.3 內(nèi)存占用6.1.4 響應(yīng)速度要求6.2 可靠性標準是72小時無故障。例如為保證72小時，在故障處理設(shè)計實現(xiàn)方式、要求等。還有異常處理 6.3 安全性用戶和權(quán)限管理、數(shù)據(jù)范圍權(quán)限