業(yè)務(wù)系統(tǒng)軟件概要設(shè)計(jì)說(shuō)明書(shū)

1、<p>　　HSWOKR業(yè)務(wù)系統(tǒng)軟件概要設(shè)計(jì)說(shuō)明書(shū)</p><p>　　制 定： Ben Zhong</p><p><b>　　審 核： </b></p><p><b>　　批 準(zhǔn)：</b></p><p>　　深圳市華域無(wú)線技術(shù)有限公司</p><

2、;p>　　Shenzhen Hojy Wireless Technology Co., Ltd.</p><p><b>　　修訂履歷</b></p><p><b>　　目 錄</b></p><p><b>　　1引言1</b></p><p><b&

3、gt;　　1.1目的1</b></p><p><b>　　1.2范圍1</b></p><p><b>　　1.3定義1</b></p><p>　　1.4參考資料1</p><p>　　2軟件系統(tǒng)狀態(tài)與交互描述1</p><p>　　2.1

4、軟件系統(tǒng)結(jié)構(gòu)和層次結(jié)構(gòu)1</p><p>　　2.2軟件系統(tǒng)原理描述2</p><p>　　2.3軟件系統(tǒng)交互描述2</p><p>　　3軟件系統(tǒng)設(shè)計(jì)3</p><p>　　3.1軟件設(shè)計(jì)概念和原理3</p><p>　　3.2系統(tǒng)模塊設(shè)計(jì)4</p><p><b

5、>　　4接口設(shè)計(jì)7</b></p><p>　　4.1終端通訊接口7</p><p>　　4.2業(yè)務(wù)系統(tǒng)用戶(hù)接口9</p><p>　　5可測(cè)試性設(shè)計(jì)11</p><p>　　6可移植性設(shè)計(jì)11</p><p><b>　　7異常設(shè)計(jì)12</b></

6、p><p>　　7.1軟件系統(tǒng)的異常描述12</p><p>　　7.2軟件系統(tǒng)的風(fēng)險(xiǎn)描述12</p><p><b>　　8其他設(shè)計(jì)12</b></p><p>　　8.1配置設(shè)計(jì)12</p><p>　　8.2數(shù)據(jù)庫(kù)設(shè)計(jì)14</p><p><b&

7、gt;　　9附錄14</b></p><p>　　9.1軟件開(kāi)發(fā)環(huán)境14</p><p>　　9.2軟件生產(chǎn)環(huán)境15</p><p>　　9.3關(guān)鍵點(diǎn)的附錄15</p><p><b>　　引言</b></p><p><b>　　目的</b>&l

8、t;/p><p>　　本設(shè)計(jì)文檔的輸入文檔為《HSWORK解決方案》。它主要的目標(biāo)是細(xì)化系統(tǒng)軟件功能模塊，定義系統(tǒng)軟件架構(gòu)，定義通訊接口，設(shè)計(jì)數(shù)據(jù)庫(kù)結(jié)構(gòu)及相關(guān)運(yùn)行環(huán)境的配置等。</p><p><b>　　范圍</b></p><p>　　本文檔適用于HSWORK項(xiàng)目</p><p>　　本文檔適于開(kāi)發(fā)人員，測(cè)試人員以及后續(xù)

9、開(kāi)發(fā)的設(shè)計(jì)人員</p><p><b>　　定義</b></p><p>　　UE：user equipment 用戶(hù)設(shè)備</p><p>　　HSWORK：華域升級(jí)業(yè)務(wù)系統(tǒng)</p><p>　　OSS：Open Storage Service 阿里巴巴云計(jì)算公司提供的開(kāi)放云存儲(chǔ)服務(wù)</p><p&g

10、t;<b>　　參考資料</b></p><p>　　《13-產(chǎn)品版本管理辦法A_2.pdf》</p><p>　　軟件系統(tǒng)狀態(tài)與交互描述</p><p>　　軟件系統(tǒng)結(jié)構(gòu)和層次結(jié)構(gòu)</p><p>　　圖中HSWORK業(yè)務(wù)系統(tǒng)部分為本文檔設(shè)計(jì)部分。</p><p><b>　　軟件系統(tǒng)

