軟件系統(tǒng)詳細(xì)設(shè)計(jì)說(shuō)明書(shū)

xxxxx系統(tǒng)詳盡設(shè)計(jì)說(shuō)明書(shū)文件狀態(tài)：文件標(biāo)[√]底稿識(shí)：[]正式宣布目前版1.0[]正在改正本：作者：達(dá)成日期：版本歷史版本/狀態(tài)

作者

參加者

起止日期

備注1.0

開(kāi)始編寫(xiě)改正記錄日期校正版改正章改正描繪作者本節(jié)目錄1序言...................................................................1.1編寫(xiě)目的........................................................1.2背景............................................................1.3參照資料........................................................1.4術(shù)語(yǔ)定義及說(shuō)明..................................................2設(shè)計(jì)概括...............................................................2.1任務(wù)和目標(biāo)......................................................需求概括....................................................運(yùn)行環(huán)境概括................................................條件與限制..................................................詳盡設(shè)計(jì)方法和工具..........................................系統(tǒng)詳盡需求分析.......................................................3.1詳盡需求分析....................................................3.2詳盡系統(tǒng)運(yùn)行環(huán)境及限制條件分析接口需求分析......................4整體方案確認(rèn)...........................................................4.1系統(tǒng)整體構(gòu)造確認(rèn)................................................4.2系統(tǒng)詳盡界面區(qū)分................................................4.2.1應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳盡界面區(qū)分............................54.2.2系統(tǒng)內(nèi)部詳盡界面區(qū)分........................................系統(tǒng)詳盡設(shè)計(jì)...........................................................5.1系統(tǒng)程序代碼架構(gòu)設(shè)計(jì)............................................5.1.1UI(UserInterface)用戶(hù)界面表示層............................5.1.2BLL(BusinessLogicLayer)業(yè)務(wù)邏輯層.........................5.1.3DAL(DataAccessLayer)數(shù)據(jù)接見(jiàn)層............................5.1.4Common類(lèi)庫(kù)..................................................5.1.5EntityClass實(shí)體類(lèi)..........................................5.2系統(tǒng)構(gòu)造設(shè)計(jì)及子系統(tǒng)區(qū)分........................................5.3系統(tǒng)功能模塊詳盡設(shè)計(jì)............................................5.3.1XX子系統(tǒng).....................................................1XX模塊..........................................................列表和分頁(yè)........................................................創(chuàng)辦XX.............................................................2XX模塊..........................................................XX列表............................................................XX改正............................................................5.3.2XX子系統(tǒng)....................................................用戶(hù)管理模塊.............................................角色管理模塊.............................................系統(tǒng)設(shè)置模塊.............................................系統(tǒng)登錄注銷(xiāo)模塊.........................................5.4系統(tǒng)界面詳盡設(shè)計(jì)................................................5.4.1外面界面設(shè)計(jì)................................................5.4.2內(nèi)部界面設(shè)計(jì)................................................5.4.3用戶(hù)界面設(shè)計(jì)................................................數(shù)據(jù)庫(kù)系統(tǒng)設(shè)計(jì).........................................................6.1設(shè)計(jì)要求........................................................6.2信息模型設(shè)計(jì)....................................................6.3數(shù)據(jù)庫(kù)設(shè)計(jì)......................................................6.3.1設(shè)計(jì)依照....................................................6.3.2數(shù)據(jù)庫(kù)種類(lèi)及特點(diǎn)............................................6.3.3數(shù)據(jù)庫(kù)邏輯構(gòu)造..............................................6.3.4物理構(gòu)造設(shè)計(jì)................................................6.3.5數(shù)據(jù)庫(kù)安全..................................................6.3.6數(shù)據(jù)詞典....................................................7信息編碼設(shè)計(jì)...........................................................7.1代碼構(gòu)造設(shè)計(jì)....................................................7.2代碼編制........................................................序言1.1編寫(xiě)目的說(shuō)明編寫(xiě)詳盡設(shè)計(jì)方案的主要目的。說(shuō)明書(shū)編制的目的是說(shuō)明一個(gè)軟件系統(tǒng)各個(gè)層次中的每個(gè)程序（每個(gè)模塊或子程序）和數(shù)據(jù)庫(kù)系統(tǒng)的設(shè)計(jì)考慮，為程序員編碼供應(yīng)依照。若是一個(gè)軟件系統(tǒng)比較簡(jiǎn)單，層次很少，本文件能夠不獨(dú)自編寫(xiě)，和綱領(lǐng)設(shè)計(jì)說(shuō)明書(shū)中不重復(fù)部分歸并編寫(xiě)。方案重點(diǎn)是模塊的履行流程和數(shù)據(jù)庫(kù)系統(tǒng)詳盡設(shè)計(jì)的描繪。1.2背景應(yīng)包括以下幾個(gè)方面的內(nèi)容：待開(kāi)發(fā)軟件系統(tǒng)名稱(chēng)；該系統(tǒng)基本見(jiàn)解，如該系統(tǒng)的種類(lèi)、隸屬地位等；開(kāi)發(fā)項(xiàng)目組名稱(chēng)。1.3參照資料列出詳盡設(shè)計(jì)報(bào)告引用的文件或資料，資料的作者、標(biāo)題、初版單位和初版日期等信息，必要時(shí)說(shuō)明怎樣獲取這些資料。1.4術(shù)語(yǔ)定義及說(shuō)明列出本文檔中用到的可能會(huì)惹起混雜的專(zhuān)門(mén)術(shù)語(yǔ)、定義和縮寫(xiě)詞的原文。設(shè)計(jì)概括2.1任務(wù)和目標(biāo)說(shuō)明詳盡設(shè)計(jì)的任務(wù)及詳盡設(shè)計(jì)所要達(dá)到的目標(biāo)。需求概括對(duì)所開(kāi)發(fā)軟件的綱領(lǐng)描繪,包括主要的業(yè)務(wù)需求、輸入、輸出、主要功能、性能等，特別需要描述系統(tǒng)性能需求。運(yùn)行環(huán)境概括對(duì)本系統(tǒng)所依靠于運(yùn)行的硬件，包括操作系統(tǒng)、數(shù)據(jù)庫(kù)系統(tǒng)、中間件、接口軟件、可能的性能監(jiān)控與分析等軟件環(huán)境的描繪，及配置要求。條件與限制詳盡描繪系統(tǒng)所受的內(nèi)部和外面條件的拘束和限制說(shuō)明。包括業(yè)務(wù)和技術(shù)方面的條件與限制以及進(jìn)度、管理等方面的限制。詳盡設(shè)計(jì)方法和工具簡(jiǎn)要說(shuō)明詳盡設(shè)計(jì)所采用的方法和使用的工具。如HIPO圖方法、IDEF（I2DEF）方法、E－R圖，數(shù)據(jù)流程圖、業(yè)務(wù)流程圖、采用的CASE工具等，盡量采用標(biāo)準(zhǔn)規(guī)范和協(xié)助工具。系統(tǒng)詳盡需求分析主要對(duì)系統(tǒng)級(jí)的需求進(jìn)行分析。第一應(yīng)付需求分析提出的公司需求進(jìn)一步確認(rèn)，并對(duì)由于情況變化而帶來(lái)的需求變化進(jìn)行較為詳盡的分析。3.1詳盡需求分析包括：詳盡功能需求分析詳盡性能需求分析詳盡資源需求分析詳盡系統(tǒng)運(yùn)行環(huán)境及限制條件分析3.2詳盡系統(tǒng)運(yùn)行環(huán)境及限制條件分析接口需求分析包括：系統(tǒng)接口需求分析現(xiàn)有硬、軟件資源接口需求分析引進(jìn)硬、軟件資源接口需求分析4整體方案確認(rèn)重視解決系統(tǒng)整體構(gòu)造確認(rèn)及界面區(qū)分問(wèn)題。4.1系統(tǒng)整體構(gòu)造確認(rèn)對(duì)系統(tǒng)組成、邏輯構(gòu)造及層次進(jìn)行確認(rèn)，對(duì)應(yīng)用系統(tǒng)、支撐系統(tǒng)及各自實(shí)現(xiàn)的功能進(jìn)行確認(rèn)，細(xì)化集成設(shè)計(jì)及系統(tǒng)工作流程，特別要注意因軟件的引進(jìn)造成的系統(tǒng)自己構(gòu)造和公司其他系統(tǒng)的構(gòu)造變化。包括：系統(tǒng)組成、邏輯構(gòu)造及層次確認(rèn)應(yīng)用系統(tǒng)構(gòu)造確認(rèn)支撐系統(tǒng)構(gòu)造確認(rèn)系統(tǒng)集成確認(rèn)系統(tǒng)工作流程確認(rèn)4.2系統(tǒng)詳盡界面區(qū)分應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳盡界面區(qū)分應(yīng)用系統(tǒng)與支撐系統(tǒng)之間的界面包括系統(tǒng)主服務(wù)器與其他服務(wù)器的服務(wù)范圍及接見(jiàn)方式，網(wǎng)絡(luò)及數(shù)據(jù)庫(kù)對(duì)應(yīng)用系統(tǒng)的支撐方式，全局?jǐn)?shù)據(jù)的管理與存取方式等。系統(tǒng)內(nèi)部詳盡界面區(qū)分系統(tǒng)各功能之間的界面包括覆蓋范圍，模塊間功能調(diào)用波及到的系統(tǒng)模塊及方法，全局?jǐn)?shù)據(jù)格式，系統(tǒng)性能要求等。5系統(tǒng)詳盡設(shè)計(jì)5.1系統(tǒng)程序代碼架構(gòu)設(shè)計(jì)系統(tǒng)采用三層架構(gòu)模型，將應(yīng)用系統(tǒng)區(qū)分為用戶(hù)界面表示層、業(yè)務(wù)邏輯層、數(shù)據(jù)接見(jiàn)層，以及EntityClass實(shí)體類(lèi)、Common類(lèi)庫(kù)組成，各層的關(guān)系以以下列圖所示：UI(UserInterface)用戶(hù)界面表示層負(fù)責(zé)與用戶(hù)進(jìn)行交互，顯示、接受數(shù)據(jù)，與此同時(shí)，做一些簡(jiǎn)單邏輯辦理，如：輸入數(shù)據(jù)有效性判斷、顯示各樣異樣、辦理Dataset記錄集數(shù)據(jù)。它只與BLL(BusinessLogicLayer)業(yè)務(wù)邏輯層、EntityClass實(shí)體類(lèi)兩個(gè)項(xiàng)目發(fā)生關(guān)系，可能與Common類(lèi)庫(kù)發(fā)生關(guān)系。BLL(BusinessLogicLayer)業(yè)務(wù)邏輯層是整個(gè)系統(tǒng)的中心，它肩負(fù)了全部的邏輯判斷，實(shí)現(xiàn)了程序的功能，它是靈便的。BLL層既是調(diào)用者，又是被調(diào)用者，因此，要適合的進(jìn)行設(shè)計(jì)達(dá)到解耦的收效。BLL層只關(guān)系DAL層和實(shí)體類(lèi)，可能關(guān)系Common類(lèi)庫(kù)。誠(chéng)然BLL層被U層調(diào)用，可是BLL層無(wú)需關(guān)心UI層的情況。數(shù)據(jù)庫(kù)中每個(gè)表都對(duì)應(yīng)一個(gè)BLL類(lèi)，為了達(dá)到解耦收效，BLL類(lèi)不能夠直接調(diào)用其他表的DAL類(lèi)，能夠BLL類(lèi)之間相互調(diào)用。DAL(DataAccessLayer)數(shù)據(jù)接見(jiàn)層供應(yīng)數(shù)據(jù)接見(jiàn)的接口，沒(méi)有任何邏輯。在接口中對(duì)數(shù)據(jù)庫(kù)操作語(yǔ)句進(jìn)行組合裝置。DAL層一般關(guān)系Common類(lèi)庫(kù)中的最基層，最基礎(chǔ)的數(shù)據(jù)庫(kù)類(lèi)（比方：鏈接數(shù)據(jù)庫(kù)），必定關(guān)系EntityClass實(shí)體類(lèi)項(xiàng)目。DAL層可是數(shù)據(jù)庫(kù)的管理者，但不是接見(jiàn)者，不直接與數(shù)據(jù)庫(kù)發(fā)生關(guān)系。數(shù)據(jù)庫(kù)中每個(gè)表都對(duì)應(yīng)一個(gè)DAL層的接口(接見(jiàn)控制)類(lèi)。Common類(lèi)庫(kù)用于寄存公用的類(lèi)。最常用的就是數(shù)據(jù)庫(kù)接見(jiàn)類(lèi)，比方：鏈接字符串，數(shù)據(jù)庫(kù)引擎類(lèi)。它直接與數(shù)據(jù)庫(kù)進(jìn)行機(jī)械式的互換，無(wú)任何邏輯。EntityClass實(shí)體類(lèi)相當(dāng)于加強(qiáng)的數(shù)據(jù)構(gòu)造，實(shí)現(xiàn)了對(duì)數(shù)據(jù)的封裝。數(shù)據(jù)庫(kù)中每個(gè)表都對(duì)應(yīng)一個(gè)實(shí)體類(lèi)，表的字段就是實(shí)體類(lèi)的屬性，種類(lèi)一一對(duì)應(yīng)。UI、BLL、DAL這三層的交互主要就是經(jīng)過(guò)實(shí)體類(lèi)作為參數(shù)，并Return回信息。5.2系統(tǒng)構(gòu)造設(shè)計(jì)及子系統(tǒng)區(qū)分依照業(yè)務(wù)和功能，將系統(tǒng)的邏輯構(gòu)造區(qū)分為XX子系統(tǒng)、XX子系等6個(gè)子系統(tǒng)，以以下列圖所示：XXXXXXXX系統(tǒng)XX管理XX管理XXXXXXXX子系統(tǒng)子系統(tǒng)子系統(tǒng)子系統(tǒng)子系統(tǒng)子系統(tǒng)各個(gè)子系統(tǒng)依照功能角度分解，區(qū)分出若干不相同的功能模塊，以下面各圖所示：5.3系統(tǒng)功能模塊詳盡設(shè)計(jì)按構(gòu)造化設(shè)計(jì)方法，在系統(tǒng)功能逐層分解的基礎(chǔ)上，對(duì)系統(tǒng)各功能模塊或子系統(tǒng)進(jìn)行設(shè)計(jì)。此為詳盡設(shè)計(jì)的主要部分之一。用層次圖描繪系統(tǒng)的整體構(gòu)造、功能分解及各個(gè)模塊之間的相互調(diào)用關(guān)系和信息交互，用IPO圖或其他方法描繪各模塊達(dá)成的功能。以上建議采用HIPO圖進(jìn)行功能分解與模塊描繪，更高的要求建議采用IDEF0方法進(jìn)行功能模型設(shè)計(jì)。詳盡設(shè)計(jì)應(yīng)用系統(tǒng)的各個(gè)組成模塊達(dá)成的功能及其相互之間的關(guān)系，用IPO或構(gòu)造圖描繪各模塊的組成構(gòu)造、算法、模塊間的接口關(guān)系，以及需求、功能和模塊三者之間的交叉參照關(guān)系。每個(gè)模塊的描繪說(shuō)明可參照以下格式：模塊編號(hào)：模塊名稱(chēng)：輸入：辦理：算法描繪：輸出：其中辦理和算法描繪部分主要采用偽碼或詳盡的程序語(yǔ)言達(dá)成。對(duì)詳盡設(shè)計(jì)更高的要求建議用IDEF0圖進(jìn)行各功能模塊的設(shè)計(jì)。若是對(duì)軟件需進(jìn)行二次開(kāi)發(fā)（包括功能擴(kuò)展、功能改造、用戶(hù)界面改造等），則相應(yīng)的設(shè)計(jì)工作應(yīng)當(dāng)建立子課題達(dá)成。注意：算法描繪主若是說(shuō)明BLL層的代碼邏輯，UI層只做簡(jiǎn)單的輸入考證和界面顯示功能。XX子系統(tǒng).1XX模塊列表和分頁(yè)創(chuàng)辦XX.2XX模塊XX列表XX改正XX子系統(tǒng)用戶(hù)管理模塊模塊描繪：管理系統(tǒng)用戶(hù)，包括增添用戶(hù)并賜予角色、改正用戶(hù)資料和角色、刪除用戶(hù)。主要功能：增添用戶(hù)、改正用戶(hù)、刪除用戶(hù)、列表和分頁(yè)。列表和分頁(yè)1、流程圖省略2、輸入項(xiàng)分頁(yè)索引頁(yè)面?zhèn)鲄?shù)頁(yè)面加載時(shí)為13、輸出項(xiàng)列表詳盡記錄；目前頁(yè)碼；分頁(yè)總數(shù)；記錄總數(shù)。4、算法描繪系統(tǒng)管理用戶(hù)數(shù)據(jù)量不大，而且該功能使用頻次不高，能夠不用優(yōu)化分頁(yè)，直接獲取用戶(hù)表全部記錄，建議UI層使用gridview控件，調(diào)用ExamSys.BLL.System_admin_infoGetAllList()綁定控件，利用gridview自帶分頁(yè)功能，顯示分頁(yè)按鈕、目前頁(yè)、分頁(yè)總數(shù)、記錄總數(shù)、增添用戶(hù)1、流程圖輸入用戶(hù)資料選擇角色考證必填項(xiàng)否填寫(xiě)合規(guī)是考證用戶(hù)名是可否存在否加密密碼用戶(hù)信息保留至表System_admin_info返回失敗信息否可否成功是分拆角色I(xiàn)D字符串循環(huán)字符串?dāng)?shù)組信息保留至表Dict_admin_vs_roles返回成功信息操作記錄日志2、輸入項(xiàng)用戶(hù)IDstring必填姓名string必填用戶(hù)密碼string必填確認(rèn)密碼string必填聯(lián)系電話(huà)stringE-mailstring狀態(tài)char用戶(hù)角色I(xiàn)Dstring3、輸出項(xiàng)成功，UI提示增添用戶(hù)達(dá)成；失敗，UI提示詳盡信息。4、算法描繪前端js判斷必填項(xiàng)的輸入和二次密碼可否相同，角色能夠不選；BLL須考證必填項(xiàng)，用戶(hù)名是唯一的不能夠重復(fù)；3)加密密碼使用MD5.Encrypt(stringString,；stringKey)，Key="XXXXXXXX"用戶(hù)信息保留至表System_admin_info，Add(ExamSys.Model.System_admin_infomodel)；5)分拆角色

