軟件概要設(shè)計(jì)說明書模板

1、軟件概要設(shè)計(jì)說明書模板模板編號GEN_WEB模板版本V3.0軟件概要設(shè)計(jì)說明書擬制某某某日 期2018 年10 月 20日審 核日 期批日模板編號GEN_WEB模板版本V3.0準(zhǔn)期模板編號GEN_WEB模板版本V3.0文檔修改記錄修改日期版本/ 狀態(tài)作者修改早節(jié)修改描述201710-17V1.0某某某初版V1.0發(fā)布模板編號GEN_WEB模板版本V3.0填寫說明1. 系統(tǒng)結(jié)構(gòu)的定義本體系對整個(gè)軟件系統(tǒng)按如下結(jié)構(gòu)方式進(jìn)行劃 分：系統(tǒng)子系統(tǒng) 模塊 子模塊其中：（1） “系統(tǒng)子系統(tǒng)”劃分屬于“系統(tǒng)設(shè) 計(jì)”，在系統(tǒng)設(shè)計(jì)說明書中予以描述。（2） “子系統(tǒng)模塊”劃分屬于“概要設(shè) 計(jì)”，在本說明書中予以描述

2、。（3） “模塊 子模塊”劃分屬于“詳細(xì)設(shè) 計(jì)”，在詳細(xì)設(shè)計(jì)說明書中予以描述。如果系統(tǒng)相對 簡單，可以省略“子模塊”這一層次。2. 如果填寫了系統(tǒng)設(shè)計(jì)說明書，則在本說明書中略過“系統(tǒng)子系統(tǒng)”劃分的相關(guān)內(nèi)容（即第 2章）。3. 如果系統(tǒng)相對簡單，不需要做“系統(tǒng) 子系統(tǒng)” 劃分，這種情況下，取消填寫系統(tǒng)設(shè)計(jì)說明書，只須填寫本說明書，直接套用“子系統(tǒng)模塊”劃分（即第3章）進(jìn)行“系統(tǒng) 模塊”劃分（把其中“子系 統(tǒng)”一詞替換為“系統(tǒng)”），并刪除本說明書中“系統(tǒng) 子系統(tǒng)”劃分的相關(guān)內(nèi)容（第2章）。模板編號GEN_WEB模板版本V3.01.簡介.1.1.1.2.1.3.0背景和目的 范圍 術(shù)語和縮略語1任務(wù)

3、概述2.1.1.目標(biāo)12.1.2需求概述122.設(shè)計(jì)概述22.2.1. 總體約束2122.系統(tǒng)總體設(shè)計(jì)2.1223.2.3 2.4 3.子系統(tǒng)1設(shè)計(jì)3.1系統(tǒng)外部接口 設(shè)計(jì)方案概述 系統(tǒng)架構(gòu)設(shè)計(jì) 系統(tǒng)的邏輯架構(gòu)設(shè)計(jì) 系統(tǒng)的物理架構(gòu)設(shè)計(jì) 子系統(tǒng)定義 子系統(tǒng)列表子系統(tǒng)間關(guān)系8 任務(wù)概述 目標(biāo)模板編號GEN_WEB3.2需求概述設(shè)計(jì)概述3.2.1.總體約束子系統(tǒng)外部接口10設(shè)計(jì)方案概述 123.3.3.4模塊定義 143.4.1模塊列表 143.4.2模塊間關(guān)系 153.4.3模塊描述 154. 非功能性需求的實(shí)現(xiàn)方案6X 性能的考慮176.2 兼容性的考慮186.3 安全的考慮186.4. 可移植

4、性的考慮186.5. 集成與測試的考慮186.6. 可擴(kuò)展性的考慮196.7 可靠性的考慮196.8. 可維護(hù)性的考慮195.難點(diǎn)及解決方案206.參考資料20乙附錄20子系統(tǒng)架構(gòu)設(shè)計(jì) 12模板編號GEN_WEB模板版本V3.01. 簡介1.1. 背景和目的本文檔編制的目的是說明對軟件系統(tǒng)的設(shè)計(jì)考 慮，包括軟件系統(tǒng)的基本處理流程，軟件系統(tǒng)的組織 結(jié)構(gòu)、模塊劃分、功能分配、接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、 數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等，為軟件的詳細(xì)設(shè)計(jì) 奠定基礎(chǔ)。1.2. 范圍本文檔適用于消息推送項(xiàng)目二期產(chǎn)品的服務(wù)端。1.3.術(shù)語和縮略語縮略 語英文全名中文解釋XMPPTheExte nsibleMessa