11、原理描述</b></p><p><b>　　1、發(fā)布版本:</b></p><p>　　1,1、制作升級(jí)包，將它放在阿里的云存儲(chǔ)中。</p><p>　　1.2、新增版本信息，配置策略</p><p><b>　　2、查詢(xún)版本信息</b></p><p>　　3

12、、返回當(dāng)前版本信息，如果有更新，則返回升級(jí)包下載地址</p><p><b>　　4、下載升級(jí)包</b></p><p><b>　　5、終端升級(jí)</b></p><p><b>　　軟件系統(tǒng)交互描述</b></p><p><b>　　系統(tǒng)軟件設(shè)計(jì)圖</b&g

13、t;</p><p><b>　　說(shuō)明：</b></p><p>　　界面鏈接請(qǐng)求，view控制器處理請(qǐng)求；</p><p>　　view控制器加載界面內(nèi)容；</p><p>　　view控制器將界面內(nèi)容，返回給瀏覽器；</p><p>　　如遇到界面為Grid，則發(fā)送ajax請(qǐng)求；json控制器

14、負(fù)責(zé)處理ajax數(shù)據(jù)請(qǐng)求；</p><p>　　Json控制器準(zhǔn)備好格式化數(shù)據(jù)；</p><p>　　Json控制器通過(guò)調(diào)用service封裝好的業(yè)務(wù)服務(wù)方法生成所需的json數(shù)據(jù)；</p><p>　　將JSON數(shù)據(jù)返回瀏覽器，瀏覽器將會(huì)通過(guò)jqgrid將數(shù)據(jù)呈現(xiàn)給用戶(hù)；</p><p><b>　　軟件系統(tǒng)設(shè)計(jì)</b>

15、;</p><p><b>　　軟件設(shè)計(jì)概念和原理</b></p><p>　　controller</p><p>　　此包主要用于接受相關(guān)的來(lái)自客戶(hù)端request請(qǐng)求，包括GET，POST，PUT，DELETE，以及ajax數(shù)據(jù)請(qǐng)求</p><p><b>　　domain</b></p

16、><p>　　主要是與數(shù)據(jù)庫(kù)表結(jié)構(gòu)相關(guān)，一個(gè)數(shù)據(jù)庫(kù)實(shí)體表對(duì)應(yīng)一個(gè)類(lèi)</p><p><b>　　json</b></p><p>　　此包提供jqgrid請(qǐng)求所需要的數(shù)據(jù)，通過(guò)json格式</p><p>　　persistence</p><p>　　它是一個(gè)數(shù)據(jù)庫(kù)持久層，往下與數(shù)據(jù)庫(kù)通訊，往上與業(yè)

17、務(wù)層通訊</p><p>　　此層主要是處理SQL，它在XML中進(jìn)行定義</p><p><b>　　service</b></p><p>　　此包主要一個(gè)業(yè)務(wù)接口層或是業(yè)務(wù)接口層，對(duì)外提供業(yè)務(wù)接口與業(yè)務(wù)接口封裝實(shí)現(xiàn)</p><p><b>　　系統(tǒng)模塊設(shè)計(jì)</b></p><

18、p><b>　　基礎(chǔ)數(shù)據(jù)管理模塊</b></p><p><b>　　客戶(hù)代碼維護(hù)</b></p><p><b>　　規(guī)則：兩位數(shù)字組成</b></p><p>　　操作：C（增加）U（修改）R（查詢(xún)）D（刪除）</p><p><b>　　產(chǎn)品名稱(chēng)維護(hù)<

19、;/b></p><p>　　規(guī)則："V" + {產(chǎn)品類(lèi)別} + {產(chǎn)品型號(hào)} + "R" + {[0-9]} + {[0-9]} + "C" + {[0-9]} + {[0-9]} + "S" + {客戶(hù)代碼} </p><p>　　操作：C（增加）U（修改）R（查詢(xún)）D（刪除）</p>

