綱要設(shè)計說明書擬制某某某日期2018年10月20日審核日期批準(zhǔn)日期文檔改正記錄修他日期

版本/狀態(tài)

作者

改正幸節(jié)

改正描繪2017-10-17

某某某

第一版發(fā)布填寫說明系統(tǒng)構(gòu)造的定狡本體系對整個秋件系統(tǒng)按如下構(gòu)造方式進行區(qū)分：系統(tǒng)子系統(tǒng)模塊子模塊其中：1）“系統(tǒng)子系統(tǒng)”區(qū)分屬于“系統(tǒng)設(shè)計”，在系統(tǒng)設(shè)計說明書中子以描繪。2）“子系統(tǒng)模塊”區(qū)分屬于''槪要設(shè)計”，在本說明書中予以描繪。3）“模塊子模塊”區(qū)分屬于“詳盡設(shè)計",在詳盡設(shè)計說明書中予以描繪。如果系統(tǒng)相對簡單，能夠省略“子模塊”這一層次。2.如果填寫了系統(tǒng)設(shè)計說明書，則在本說明書中略過“系統(tǒng)子系統(tǒng)"區(qū)分的有關(guān)內(nèi)容（即第2章）。3.如果系統(tǒng)相對簡單，不需要做“系統(tǒng)子系統(tǒng)”區(qū)分，這種情況下，取消填寫系統(tǒng)設(shè)計說明書，只須填寫本說明書，直接套用“子系統(tǒng)模塊”區(qū)分（即第3章）進行“系統(tǒng)模塊”區(qū)分（把其中“子系統(tǒng)”一詞替換為“系統(tǒng)”），并刪除本說明書中“系子統(tǒng)系統(tǒng)”區(qū)分的有關(guān)內(nèi)容（第2章）。1?簡介1二背景和目的...................................................................................................................................................................1二空....................................................................................................................................................................................1二術(shù)語和縮略語...............................................................................................................................................................12?系統(tǒng)總體設(shè)計1二任務(wù)概括.......................................................................................................................................................................2目標(biāo)2需求概括2二設(shè)計概括.......................................................................................................................................................................2總體約東2系統(tǒng)外部接口................................................................................................................2設(shè)計方案槪述....系統(tǒng)架構(gòu)設(shè)計3系統(tǒng)的邏輯架構(gòu)設(shè)計3系統(tǒng)的物理架構(gòu)設(shè)計4子系統(tǒng)定義5子系統(tǒng)列表5子系統(tǒng)間關(guān)系53.子系統(tǒng)1設(shè)計6任務(wù)槪述6目標(biāo)6需求概括6設(shè)計槪述6總體拘束.........................................................................................................................................................6子系統(tǒng)外部接口7設(shè)計方案槪述8子系統(tǒng)架構(gòu)設(shè)計8模塊定義10模塊列表10模塊間關(guān)系11模塊描繪114..............................................................................................................................................................................

非功能性需求的實現(xiàn)方案

................................................................................................................................................................12二性能的考慮................................................................................................................................................................12二兼容性的考慮............................................................................................................................................................13二安全的考慮................................................................................................................................................................13二可移植性的考慮.......................................................................................................................................................13二集成與測試的考慮...................................................................................................................................................13二可擴展性的考慮.......................................................................................................................................................13二可靠性的考慮............................................................................................................................................................13二可維護性的考慮.......................................................................................................................................................145?難點及解決方案146?參照資料147.附錄151.簡介1.1.背景和目的本文檔編制的目的是說明對軟件系統(tǒng)的設(shè)計考慮，包括軟件系統(tǒng)的基本辦理流程，軟件系統(tǒng)的組織構(gòu)造、模塊區(qū)分、功能分派、接口設(shè)計、運行設(shè)計、數(shù)據(jù)構(gòu)造設(shè)計和犯錯辦理設(shè)計等，為軟件的詳盡設(shè)計確立基礎(chǔ)。1.2.范圍本文檔合用于消息推送項目二期產(chǎn)品的服務(wù)端。1.3.術(shù)語和縮略語縮略語英文全名中文解釋XMPPTheExtensibleMessagingandPresence可擴展通訊和表示協(xié)議Protocol2.系統(tǒng)總體設(shè)計｛裁剪說明：如果已編寫系統(tǒng)設(shè)計說明書，或項目不做“系統(tǒng)

子系統(tǒng)"區(qū)分，此幸省略；否則內(nèi)部的各節(jié)必須按要求填寫。］｛“系統(tǒng)——