5、gi ngandPrese nee Protocol可擴(kuò)展通訊和表示協(xié)議模板編號GEN_WEB模板版本V3.02. 系統(tǒng)總體設(shè)計(jì)裁剪說明：如果已編寫系統(tǒng)設(shè)計(jì)說明書，或項(xiàng)目不 做“系統(tǒng) 子系統(tǒng)”劃分，此章省略；否則內(nèi)部的 各節(jié)必須按要求填寫。 “系統(tǒng)一一 子系統(tǒng)”劃分。目的：1）設(shè)計(jì)系統(tǒng)整體框架：系統(tǒng)最高層次的邏輯 結(jié)構(gòu)、物理結(jié)構(gòu)；2）子系統(tǒng)的劃分與依賴關(guān)系定義、子系統(tǒng) 之間的接口定義、子系統(tǒng)功能定義。2.1. 任務(wù)概述2.1.1. 目標(biāo)實(shí)現(xiàn)目標(biāo)和功能。2.1.2. 需求概述參考“軟件需求規(guī)格說明書模板編號GEN_WEB模板版本V3.022設(shè)計(jì)概述221 .總體約束系統(tǒng)外部接口 設(shè)計(jì)方案概述建立

6、一套即時(shí)通訊&消息推送的解決方案：1）云端運(yùn)用 spring+mina+jgroups建立一個(gè)分布式的服務(wù)端系統(tǒng)，以XMPP協(xié)議提供接口；2）終端運(yùn)用smack建立一個(gè)XMPP協(xié)議的客 戶端，調(diào)用協(xié)議接口實(shí)現(xiàn)消息接收和終端展示。模板編號GEN_WEB模板版本V3.02.3.系統(tǒng)架構(gòu)設(shè)計(jì)系統(tǒng)的邏輯架構(gòu)設(shè)計(jì)單IDC服務(wù)器架構(gòu)圖4 M 絡(luò) «.if縛端協(xié)饋抵器分六層結(jié)構(gòu)：負(fù)載均衡層、接入層、邏輯處理層、 數(shù)據(jù)訪問層、數(shù)據(jù)層、WEB層1）負(fù)載均衡層：TV終端通過域名訪問云端， DNS智能解析終端的IP地址讓它連接就近的分 發(fā)服務(wù)器，從 分發(fā)服務(wù)器獲取接入服務(wù)器列表， 然后斷開XMPP

7、連接；2）接入層：TV終端和接入服務(wù)器建立XMPP模板編號GEN_WEB模板版本V3.0長連接，創(chuàng)建會話；3）邏輯處理層：終端協(xié)議服務(wù)器、推送服務(wù)器（RS ）、統(tǒng)計(jì)服務(wù)器。a）終端協(xié)議服務(wù)器：終端往接入服務(wù)器發(fā)送 協(xié)議包，接入服務(wù)器轉(zhuǎn)發(fā)給終端協(xié)議服務(wù)器處 理；b）推送服務(wù)器：負(fù)責(zé)從MQ取出消息、解析 消息（條件體和消息體）、終端在線和離線查詢、 按各接入服務(wù)器有哪些終端登錄把消息包分發(fā)給接入服務(wù)器；c）統(tǒng)計(jì)服務(wù)器：運(yùn)用quartz執(zhí)行定時(shí)任務(wù)， 實(shí)現(xiàn)終端每天在線數(shù)、終端每小時(shí)在線數(shù)、終 端每天激活數(shù)、終端登錄次數(shù)、消息推送結(jié)果 等統(tǒng)計(jì)功能。4）數(shù)據(jù)訪問層：提供數(shù)據(jù)訪問組件，如Mysql JDB