20、<p>　　產(chǎn)品類(lèi)別維護(hù) (class)</p><p><b>　　規(guī)則：</b></p><p>　　1----代表TD類(lèi)</p><p>　　2----代表WCDMA 類(lèi)</p><p>　　3----代表EDGE 類(lèi)</p><p>　　操作：C（增加）U（修改）R（查詢(xún)）D（刪

21、除）</p><p>　　產(chǎn)品型號(hào)維護(hù) (model)</p><p>　　規(guī)則：{產(chǎn)品類(lèi)型} + {[0-9]} + {[0-9]}</p><p>　　操作：C（增加）U（修改）R（查詢(xún)）D（刪除）</p><p>　　產(chǎn)品類(lèi)型維護(hù)(type)</p><p><b>　　規(guī)則：</b><

22、;/p><p>　　1―― 代表TD 智能手機(jī)</p><p>　　2―― 代表WCDMA 智能手機(jī)</p><p>　　3—— 代表USB產(chǎn)品類(lèi)型數(shù)據(jù)卡</p><p>　　5—— 代表USB及UART串口混合類(lèi)型的Module</p><p>　　6—— 代表mini-PCIE 接口類(lèi)型的Module</p>

23、;<p>　　8―― 代表普通手機(jī)</p><p>　　操作：C（增加）U（修改）R（查詢(xún)）D（刪除）</p><p><b>　　軟件版本維護(hù)模塊</b></p><p><b>　　新增版本</b></p><p>　　上傳完整版本文件："V" + {產(chǎn)品類(lèi)別}

24、 + {產(chǎn)品型號(hào)} + "R" + {[0-9]} + {[0-9]} + "C" + {[0-9]} + {[0-9]} + "S" + {客戶(hù)代碼}.zip，此完整版本文件與工具中所用的版本文件不一樣，它是需要可以支持終端自主寫(xiě)flash的。</p><p>　　上傳步長(zhǎng)為1的升級(jí)包文件：update.zip，如當(dāng)前最新的版本為R06,那么此升級(jí)包提

25、供給R05版本；</p><p>　　上傳步長(zhǎng)為2的升級(jí)包文件：update.zip，如當(dāng)前最新的版本為R06,那么此升級(jí)包提供給R04版本；</p><p>　　上傳步長(zhǎng)為3的升級(jí)包文件：update.zip，如當(dāng)前最新的版本為R06,那么此升級(jí)包提供給R03版本；</p><p>　　update.zip文件大小不超過(guò)10M</p><p&g

26、t;<b>　　發(fā)布版本</b></p><p>　　發(fā)布Bata版本：用于測(cè)試</p><p>　　發(fā)布Release版本</p><p><b>　　版本管理</b></p><p>　　維護(hù)歷史版本，針對(duì)Release版本不允許刪除與修改，</p><p><b&

27、gt;　　系統(tǒng)設(shè)置模塊</b></p><p>　　升級(jí)策略配置：控制升級(jí)終端的數(shù)量，指定哪些型號(hào)，哪個(gè)客戶(hù)可以升級(jí)。</p><p><b>　　用戶(hù)維護(hù)</b></p><p><b>　　用戶(hù)名命名規(guī)則：</b></p><p><b>　　1、只能以字母開(kāi)頭</b

28、></p><p><b>　　2、區(qū)分大小寫(xiě)，</b></p><p>　　3、只能由字母與數(shù)字組成</p><p>　　4、用戶(hù)名長(zhǎng)度為6~16</p><p><b>　　角色維護(hù)</b></p><p>　　WebService接口模塊(詳見(jiàn)接口設(shè)計(jì)部分)<

29、;/p><p><b>　　最新版本查詢(xún)</b></p><p>　　HSWORK處理查詢(xún)請(qǐng)求流程</p><p><b>　　UE查詢(xún)版本時(shí)序圖</b></p><p><b>　　終端信息上報(bào)</b></p><p><b>　　升級(jí)包下載&l