>子系統(tǒng)”區(qū)分。｝｛目的：1）設(shè)計系統(tǒng)整體框架：系統(tǒng)最高層次的邏輯構(gòu)造、物理2）子系統(tǒng)的區(qū)分與依靠關(guān)系定艾、子系統(tǒng)之間的接口定艾、子系統(tǒng)功能定狡。｝

構(gòu)造；2.1.任務(wù)概括2.1.1.目標(biāo)實現(xiàn)目標(biāo)和功能。2.1.2.需求概括參照'‘軟件需求規(guī)格說明書。2.設(shè)計概括2.2.1.總體拘束2.2.系統(tǒng)外部接口2.3.設(shè)計方案概括成立一套即時通訊&消息推送的解決方案：1)云端運用spring+mina+jgroups成立一個散布式的服務(wù)端系統(tǒng)，以XMPP協(xié)議提供接口：2)終端運用smack成立一個XMPP協(xié)議的客戶端，調(diào)用協(xié)議接口實現(xiàn)消息接收和終端展示。3.系統(tǒng)架構(gòu)設(shè)計3.1.系統(tǒng)的邏輯架構(gòu)設(shè)計.單IDC服務(wù)器架構(gòu)圖WEBU運筮三力推送丫臺問層業(yè)務(wù)肚務(wù)衣集終端初?議tK務(wù)器?脫務(wù)圈lA用服務(wù)圈群(和人數(shù)據(jù)刈揉)網(wǎng)絡(luò)?XMPP服務(wù)總線,(isollps)0馥溝衙以散發(fā)服務(wù)器IDS)分六層構(gòu)造：負(fù)載平衡層.接入層、邏輯辦理層、數(shù)據(jù)接見層、數(shù)據(jù)層、WEB層。1)負(fù)載平衡層：TV終端經(jīng)過域名接見云端，DNS智能解析終端的IP地點讓它連結(jié)就近的散發(fā)服務(wù)器，從散發(fā)服務(wù)器獲取接入服務(wù)器列表，然后斯開XMPP連結(jié)；接入層：TV終端和接入服務(wù)器成立XMPP長連結(jié)，創(chuàng)立會話；邏輯辦理層：終端協(xié)議服務(wù)器、推送服務(wù)器(RS).統(tǒng)計服務(wù)器。a)終端協(xié)議服務(wù)器：終端往接入服務(wù)器發(fā)送協(xié)議包，接入服務(wù)器轉(zhuǎn)發(fā)給終端協(xié)議服務(wù)器辦理：推送服務(wù)器：負(fù)責(zé)從MQ取出消息.解析消息(條件體和消息體)、終端在線和離線查問、按各接入服務(wù)器有哪些終端登錄把消息包散發(fā)給接入服務(wù)器：c）統(tǒng)計服務(wù)器：運用quartz履行準(zhǔn)時任務(wù)，實現(xiàn)終端每日在線數(shù).終端每小時在線數(shù)、終端毎天激活數(shù).終端登錄次數(shù)、消息推送結(jié)果等統(tǒng)計功能。4）數(shù)據(jù)接見層：提供數(shù)據(jù)接見組件，如MysqlJDBC接口.jedis緩存接口。提供第三方推送接口，供第三方云端調(diào)用的API,提供單點推送（明消息/暗消息）、條件（地區(qū)+機型）推送、regid推送。5）數(shù)據(jù)層：Mongodb集群.Mysql數(shù)據(jù)庫（主從+讀寫分別），ActiveMQ消息行列，Redis緩存服務(wù)器。6）WEB層：營運平臺、第三方推送平臺。.多IDC服務(wù)器架構(gòu)圖需要整理2.3.2.系統(tǒng)的物理架構(gòu)設(shè)計1DC1TV端4.子系統(tǒng)定義2.4.1.子系統(tǒng)列表子系統(tǒng)編號子系統(tǒng)名稱（表記）功能描繪開發(fā)方式由超級管理員和營運人員使用，提供第三方菅1營運平臺子系統(tǒng)理、基屁數(shù)據(jù)、消息管理、運維.統(tǒng)計、系統(tǒng)設(shè)自行開發(fā)置、日志査詢等功能。供第三方云端調(diào)用的API,提供單點推送（明消息234567