8、C接口、jedis緩存接口。提供第三方推送接 口，供第三方云端調(diào)用的API，提供單點(diǎn)推送（明 消息/暗消息）、條件（區(qū)域+機(jī)型）推送、regid 推送。5）數(shù)據(jù)層：Mongodb集群,Mysql數(shù)據(jù)庫（主 從+讀寫分離），ActiveMQ消息隊(duì)列，Redis緩 存服務(wù)器。6）WEB層：運(yùn)營平臺、第三方推送平臺。模板編號GEN_WEB模板版本V3.02312 多IDC服務(wù)器架構(gòu)圖需要整理2.32系統(tǒng)的物理架構(gòu)設(shè)計(jì)lli其器終端恥譏W齊絆 W:-劃佃於15接人丿JU務(wù)器運(yùn)甘T臺船刃服務(wù)淫2.4.子系統(tǒng)定乂子系統(tǒng)列表子系統(tǒng)子系統(tǒng)名功能描述開發(fā)方編號稱（標(biāo)識）式1運(yùn)營平臺由超級管理員和運(yùn)營自行開模板編

9、號GEN_WEB子系統(tǒng)人員使用，提供第三方 管理、基礎(chǔ)數(shù)據(jù)、消息 管理、運(yùn)維、統(tǒng)計(jì)、系 統(tǒng)設(shè)置、日志查詢等功 能。發(fā)2第二方推 送接口子 系統(tǒng)供第三方云端 調(diào)用的 API，提供單點(diǎn)推送（明 消息/暗消息）、條件（區(qū) 域+機(jī)型）推送、regid 推送。自行開發(fā)3第二方推 送平臺子 系統(tǒng)給第三方使用，提供開 發(fā)者賬號注冊、應(yīng)用管 理、消息發(fā)布、消息推 送結(jié)果查詢等功能。自行開發(fā)4推送服務(wù)器子系統(tǒng)云端的一個(gè)邏輯服務(wù) 器，實(shí)現(xiàn)從MQ取出消 息、解析消息（條件體 和消息體）、終端在線 和離線查詢、按各接入 服務(wù)器有哪些終端登 錄把消息包分發(fā)給接 入服務(wù)器。自行開發(fā)某某某有限公司模板編號GEN_WEB模板

10、版本V3.05后臺任務(wù) 子系統(tǒng)云端的后臺任務(wù)系統(tǒng)， 運(yùn)用quartz 執(zhí)行定時(shí) 任務(wù)，實(shí)現(xiàn)終端每天在 線數(shù)、終端每小時(shí)在線 數(shù)、終端每天激活數(shù)、 終端登錄次數(shù)、消息推 送結(jié)果等統(tǒng)計(jì)功能。自行開發(fā)6云端與終 端接口：分 發(fā)服務(wù)器、接入服務(wù) 器、終端協(xié) 議服務(wù)器為消息盒子終端提供 云端接口，用XMPP協(xié) 議。提供獲取接入服務(wù) 器列表、電視終端獲取 唯一標(biāo)識 userid、以 userid登錄認(rèn)證、建立 會話及長連接、推送消 息、反饋消息接收和點(diǎn) 擊情況、終端應(yīng)用激活 上報(bào)等協(xié)議。自行開發(fā)7云端集群在云端用JGroups技 術(shù)組建一個(gè)集群，管理 各邏輯服務(wù)器，實(shí)現(xiàn)各 成員之間的通訊、成員 狀態(tài)反饋、

11、成員列表維 護(hù)等功能。自行開發(fā)模板編號GEN_WEB模板版本V3.0注：開發(fā)方式可選：采購、外包、自行開發(fā)、復(fù)用2.42子系統(tǒng)間關(guān)系裁剪說明：必填明確子系統(tǒng)之間的調(diào)用關(guān)系、子系統(tǒng)間的接口（消息、數(shù)據(jù)結(jié)構(gòu)）以及相關(guān)子系統(tǒng)之間的協(xié)同工作， 可以使用結(jié)構(gòu)圖、（交互）事務(wù)圖、消息序列圖、ER 圖描述。3.子系統(tǒng)1設(shè)計(jì)裁剪說明：必填標(biāo)題上加入子系統(tǒng)的編號及名稱（標(biāo)識） “子系統(tǒng)一一 > 模塊”劃分。目的：1）設(shè)計(jì)子系統(tǒng)整體框架：子系統(tǒng)的邏輯結(jié)構(gòu);2）模塊的劃分與依賴關(guān)系定義、模塊之間 的接口定義、模塊功能定義。3.1. 任務(wù)概述3.1.1. 目標(biāo)裁剪說明：可選說明設(shè)計(jì)意圖目標(biāo)（總目標(biāo)、分期目標(biāo)）、

