軟件詳細(xì)設(shè)計(jì)說(shuō)明書(shū)(例)

1、案卷號(hào)00001日期軟件詳細(xì)設(shè)計(jì)說(shuō)明書(shū)（例）作者：完成日期：簽 收 人：簽收日期：修改情況記錄：版本號(hào)修改批準(zhǔn)人修改人安裝日期簽收人1 / 42目錄1引言 .31.1編寫(xiě)目的 .31.2范圍 .41.3定義 .41.4參考資料 .42總體設(shè)計(jì) .52.1需求規(guī)定 .52.2運(yùn)行環(huán)境 .52.3基本設(shè)計(jì)概念和處理流程.62.4結(jié)構(gòu) .82.5功能需求與程序的關(guān)系 .112.6人工處理過(guò)程 .132.7尚未解決的問(wèn)題 .133接口設(shè)計(jì) .133.1用戶接口 .133.2外部接口 .143.3內(nèi)部接口 .144運(yùn)行設(shè)計(jì) .184.1運(yùn)行模塊組合 .184.2運(yùn)行控制 .184.3運(yùn)行時(shí)間 .185系

2、統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì) .195.1邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn) .195.2物理結(jié)構(gòu)設(shè)計(jì)要點(diǎn) .15.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系 .46系統(tǒng)出錯(cuò)處理設(shè)計(jì) .46.1出錯(cuò)信息 .46.2補(bǔ)救措施 .56.3系統(tǒng)維護(hù)設(shè)計(jì) .52 / 421 引言1.1 編寫(xiě)目的隨著證券交易電子化程度的不斷提高， 券商對(duì)于各種業(yè)務(wù)提出了新的要求， 為了滿足券商的發(fā)展需求，更好的為客戶提供服務(wù)，現(xiàn)結(jié)合原有各版本的證券交易軟件的優(yōu)點(diǎn)和特點(diǎn)，開(kāi)發(fā)一套采用client/server 結(jié)構(gòu)的證券交易軟件管理系統(tǒng)（sql 版）。本系統(tǒng)從底層予以優(yōu)化，使整個(gè)系統(tǒng)的運(yùn)行速度得到較大提高， 通過(guò)重新優(yōu)化數(shù)據(jù)庫(kù)內(nèi)部結(jié)構(gòu)， 使系統(tǒng)的可擴(kuò)充性得到極大提高。本說(shuō)

3、明書(shū)給出 sql 版證券交易系統(tǒng)的設(shè)計(jì)說(shuō)明， 包括最終實(shí)現(xiàn)的軟件必須滿足的功能、性能、接口和用戶界面、附屬工具程序的功能以及設(shè)計(jì)約束等。目的在于：為編碼人員提供依據(jù)；為修改、維護(hù)提供條件；項(xiàng)目負(fù)責(zé)人將按計(jì)劃書(shū)的要求布置和控制開(kāi)發(fā)工作全過(guò)程；項(xiàng)目質(zhì)量保證組將按此計(jì)劃書(shū)做階段性和總結(jié)性的質(zhì)量驗(yàn)證和確認(rèn)。本說(shuō)明書(shū)的預(yù)期讀者包括：項(xiàng)目開(kāi)發(fā)人員，特別是編碼人員；軟件維護(hù)人員；技術(shù)管理人員；執(zhí)行軟件質(zhì)量保證計(jì)劃的專門人員；參與本項(xiàng)目開(kāi)發(fā)進(jìn)程各階段驗(yàn)證、確認(rèn)以及負(fù)責(zé)為最后項(xiàng)目驗(yàn)收、鑒定提供相應(yīng)報(bào)告的有關(guān)人員。合作各方有關(guān)部門的復(fù)雜人；項(xiàng)目負(fù)責(zé)人和全體參加人員。3 / 421.2 范圍說(shuō)明：a待開(kāi)發(fā)的軟件系統(tǒng)

4、的名稱：模擬股票交易系統(tǒng)b列出本項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶以及將運(yùn)行該項(xiàng)軟件的單位。1.3 定義列出本文件中用到的專門術(shù)語(yǔ)的定義和縮寫(xiě)詞的原詞組。本報(bào)告用到的術(shù)語(yǔ)符合國(guó)家標(biāo)準(zhǔn)軟件工程術(shù)語(yǔ)（gb/t11475-1995 ）。1.4 參考資料列出要用到的參考資料，如：a本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)或合同、上級(jí)機(jī)關(guān)的批文；b 屬于本項(xiàng)目的其他已發(fā)表的文件；c本文件中各處引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號(hào)、 發(fā)表日期和出版單位，說(shuō)明能夠得到這些文件資料的來(lái)源。4 / 422 總體設(shè)計(jì)2.1 需求規(guī)定說(shuō)明對(duì)本系統(tǒng)的主要的輸入輸出項(xiàng)目、處理的功能性能要求，詳細(xì)的說(shuō)