第三方推送接口子系統(tǒng)/暗消息）、條件（地區(qū)+機型）推送、regid推自行開發(fā)送。給第三方使用，提供開發(fā)者賬號注冊、應(yīng)用管第三方推送平臺子系統(tǒng)理、消息發(fā)布、消息推送結(jié)果查問等功能。自行開發(fā)云端的一個邏輯服務(wù)器，實現(xiàn)從MQ取出消息、推送服務(wù)器子系統(tǒng)解析消息（條件體和消息體）、終端在線和離線自行開發(fā)查問、按各接入服務(wù)器有哪些終端登錄把消息包散發(fā)給接入服務(wù)器。云端的后臺任務(wù)系統(tǒng)，運用quartz履行準(zhǔn)時任后臺任務(wù)子系統(tǒng)務(wù)，實現(xiàn)終端每日在線數(shù)、終端每小時在線數(shù).終自行開發(fā)端每日激活數(shù).終端登錄次數(shù)、消息推送結(jié)果等統(tǒng)計功能。為消息盒子終端提供云端接口，用XMPP協(xié)議。云端與終端接口：分發(fā)提供獲取接入服務(wù)器列表、電視終端獲取唯一標(biāo)服務(wù)器、接入服務(wù)器.終識userid＞以userid登錄認(rèn)證、成立會話及長自行開發(fā)端協(xié)議服務(wù)器連結(jié)、推送消息、反應(yīng)消息接牧和點擊情況、終端應(yīng)用激活上報等協(xié)議。在云端用JGroups技術(shù)組建一個集群，管理各邏云端集群輯服務(wù)器，實現(xiàn)各成員之間的通訊、成員狀態(tài)反自行開發(fā)饋、成員列表維護等功能。注：開發(fā)方式可選：釆購、外包、自行開發(fā)、復(fù)用。2.4.2.子系統(tǒng)間關(guān)系｛裁剪說明：必填｝｛明確子系統(tǒng)之間的調(diào)用關(guān)系、子系統(tǒng)間的接口（消息、數(shù)據(jù)構(gòu)造）以及有關(guān)子系統(tǒng)之間的共同工作，能夠使用構(gòu)造圖、（交互）事務(wù)圖、消息序列圖、ER圖描繪。）3?子系統(tǒng)1設(shè)計｛裁茲說明：必填1｛標(biāo)題上加入子系統(tǒng)的編號及名稱（表記）｝｛“子系統(tǒng)——>模塊"區(qū)分。｝｛目的：1）設(shè)計子系統(tǒng)整體框架：子系統(tǒng)的邏輯構(gòu)造：2）模塊的區(qū)分與依靠關(guān)系定艾、揆塊之間的接口定義、模塊功能定義。｝3.1.任務(wù)概括3.1.1.目標(biāo)｛裁剪說明：可選｝｛說明設(shè)計意圖目標(biāo)（總目標(biāo)、分期目標(biāo)）、作用范囤等。｝3.1.2.需求概括｛裁勢說明：可選｝｛解釋軟件產(chǎn)品將達(dá)成或不達(dá)成的功能（能夠直接描繪也能夠參照有關(guān)文檔）｝2.設(shè)計概括3.2.1.總體拘束.開發(fā)規(guī)范｛裁剪說明：可選。如果已填寫在，此處則略。｝（1）編碼約定｛規(guī)定代碼體系、模塊之間的接口和命名規(guī)則。｝（2）文件約定｛規(guī)定子系統(tǒng)的所有配置.日志等文件命名方式與格式。｝（3）目錄約定｛規(guī)定子系統(tǒng)的目錄構(gòu)造，包括運行目錄.源文件目錄、配置目錄、日志目錄、數(shù)據(jù)目錄等。｝.XX拘束｛裁剪說明：可選。如果已填寫在，此處則略。｝｛列出對軟件設(shè)計有重要影響的系統(tǒng)內(nèi)外部拘束和限制，可選的拘束包括:用戶環(huán)境內(nèi)存或其余資源限制數(shù)據(jù)存儲和散發(fā)需求安全和可靠性需求性能需求測試和可維護性需求｝2.2.子系統(tǒng)外部接口｛裁剪說明：如果第2幸已刪除，這里必填（如果有）。｝｛描繪該軟件子系統(tǒng)與外部實體的接口，包括用戶界面、軟件接口、破件接口和通信接口。｝｛較件子系統(tǒng)的外部實體，包括：操作系統(tǒng)、驅(qū)動程序、皺件、中止、其余較件子系統(tǒng)等。｝｛描繪待開發(fā)較件子系統(tǒng)與外部實體的關(guān)系，能夠使用系統(tǒng)架構(gòu)圖、頂層數(shù)搖流圖.事務(wù)圖等來描繪系統(tǒng)構(gòu)造和交互關(guān)系，并標(biāo)示出外部實體和本系統(tǒng)相互作用的性質(zhì)（比方：消息.庫調(diào)用〉和種類（比方：OS服務(wù).通服氣務(wù)、系統(tǒng)工具等）o｝｛詳盡描繪子系統(tǒng)外部接口的參數(shù)，如：接口名稱調(diào)用方式?傳輸?shù)臄?shù)據(jù)：-哪些數(shù)扌居項-數(shù)據(jù)格式?長度-種類頻皮(實時/批辦理)?數(shù)據(jù)同步體制平臺無關(guān)性按照的標(biāo)準(zhǔn)提供的功能前置條件后置條件｝2.3.設(shè)計方案概括｛裁勢說明：必填。如果在“設(shè)計概括”中已描繪過的部分，可略。｝｛描繪內(nèi)容包括：整個設(shè)計所采用的方法：面向?qū)ο笤O(shè)計仍是構(gòu)造化設(shè)計釆用的系統(tǒng)架構(gòu)：比如MVC架構(gòu).N層架構(gòu)使用的相應(yīng)技術(shù)和工具：比如OMT、Rose、Visio采用的框架技術(shù)的形式使用的設(shè)計模式：層模式、微內(nèi)核模式、代理模式等描繪資源/內(nèi)存分派，F(xiàn)lash資源/文件分派描繪哪些模塊釆用軟件復(fù)用3.子系統(tǒng)架構(gòu)設(shè)計｛裁剪說明：必填｝｛定艾子系統(tǒng)的總體邏輯構(gòu)造，定艾模塊區(qū)分以及模塊之間的依靠關(guān)系。｝｛能夠采用分層構(gòu)造描繪怎樣將子系統(tǒng)分解為模塊。｝｛構(gòu)造描繪能夠使用構(gòu)造圖.層次分解圖.數(shù)據(jù)流圖，并用文字說明相互間的關(guān)系。｝｛舉例，繪制構(gòu)造圖如下:擁有繼承等關(guān)系的類因的可使用UML等工具畫出關(guān)系圖?:如下Pkg丿com?mon,mon,cshare.widget..八eLoginActivltyBaseTabAmon,cshare.httpMyHomeActivityWeiboContentActivityc_______________mon,cshare.dbPostWeiboActlvityMySpaceActivitySearchActivityLogoutActivitycom?mon,mon,cshare.exceptionweiboAandroid3.4.模塊定義3.4.1.模塊列表｛裁剪說明：必填｝｛列舉模塊時，能夠釆用表格方式（編號能夠省略）