12、作 用范圍等。模板編號GEN_WEB模板版本V3.03.12需求概述裁剪說明：可選解釋軟件產(chǎn)品將完成或不完成的功能（可以直 接描述也可以參考相關(guān)文檔）3.2. 設(shè)計(jì)概述.總體約束開發(fā)規(guī)范裁剪說明：可選。如果已填寫在 ，此處 則略。（1 ）編碼約定規(guī)定代碼體系、模塊之間的接口和命名規(guī)則。（2 ）文件約定規(guī)定子系統(tǒng)的所有配置、日志等文件命名方式 與格式。（3 ）目錄約定規(guī)定子系統(tǒng)的目錄結(jié)構(gòu)，包括運(yùn)行目錄、源文 件目錄、配置目錄、日志目錄、數(shù)據(jù)目錄等。 模板編號GEN_WEB模板版本V3.03212 XX約束裁剪說明：可選。如果已填寫在 2222，此處 則略。列出對軟件設(shè)計(jì)有重要影響的系統(tǒng)內(nèi)外部約束

13、 和限制，可選的約束包括：?用戶環(huán)境?內(nèi)存或其它資源限制?數(shù)據(jù)存儲和分發(fā)需求?安全和可靠性需求?性能需求?測試和可維護(hù)性需求子系統(tǒng)外部接口裁剪說明：如果第2章已刪除，這里必填（如 果有）。描述該軟件子系統(tǒng)與外部實(shí)體的接口，包括用 戶界面、軟件接口、硬件接口和通信接口。軟件子系統(tǒng)的外部實(shí)體，包括：操作系統(tǒng)、驅(qū) 動(dòng)程序、硬件、中斷、其它軟件子系統(tǒng)等。模板編號GEN_WEB模板版本V3.0描述待開發(fā)軟件子系統(tǒng)與外部實(shí)體的關(guān)系，可 以使用系統(tǒng)架構(gòu)圖、頂層數(shù)據(jù)流圖、事務(wù)圖等來描述系統(tǒng)結(jié)構(gòu)和交互關(guān)系，并標(biāo)示出外部實(shí)體和本系統(tǒng)相 互作用的性質(zhì)（比如：消息、庫調(diào)用）和類型（比如:OS服務(wù)、通信服務(wù)、系統(tǒng)工具等

14、）。詳細(xì)描述子系統(tǒng)外部接口的參數(shù)，如：?接口名稱?調(diào)用方式?傳輸?shù)臄?shù)據(jù)：-哪些數(shù)據(jù) 項(xiàng)？-數(shù)據(jù)格式？ -長度？-類型？?頻度（實(shí)時(shí)/批處理）?數(shù)據(jù)同步機(jī)制?平臺無關(guān)性?遵循的標(biāo)準(zhǔn)?提供的功能?前置條件?后置條件模板編號GEN_WEB模板版本V3.0323.設(shè)計(jì)方案概述裁剪說明：必填。如果在“ 3.1設(shè)計(jì)概述”中 已描述過的部分，可略。描述內(nèi)容包括：（1）整個(gè)設(shè)計(jì)所采用的方法：面向?qū)ο笤O(shè)計(jì)還 是結(jié)構(gòu)化設(shè)計(jì)（2）采用的系統(tǒng)架構(gòu)：例如 MVC架構(gòu)、N層 架構(gòu)（3 ）使用的相應(yīng)技術(shù)和工具：例如OMT、Rose、Visio（4）采用的框架技術(shù)的形式（5）使用的設(shè)計(jì)模式：層模式、微內(nèi)核模式、 代理模式等（

15、6）描述資源/內(nèi)存分配，F(xiàn)lash資源/文件分 配（7）描述哪些模塊采用軟件復(fù)用3.3.子系統(tǒng)架構(gòu)設(shè)計(jì)裁剪說明：必填定義子系統(tǒng)的總體邏輯結(jié)構(gòu)，定義模塊劃分以模板編號GEN_WEB模板版本V3.0及模塊之間的依賴關(guān)系?？梢圆捎梅謱咏Y(jié)構(gòu)描述如何將子系統(tǒng)分解為模 塊。結(jié)構(gòu)描述可以使用結(jié)構(gòu)圖、層次分解圖、數(shù)據(jù) 流圖，并用文字說明相互間的關(guān)系。舉例，繪制結(jié)構(gòu)圖如下:模塊2模塊4子模塊2-12E子模塊M子模塊3叫:t子模塊4轉(zhuǎn)子模塊4七 sJ 7X.y模塊1具有繼承等關(guān)系的類圖的可使用 UML等工具畫 出關(guān)系圖，如下：com.tcl. common, cshareLoginActivffycom td.