5、明可參見(jiàn)需求分析說(shuō)明書(shū)。2.2 運(yùn)行環(huán)境簡(jiǎn)要地說(shuō)明對(duì)本系統(tǒng)的運(yùn)行環(huán)境（包括硬件環(huán)境和支持環(huán)境）的規(guī)定，詳細(xì)說(shuō)明參見(jiàn) 需求分析說(shuō)明書(shū) 。數(shù)據(jù)庫(kù)服務(wù)器奔騰 pro內(nèi)存 128mb以上硬盤 9gb100m 網(wǎng)卡應(yīng)用服務(wù)器奔騰 pro內(nèi)存 64mb以上硬盤 4gb100m 網(wǎng)卡網(wǎng)絡(luò)配置100m / 10m工作站 ( 柜臺(tái) )p100 以上內(nèi)存 8mb以上硬盤 1g 以上100m/10m網(wǎng)卡軟件5 / 42操作系統(tǒng)windows nt 4.0以上數(shù)據(jù)庫(kù)管理系統(tǒng)sql server 2005相關(guān)軟件工具windows nt workstation/windows nt serverwindows 2000

6、 professional/ server開(kāi)發(fā)工具平臺(tái)： windows95/98 、 windows nt、 windows 2000開(kāi)發(fā)工具： visual stidio 2005 sp1,c#.net測(cè)試環(huán)境windows31 、windows95/98 、 windows nt、 windows 20002.3 基本設(shè)計(jì)概念和處理流程說(shuō)明本系統(tǒng)的基本設(shè)計(jì)概念和處理流程，盡量使用圖表的形式。營(yíng)業(yè)部系統(tǒng)一共有四個(gè)對(duì)象，即客戶、 員工、市場(chǎng)和銀行， 市場(chǎng)的概念是交易所的細(xì)化，比如上海證券交易所的股和股就是兩個(gè)市場(chǎng)，有了市場(chǎng)的概念我們就可以把交易所這個(gè)概念細(xì)化， 并使同一個(gè)市場(chǎng)的共性更突出。銀

7、行則通過(guò)銀證轉(zhuǎn)賬業(yè)務(wù)介入，并成為營(yíng)業(yè)部系統(tǒng)不可或缺的組成部分。上述四個(gè)對(duì)象通過(guò)一些業(yè)務(wù)流程進(jìn)行相互操作從而形成整個(gè)交易活動(dòng)。因此整個(gè)系統(tǒng)模6 / 42型可以表述為圖2-1設(shè)計(jì)時(shí)需要將營(yíng)業(yè)部系統(tǒng)所使用的各種信息分為描述四個(gè)對(duì)象的信息和描述業(yè)務(wù)流程的信息。 由于四個(gè)對(duì)象相對(duì)而言是一種穩(wěn)定型信息，而業(yè)務(wù)流程則較易變化，且營(yíng)業(yè)部之間差異很大， 因此應(yīng)將四個(gè)對(duì)象盡量定型，而將各種業(yè)務(wù)流程盡可能做成組件，以便營(yíng)業(yè)部可根據(jù)實(shí)際需求組裝成適合自己的系統(tǒng)。根據(jù)以上思想，在設(shè)計(jì)對(duì)象模型時(shí)應(yīng)充分考慮到可擴(kuò)展性，盡量做到抽象化、參數(shù)化，從而使對(duì)象需求變化時(shí)不致影響系統(tǒng)結(jié)構(gòu)。7 / 42圖 2.12.4 結(jié)構(gòu)用一覽表及