ID

字符串并循環(huán)字符串?dāng)?shù)組，信息保留至表

Dict_admin_vs_roles

，ExamSys.BLL.Dict_admin_vs_roles

Add(ExamSys.Model.Dict_admin_vs_roles

model)

。改正用戶(hù)1、流程圖輸入用戶(hù)資料選擇角色考證必填項(xiàng)否

填寫(xiě)合規(guī)是加密密碼用戶(hù)信息保留至表System_admin_info否可否成功是依照用戶(hù)ID刪除表Dict_admin_vs_roles記錄返回失敗信息否可否成功是分拆角色I(xiàn)D字符串循環(huán)字符串?dāng)?shù)組信息保留至表Dict_admin_vs_roles返回成功信息操作記錄日志2、輸入項(xiàng)用戶(hù)IDstring頁(yè)面?zhèn)鲄?shù)姓名string必填用戶(hù)密碼string必填確認(rèn)密碼string必填聯(lián)系電話(huà)stringE-mailstring狀態(tài)char用戶(hù)角色I(xiàn)Dstring3、輸出項(xiàng)成功，UI提示改正用戶(hù)達(dá)成；失敗，UI提示詳盡信息。4、算法描繪前端js判斷必填項(xiàng)的輸入和二次密碼可否相同，角色能夠不選；2)加密密碼使用Chukeh.Security.MD5.Encrypt(stringString,stringKey)，Key="LinLiYan"；3)依照用戶(hù)ID刪除表Dict_admin_vs_roles的記錄ExamSys.BLL.Dict_admin_vs_roles分拆角色I(xiàn)D字符串并循環(huán)字符串?dāng)?shù)組，信息保留至該表ExamSys.BLL.Dict_admin_vs_rolesAdd(ExamSys.Model.Dict_admin_vs_rolesmodel)。刪除用戶(hù)1、流程圖列表中點(diǎn)擊刪除按鈕依照用戶(hù)ID刪除表System_admin_info記錄否可否成功是依照用戶(hù)ID刪除表Dict_admin_vs_roles記錄返回失敗信息否可否成功是操作記錄日志返回成功信息2、輸入項(xiàng)用戶(hù)IDstring頁(yè)面?zhèn)鲄?shù)3、輸出項(xiàng)1、成功，UI提示刪除用戶(hù)達(dá)成，刷新列表；2、失敗，UI提示詳盡信息。3、算法描繪1)依據(jù)用戶(hù)ID刪除表System_admin_infoadmin_id)；

的記錄

Delete(string2)依據(jù)用戶(hù)ID刪除表Dict_admin_vs_roles的記錄ExamSys.BLL.Dict_admin_vs_rolesDeleteByAdminID(stringadmin_id)。角色管