16、c ommo n. c sh are. widgetBaseT abActivitvMyHameActiwityWeiboCori tentAc tivit y<fMySpte&AetluityPcstWeiboActivitySearclActlvItvLcgou Activitycom t cl. common. cshare. dm模板編號GEN_WEB模板版本V3.011weiboAaindroicI<1com.itcL comma n. c share. util£com tc L com mon- csha re B excepti on3.4.模塊定

17、義模塊列表裁剪說明：必填列舉模塊時(shí)，可以采用表格方式（編號可以省模板編號GEN_WEB模板版本V3.0略）。模塊編 號模塊名稱（標(biāo)識）功能簡述開發(fā)方式注：開發(fā)方式可選：采購、外包/自行開發(fā)/復(fù)用342模塊間關(guān)系裁剪說明：必填明確模塊之間的調(diào)用關(guān)系、模塊間的接口（消 息、數(shù)據(jù)結(jié)構(gòu)）以及相關(guān)模塊之間的協(xié)同工作，如模 塊間時(shí)序圖，協(xié)作圖，以及系統(tǒng)之間狀態(tài)切換流程圖。模塊描述模塊 1標(biāo)題上加入模塊的編號及名稱（標(biāo)識）1 ）功能描述裁剪說明：必填說明該模塊具備什么樣的基本功能，以及每個(gè) 功能之間的相互關(guān)系。2 ）性能描述模板編號GEN_WEB模板版本V3.0裁剪說明：必填說明對模塊的性能要求，包括精度、

18、時(shí)間特性 和處理速度。3 ）接口描述裁剪說明：必填說明與其它模塊的接口，與其它系統(tǒng)或硬件的 接口。對于接口函數(shù)，可以采用以下形式描述：接口 1 :形式：輸入：輸出：返回：描述返回什么。描述：總體描述該接口實(shí)現(xiàn)的目的。需要明確的信息包括：（1）輸入項(xiàng)列出模塊每一個(gè)輸入項(xiàng)的特性，包括名稱、標(biāo)識、 數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸入方式、 數(shù)量和頻度、輸入介質(zhì)等；可以是邏輯層面的輸入項(xiàng)，如：圖片資源、媒體 流、網(wǎng)絡(luò)數(shù)據(jù)等，也可以是具體的物理層面的輸入項(xiàng)， 如變量1、變量2,等等。模板編號GEN_WEB模板版本V3.0（2）輸出項(xiàng)列出模塊每一個(gè)輸出項(xiàng)的特性，包括名稱、標(biāo)識、 數(shù)據(jù)的類型和格式，數(shù)

19、據(jù)值的有效范圍、輸出方式、 數(shù)量和頻度、輸出介質(zhì)等。4 ）配置描述裁剪說明：可選說明該模塊所處的邏輯位置、物理位置，如指 明模塊放在哪個(gè)應(yīng)用服務(wù)器或客戶端的哪個(gè)目錄、哪個(gè)文件（庫），或是在數(shù)據(jù)庫內(nèi)部建立的對象。3432模塊2同 333.1。4. 非功能性需求的實(shí)現(xiàn)方案裁剪說明：整章可選6.1.性能的考慮女口：為滿足延時(shí)、吞吐量等性能，在既定硬件 環(huán)境約束下所采取的設(shè)計(jì)方案。模板編號GEN_WEB模板版本V3.062兼容性的考慮對以前版本的兼容，以及平滑升級的考慮。63安全的考慮女口：作為應(yīng)用軟件，在安全方面更多的是考慮 訪問控制，包括使用什么樣的權(quán)限管理、分配、驗(yàn)證 方案。6.4. 可移植性的考慮系統(tǒng)如果有跨平臺的需求，要考慮操作系統(tǒng)、 中