8、框圖的形式說(shuō)明本系統(tǒng)的系統(tǒng)元素（各層模塊、子程序、公用程序等）的劃分，扼要說(shuō)明每個(gè)系統(tǒng)元素的標(biāo)識(shí)符和功能，分層次地給出各元素之間的控制與被控制關(guān)系。本系統(tǒng)采用c/s 模式的 3 層結(jié)構(gòu)按照不同會(huì)話來(lái)劃分的話可以分為3 大系統(tǒng)模塊8 / 42委托服務(wù)系統(tǒng)監(jiān)控接口處理子系統(tǒng)系統(tǒng)維護(hù)子系統(tǒng)數(shù)據(jù)轉(zhuǎn)換數(shù)據(jù)庫(kù)日終管理銀證轉(zhuǎn)賬局域網(wǎng)系統(tǒng)管理資金管理柜臺(tái)管理報(bào)表管理查詢管理圖 2-2 交易系統(tǒng)體系結(jié)構(gòu)客戶端登陸模塊：9 / 42最關(guān)鍵的交易系統(tǒng)模塊結(jié)構(gòu)圖如下：10 / 42pi/pctcheckusermoneycount （ stockdata）or checkuserstockcount要通過(guò)數(shù)據(jù)訪問(wèn)層來(lái)

9、訪問(wèn)用戶表在撮合隊(duì)列中處理并且返回處理結(jié)果tradeinqueue（stockdatanewstockdata ）successunsuccessupdateuserinfo（stockdata ）updatedelegate通過(guò)調(diào)用 adoinfo （stockdat層工廠來(lái)訪問(wèn)a）不同的數(shù)據(jù)庫(kù)同左更新的是（更新用戶表委托臨時(shí)表）buystocksellstockquotestockcanseldelegaterules/model規(guī)范買賣指令傳輸?shù)臄?shù)據(jù)結(jié)adofactory通過(guò)該模塊可動(dòng)態(tài)建立不同數(shù)據(jù)庫(kù)的連接 orical、sqlserver，access數(shù)據(jù)訪問(wèn)層 accessacces

10、s.postdate(stockdata)將數(shù)據(jù)更新到數(shù)據(jù)庫(kù)數(shù)據(jù)訪問(wèn)層 sqlserversqlserver。postdate（ stockdata）構(gòu)必須是stockdata形式check11 / 42股票信息發(fā)布經(jīng)過(guò)修改我認(rèn)為每次由客戶端每5 秒去查詢一次服務(wù)器更新信息不可取，因?yàn)檫@會(huì)加重服務(wù)端和客戶端的負(fù)擔(dān)，特別是服務(wù)器端的運(yùn)算。修改后實(shí)現(xiàn)變更為：用戶一開(kāi)始登陸后獲得一次服務(wù)器的全部股票當(dāng)前信息。而服務(wù)器端每次發(fā)生交易后，給每一個(gè)在線用戶發(fā)送當(dāng)前交易需要更新的股票信息，這樣就減輕了客戶機(jī)和服務(wù)端的信息客戶端第一次登陸發(fā)送請(qǐng)求獲得所有股票信息，并畫(huà)分時(shí)線圖stock idstock pri

11、cetcp/ip服務(wù)器每次交易返回最新信息12 / 422.5 功能需求與程序的關(guān)系（該關(guān)系由需求分析報(bào)告編寫(xiě)者根據(jù)結(jié)構(gòu)圖說(shuō)明）本條用一張如下的矩陣圖說(shuō)明各項(xiàng)功能需求的實(shí)現(xiàn)同各塊程序的分配關(guān)系：獲取并發(fā)送繪制分時(shí)md5 加密發(fā)送用戶接受并識(shí)別調(diào)用數(shù)據(jù)層撮合交易服務(wù)器返回用戶請(qǐng)求圖解密交易請(qǐng)求用戶請(qǐng)求查詢客戶端信息用戶登陸查看用戶持倉(cāng)實(shí)時(shí)指數(shù)交易委托取消交易2.6 人工處理過(guò)程說(shuō)明在本軟件系統(tǒng)的工作過(guò)程中不得不包含的人工處理過(guò)程（如果有的話）。沒(méi)有完成股票管理的模塊設(shè)計(jì)，所以股票必須從數(shù)據(jù)庫(kù)后臺(tái)添加如果有新股發(fā)行，還必須添加有關(guān)股票的交易隊(duì)列2.7 尚未解決的問(wèn)題說(shuō)明在概要設(shè)計(jì)過(guò)程中尚未解決而設(shè)