30、t;/b></p><p><b>　　接口設(shè)計(jì)</b></p><p><b>　　終端通訊接口</b></p><p><b>　　最新版本查詢(xún)</b></p><p><b>　　請(qǐng)求消息接口：</b></p><p>

31、　　GET /newversion HTTP/1.1 \r\n</p><p>　　Host: update.hojy.com \r\n</p><p>　　Date: Wed, 12 Apr 2011 17:50:00 GMT\r\n</p><p>　　X-HOJY-Version: V1312R01C01S99\r\n</p><p>

32、　　X-HOJY-Authorization: HOJY_c8fdb181845a4ca6b8fec737b3581d76\r\n</p><p>　　X-HOJY-IMEI:12234567890000\r\n</p><p>　　X-HOJY-SN:1234567898888\r\n\r\n</p><p><b>　　注：</b><

33、/p><p>　　X-HOJY-Authorization驗(yàn)證碼計(jì)算方法如下：</p><p>　　"X-HOJY-Authorization: HOJY_" + MD5(MD5(X-HOJY-IMEI + X-HOJY-SN) + “\n” + DATE + “\n” + RequestResource)</p><p><b>　　其中

34、：</b></p><p>　　DATE表示此次操作的時(shí)間</p><p>　　RequestResource表示http請(qǐng)求中的資源，如此樣例中為：/newversion</p><p>　　DATE和RequestResource不能為空</p><p><b>　　響應(yīng)消息接口：</b></p&g

35、t;<p>　　HTTP/1.1 200 OK</p><p>　　Date: Wed, 01 Mar 2011 12:00:00 GMT</p><p>　　Content-Type: application/xml</p><p>　　Content-Length: 302</p><p>　　Connection: clo

36、se</p><p>　　Server:HServer</p><p>　　<?xml version="1.0" encoding="UTF-8"?></p><p>　　<firmwareupdate></p><p>　　<firmware></p>

37、<p>　　<ver> V1312R01C01S99</ver></p><p>　　<num>1</num></p><p>　　<name>firmware name </name></p><p>　　<desc_cn>簡(jiǎn)體中文描述</desc_cn>

38、</p><p>　　<desc_en>firmware release Description</desc_en></p><p>　　<md5>c61ce360a734c018685fbf5e1662c0fd</md5></p><p>　　<size>16787</size></p&

39、gt;<p>　　<level>0</level></p><p>　　<needbackup>0</needbackup></p><p>　　<needrestart>0</needrestart></p><p>　　<downloadurl>http://10.

40、0.0.1/hswork/update.zip</downloadurl></p><p>　　<downloadurl>http://10.0.0.2/hswork/update.zip</downloadurl></p><p>　　</firmware></p><p>　　</firmwareupdate

41、></p><p><b>　　字段說(shuō)明</b></p><p><b>　　注：</b></p><p>　　如無(wú)最新的版本則返回201消息。樣例如下：</p><p>　　HTTP/1.1 201 OK</p><p>　　Date: Wed, 01 Mar 201

42、1 12:00:00 GMT</p><p>　　Content-Length: 0</p><p>　　Connection: close</p><p>　　Server:HServer</p><p><b>　　終端信息上報(bào)</b></p><p><b>　　請(qǐng)求消息接口：&l

43、t;/b></p><p>　　PUT /deviceinfo HTTP/1.00\r\n</p><p>　　Host: update.hojy.com\r\n</p><p>　　Date: Wed, 12 Apr 2011 17:50:00 GMT\r\n</p><p>　　Content-Md5: c8fdb181845a4c

44、a6b8fec737b3581d76\r\n</p><p>　　Content-Type: text/plain\r\n</p><p>　　X-HOJY-Authorization: HOJY_c8fdb181845a4ca6b8fec737b3581d76\r\n</p><p>　　X-HOJY-IMEI:12234567890000\r\n</p&g

45、t;<p>　　X-HOJY_SN:1234567898888\r\n\r\n</p><p><b>　　{$data}</b></p><p><b>　　響應(yīng)消息接口：</b></p><p>　　HTTP/1.1 200 OK</p><p>　　Date: Wed, 01 M