。｝模塊編號模塊名稱（表記）

功能簡述開發(fā)方式注：開發(fā)方式可選：釆購、外包/自行開發(fā)/復(fù)用4.2.模塊間關(guān)系｛裁剪說明：必填｝｛明確模塊之間的調(diào)用關(guān)系、模塊間的接口（消息、數(shù)據(jù)構(gòu)造）以及有關(guān)模塊之間的共同工作,如模塊間時序圖，協(xié)作圖，以及系統(tǒng)之間狀態(tài)切換流程圖。｝3.4.3.模塊描繪.模塊1｛標(biāo)題上加入模塊的編號及名稱（表記）｝1）功能描繪｛裁剪說明：必填｝｛說明該模塊具備什么樣的基本功能，以及每個功能之間的相互關(guān)系。｝2）性能描繪｛裁剪說明：必填｝｛說明對模塊的性能要求，包括精度、時間特性和辦理速度。｝3）接口描繪｛裁剪說明：必填｝｛說明與其余模塊的接口，與其余系統(tǒng)或硬件的接口。｝｛關(guān)于接口函數(shù)，能夠釆用以下形式描繪：接D1：形式：輸入：輸出:返回：描繪返回什么。描繪：總體描繪該接口實現(xiàn)的目的。）｛需要明呦的信息包括：（1）輸入項列出模塊毎一個輸入項的特性，包括名稱、表記、數(shù)據(jù)的種類和格式、數(shù)據(jù)值的有效范圍、輸入方式、數(shù)量和頻度、輸入介質(zhì)等；能夠是邏輯層面的輸入項，如：圖片資源、媒體流、網(wǎng)絡(luò)數(shù)據(jù)等，也能夠是詳細(xì)的物理層面的輸入項，如變童1、變量2,等等。（2）輸出項列出模塊每一個輸出項的特性，包括名稱、表記、數(shù)據(jù)的種類和格式，數(shù)據(jù)值的有效范圍、輸出方式、數(shù)量和頻度、輸出介質(zhì)等。｝4）配置描繪｛裁剪說明：可選｝｛說明該模塊