12、計(jì)者認(rèn)為在系統(tǒng)完成之前必須解決的各個(gè)問(wèn)題。3 接口設(shè)計(jì)3.1 用戶接口說(shuō)明將向用戶提供的命令和它們的語(yǔ)法結(jié)構(gòu)，以及軟件的回答信息。13 / 42向用戶提供簡(jiǎn)單易用的ui ，以及幫助文檔。客戶端將提供以下功能首先彈出用戶登陸框，供用戶輸入用戶名和密碼菜單項(xiàng)提供個(gè)股查詢和分時(shí)圖按鈕菜單欄下是選項(xiàng)卡，提供股票實(shí)時(shí)信息和個(gè)股分時(shí)圖欄提供用戶交易界面和交易按鈕以及查看用戶盈虧按鍵3.2 外部接口說(shuō)明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(tǒng)與各支持軟件之間的接口關(guān)系。采用基于正確公開(kāi)標(biāo)準(zhǔn)的部件和技術(shù)以確保最大限度的協(xié)作能力以及與第三方系統(tǒng)與部件集成的簡(jiǎn)便性。這類標(biāo)準(zhǔn)包括但不限于以下幾種

13、：網(wǎng)絡(luò)協(xié)議與標(biāo)準(zhǔn)(tcp/ip, http, ssl, etc)語(yǔ)言 (sql, c#.net, etc.)數(shù)據(jù)庫(kù)連接性 (ado。 net)3.3 內(nèi)部接口說(shuō)明本系統(tǒng)之內(nèi)的各個(gè)系統(tǒng)元素之間的接口的安排。邏輯層和數(shù)據(jù)訪問(wèn)層通過(guò)以經(jīng)的stockdatamodel 接口，來(lái)限定訪問(wèn)stockdata 類型的數(shù)14 / 42據(jù)客戶端通過(guò)調(diào)用buystock（ stockdata）和 sellstock（ stockdata）來(lái)訪問(wèn)邏輯層，在這個(gè)函數(shù)中包含了訪問(wèn)邏輯層的接口dealtransaction(stockdata)通過(guò) adofactory 訪問(wèn)不同的數(shù)據(jù)庫(kù)客戶端登陸協(xié)議d( 二字節(jié) )+(

14、 客戶名字長(zhǎng)度 )(4 字節(jié) )+( 客戶名字 )+( 客戶密碼長(zhǎng)度 )(4 字節(jié) )+(客戶密碼 ); 客戶買賣協(xié)議b( 二字節(jié) )+( 股票 id)(4 字節(jié) )+( 股票數(shù)量 )(4 字節(jié) )s(二字節(jié) )+( 股票 id)(4 字節(jié) )+( 股票數(shù)量 )(4 字節(jié) )查詢交易信息并返回給客戶端c(二字節(jié) )具體有拆包解包的類using system;using system.collections.generic;using system.text;namespace projectcentertradingsyspublicclassprotocalprivatebyte messa

15、gebuffer;privatebyte messagelength;publicbyte messagebag;/ 該函數(shù)是將字符串轉(zhuǎn)換為字節(jié)數(shù)組publicbyte stringtobyte(stringstringinfo)15 / 42messagebuffer = system.text.asciiencoding .ascii.getbytes(stringinfo);returnmessagebuffer;/ 該函數(shù)將整型轉(zhuǎn)換為個(gè)字節(jié)publicbyte inttobyte(intnumber)messagelength=bitconverter.getbytes(number)

16、;returnmessagelength;/ 將浮點(diǎn)型轉(zhuǎn)換為個(gè)字節(jié)publicbyte doubletobyte(double price)byte pricebyte =bitconverter.getbytes(price);returnpricebyte;/ 合并一個(gè)字符串（字節(jié)數(shù)組）和他的長(zhǎng)度作為一個(gè)包publicbyte combinarray(byte messle,byte messinfo)messagebag=new byte messle.length+messinfo.length;intindex;for(index = 0; index messle.length;

17、index+)messagebagindex = messagelengthindex;for( intindex1 = 0; index1 newlist.price， 利 用 插 入 排 序 將newlist插入到買隊(duì)列 buyqueue中，轉(zhuǎn) 1；3.)ifsellqueue0.countnewlist.count，newlist完全撮合，sellqueue0.countsellqueue0.count27 / 42newlist.count，轉(zhuǎn) 2；4.)if sellqueue0.count=newlist.count， sellqueue0撮合 ， 并 將 sellqueue0從 sellqueue 隊(duì) 列 中 刪 除 ，newlist.count=newlist.count-sellqueue0.count，轉(zhuǎn) 2；5.)取買單隊(duì)列頭buyqueue0，ifbuyqueue0.pricenewlist.count，newlist完全撮合，buyqueue0.count buyqueue0.count newlist.count