46、ar 2011 12:00:00 GMT</p><p><b>　　升級(jí)包下載</b></p><p><b>　　業(yè)務(wù)系統(tǒng)用戶(hù)接口</b></p><p><b>　　登錄界面</b></p><p><b>　　主體界面</b></p>

47、<p><b>　　新增版本信息</b></p><p><b>　　發(fā)布升級(jí)包</b></p><p><b>　　可測(cè)試性設(shè)計(jì)</b></p><p><b>　　日志輸出</b></p><p>　　private static fina

48、l Logger logger = LoggerFactory.getLogger(AjaxController.class);</p><p>　　logger.debug("Received request to get all users");</p><p>　　目錄：${TOMCAT}/logs</p><p>　　日志文件：catal

49、ina.out</p><p><b>　　可移植性設(shè)計(jì)</b></p><p>　　OSS部分將會(huì)與GOOGLE，亞馬遜API集成</p><p>　　Interface CloudStorageDrive{</p><p>　　// TODO 輸入你的accessId和accessKey</p><

50、;p>　　static String accessId;</p><p>　　static String accessKey;</p><p>　　static String ossEndpoint;</p><p>　　// TODO 輸入你的bucket名稱(chēng)</p><p>　　public static String bucket

51、Name = "hswork";</p><p>　　// TODO 輸入你的object名稱(chēng)</p><p>　　public static String objectName = "update.zip";</p><p><b>　　//上傳文件接口</b></p><p>

52、　　public static void uploadFile()throws Exception{}</p><p>　　public static void deleteFile()throws Exception{}</p><p><b>　　}</b></p><p><b>　　//阿里云存儲(chǔ)服務(wù)</b><

53、;/p><p>　　Class AliOss implements CloudStorageDrive {}</p><p>　　//亞馬遜云存儲(chǔ)服務(wù)</p><p>　　Class AmazonS3Ex implements CloudStorageDrive {}</p><p><b>　　異常設(shè)計(jì)</b

54、></p><p><b>　　軟件系統(tǒng)的異常描述</b></p><p>　　針對(duì)上傳更新包，由于系統(tǒng)限制為最大的升級(jí)步長(zhǎng)，則需要判斷最新版本與基礎(chǔ)版本的步長(zhǎng)是否大于3，如果是，則需要提醒用戶(hù)，異常數(shù)據(jù)。</p><p><b>　　軟件系統(tǒng)的風(fēng)險(xiǎn)描述</b></p><p><b&g

55、t;　　無(wú)。</b></p><p><b>　　其他設(shè)計(jì)</b></p><p><b>　　配置設(shè)計(jì)</b></p><p>　　部署數(shù)據(jù)庫(kù)初始化配置</p><p><b>　　系統(tǒng)數(shù)據(jù)持久層配置</b></p><p><b&g

56、t;　　系統(tǒng)登錄鑒權(quán)配置</b></p><p><b>　　數(shù)據(jù)庫(kù)設(shè)計(jì)</b></p><p><b>　　附錄</b></p><p><b>　　軟件開(kāi)發(fā)環(huán)境</b></p><p>　　開(kāi)發(fā)框架：Spring 3.1.0 + MyBatis + jQuery

57、1.7.2 + jqGrid 4.1.1 + jQuery UI 1.8.19</p><p>　　數(shù)據(jù)庫(kù)：mysql 5.0 +</p><p>　　Web服務(wù)器：tomcat</p><p>　　JDK環(huán)境：jdk7 +</p><p>　　開(kāi)發(fā)環(huán)境：JSP、MYSQL：xampp-win32-1.7.7-VC9.7z</p>

58、<p>　　開(kāi)發(fā)工具：springsource-tool-suite-2.9.1.RELEASE-e3.7.2-win32.zip</p><p><b>　　軟件生產(chǎn)環(huán)境</b></p><p>　　數(shù)據(jù)庫(kù)：mysql 5.0.8 </p><p>　　Web服務(wù)器：CentOS release 5.7 + Tomcat/7.0