1、xxxxx系統詳細設計說明書文件狀態：文件標識： 草稿當前版本： 正式發布作者： 正在修改完成日期：版本歷史版本 / 狀態作者參與者起止日期備注開始編寫修改記錄日期修訂版本修改章節修改描述作者目錄1引言 .錯誤 ! 未定義書簽。編寫目的 .錯誤 ! 未定義書簽。背景 .錯誤 ! 未定義書簽。參考資料 .錯誤 ! 未定義書簽。術語定義及說明 .錯誤 ! 未定義書簽。2設計概述 .錯誤 ! 未定義書簽。任務和目標 .錯誤 ! 未定義書簽。需求概述 .錯誤 ! 未定義書簽。運行環境概述 .錯誤 ! 未定義書簽。條件與限制 .錯誤 ! 未定義書簽。詳細設計方法和工具 .錯誤 ! 未定義書簽。3系統詳細

2、需求分析 .錯誤 ! 未定義書簽。詳細需求分析 .錯誤 ! 未定義書簽。詳細系統運行環境及限制條件分析接口需求分析.錯誤 ! 未定義書簽。4總體方案確認 .錯誤 ! 未定義書簽。系統總體結構確認 .錯誤 ! 未定義書簽。系統詳細界面劃分 .錯誤 ! 未定義書簽。應用系統與支撐系統的詳細界面劃分.錯誤 ! 未定義書簽。系統內部詳細界面劃分 .錯誤 ! 未定義書簽。5系統詳細設計 .錯誤 ! 未定義書簽。系統程序代碼架構設計 .錯誤 ! 未定義書簽。UI(User Interface) 用戶界面表示層 .錯誤 ! 未定義書簽。BLL(Business Logic Layer)業務邏輯層 .錯誤 !

3、 未定義書簽。DAL(Data Access Layer)數據訪問層 .錯誤 ! 未定義書簽。Common類庫 .錯誤 ! 未定義書簽。Entity Class實體類 .錯誤 ! 未定義書簽。系統結構設計及子系統劃分 .錯誤 ! 未定義書簽。系統功能模塊詳細設計 .錯誤 ! 未定義書簽。XX子系統 .錯誤 ! 未定義書簽。.1 XX模塊 .錯誤 ! 未定義書簽。列表和分頁 .錯誤 ! 未定義書簽。創建 XX .錯誤 ! 未定義書簽。.2 XX模塊 .錯誤 ! 未定義書簽。XX列表 .錯誤 ! 未定義書簽。XX修改 .錯誤 ! 未定義書簽。XX子系統 .錯誤 ! 未定義書簽。用戶管理模塊 .錯誤

4、 ! 未定義書簽。角色管理模塊 .錯誤 ! 未定義書簽。系統設置模塊 .錯誤 ! 未定義書簽。系統登錄注銷模塊 .錯誤 ! 未定義書簽。系統界面詳細設計 .錯誤 ! 未定義書簽。外部界面設計 .錯誤 ! 未定義書簽。內部界面設計 .錯誤 ! 未定義書簽。用戶界面設計 .錯誤 ! 未定義書簽。6數據庫系統設計 .錯誤 ! 未定義書簽。設計要求 .錯誤 ! 未定義書簽。信息模型設計 .錯誤 ! 未定義書簽。數據庫設計 .錯誤 ! 未定義書簽。設計依據 .錯誤 ! 未定義書簽。數據庫種類及特點. 錯誤 ! 未定義書簽。數據庫邏輯結構. 錯誤 ! 未定義書簽。物理結構設計 . 錯誤 ! 未定義書簽。數

5、據庫安全 .錯誤 ! 未定義書簽。數據字典 . 錯誤 ! 未定義書簽。7信息編碼設計. 錯誤 ! 未定義書簽。代碼結構設計. 錯誤 ! 未定義書簽。代碼編制.錯誤 ! 未定義書簽。1 引言1.1編寫目的說明編寫詳細設計方案的主要目的。說明書編制的目的是說明一個軟件系統各個層次中的每個程序（每個模塊或子程序）和數據庫系統的設計考慮，為程序員編碼提供依據。如果一個軟件系統比較簡單，層次很少，本文件可以不單獨編寫，和概要設計說明書中不重復部分合并編寫。方案重點是模塊的執行流程和數據庫系統詳細設計的描述。1.2背景應包含以下幾個方面的內容：A. 待開發軟件系統名稱；B. 該系統基本概念， 如該系統的類

6、型、從屬地位等；C. 開發項目組名稱。1.3參考資料列出詳細設計報告引用的文獻或資料，資料的作者、標題、出版單位和出版日期等信息，必要時說明如何得到這些資料。1.4術語定義及說明列出本文檔中用到的可能會引起混淆的專門術語、定義和縮寫詞的原文。2 設計概述2.1任務和目標說明詳細設計的任務及詳細設計所要達到的目標。2.1.1 需求概述對所開發軟件的概要描述 , 包括主要的業務需求、輸入、輸出、主要功能、性能等，尤其需要描述系統性能需求 。2.1.2 運行環境概述對本系統所依賴于運行的硬件，包括操作系統、數據庫系統、中間件、接口軟件、可能的性能監控與分析等軟件環境的描述，及配置要求。2.1.3 條

7、件與限制詳細描述系統所受的內部和外部條件的約束和限制說明。包括業務和技術方面的條件與限制以及進度、管理等方面的限制。2.1.4 詳細設計方法和工具簡要說明詳細設計所采用的方法和使用的工具。如HIPO圖方法、 IDEF（I2DEF）方法、 E R圖，數據流程圖、業務流程圖、選用的CASE工具等，盡量采用標準規范和輔助工具。3 系統詳細需求分析主要對系統級的需求進行分析。首先應對需求分析提出的企業需求進一步確認，并對由于情況變化而帶來的需求變化進行較為詳細的分析。3.1詳細需求分析包括：詳細功能需求分析詳細性能需求分析詳細資源需求分析詳細系統運行環境及限制條件分析3.2詳細系統運行環境及限制條件分

8、析接口需求分析包括：系統接口需求分析現有硬、軟件資源接口需求分析引進硬、軟件資源接口需求分析4 總體方案確認著重解決系統總體結構確認及界面劃分問題。4.1系統總體結構確認對系統組成、邏輯結構及層次進行確認， 對應用系統、支撐系統及各自實現的功能進行確認，細化集成設計及系統工作流程，特別要注意因軟件的引進造成的系統本身結構和公司其他系統的結構變化。包括：系統組成、邏輯結構及層次確認應用系統結構確認支撐系統結構確認系統集成確認系統工作流程確認4.2系統詳細界面劃分4.2.1 應用系統與支撐系統的詳細界面劃分應用系統與支撐系統之間的界面包括系統主服務器與其他服務器的服務范圍及訪問方式，網絡及數據庫對

9、應用系統的支撐方式，全局數據的管理與存取方式等。4.2.2 系統內部詳細界面劃分系統各功能之間的界面包括覆蓋范圍，模塊間功能調用涉及到的系統模塊及方法，全局數據格式，系統性能要求等。5系統詳細設計5.1系統程序代碼架構設計系統采用三層架構模型，將應用系統劃分為用戶界面表示層、業務邏輯層、數據訪問層，以及Entity Class實體類、 Common 類庫組成，各層的關系如下圖所示：5.1.1 UI(User Interface)用戶界面表示層負責與用戶進行交互，顯示、接受數據，與此同時，做一些簡單邏輯處理，如：輸入數據有效性判斷、 顯示各種異常、 處理 Dataset記錄集數據。 它只與 BL

10、L(Business Logic Layer)業務邏輯層、 EntityClass實體類兩個項目發生關聯，可能與Common類庫發生關聯。5.1.2 BLL(Business Logic Layer)業務邏輯層是整個系統的核心，它承擔了所有的邏輯判斷，實現了程序的功能，它是靈活的。BLL層既是調用者，又是被調用者，因此，要適當的進行設計達到解耦的效果。BLL層只關聯 DAL層和實體類，可能關聯 Common類庫。雖然 BLL層被 U層調用，但是 BLL層無需關心 UI層的情況。數據庫中每個表都對應一個 BLL類，為了達到解耦效果， BLL類不能直接調用其他表的 DAL類，可以 BLL類之間相互

11、調用。5.1.3 DAL(Data Access Layer)數據訪問層提供數據訪問的接口，沒有任何邏輯。在接口中對數據庫操作語句進行組合裝配。DAL層一般關聯 Common 類庫中的最底層，最基礎的數據庫類（比如：鏈接數據庫），必須關聯Entity Class實體類項目。 DAL層只是數據庫的管理者，但不是訪問者，不直接與數據庫發生關聯。數據庫中每個表都對應一個 DAL層的接口 (訪問控制 )類。5.1.4 Common類庫用于存放公用的類。最常用的就是數據庫訪問類，比如：鏈接字符串，數據庫引擎類。它直接與數據庫進行機械式的交換，無任何邏輯。5.1.5 Entity Class實體類相當于加

12、強的數據結構，實現了對數據的封裝。數據庫中每個表都對應一個實體類，表的字段就是實體類的屬性，類型一一對應。UI、 BLL、 DAL這三層的交互主要就是通過實體類作為參數，并Return回信息。5.2系統結構設計及子系統劃分根據業務和功能，將系統的邏輯結構劃分為XX子系統、 XX子系等 6個子系統，如下圖所示：XXXXXXXX系統XX管理XX管理XXXXXXXX子系統子系統子系統子系統子系統子系統各個子系統按照功能角度分解，劃分出若干不同的功能模塊，如下面各圖所示：5.3系統功能模塊詳細設計按結構化設計方法，在系統功能逐層分解的基礎上，對系統各功能模塊或子系統進行設計。此為詳細設計的主要部分之一

13、。用層次圖描述系統的總體結構、 功能分解及各個模塊之間的相互調用關系和信息交互， 用IPO圖或其他方法描述各模塊完成的功能。 以上建議采用 HIPO圖進行功能分解與模塊描述， 更高的要求建議采用 IDEF0方法進行功能模型設計。詳細設計應用系統的各個構成模塊完成的功能及其相互之間的關系，用 IPO或結構圖描述各模塊的組成結構、算法、模塊間的接口關系，以及需求、功能和模塊三者之間的交叉參照關系。每個模塊的描述說明可參照以下格式：模塊編號：模塊名稱：輸入：處理：算法描述：輸出：其中處理和算法描述部分主要采用偽碼或具體的程序語言完成。對詳細設計更高的要求建議用IDEF0圖進行各功能模塊的設計。如果對

14、軟件需進行二次開發（包括功能擴展、功能改造、用戶界面改造等），則相應的設計工作應該設立子課題完成。注意： 算法描述主要是說明BLL層的代碼邏輯，UI層只做簡單的輸入驗證和界面顯示功能。5.3.1 XX子系統.1XX模塊列表和分頁創建 XX.2XX模塊XX列表XX修改5.3.2 XX子系統5.3.6.1 用戶管理模塊模塊描述： 管理系統用戶，包括添加用戶并賦予角色、修改用戶資料和角色、刪除用戶。主要功能： 添加用戶、修改用戶、刪除用戶、列表和分頁。5.3.6.1.1列表和分頁1、 流程圖省略2、 輸入項分頁索引頁面傳參數頁面加載時為 13、 輸出項1) 列表詳細記錄；2) 當前頁碼；3) 分頁總

15、數；4) 記錄總數。4、 算法描述系統管理用戶數據量不大，而且該功能使用頻率不高，可以不用優化分頁，直接獲取用戶表全部記錄，建議 UI層使用 gridview 控件，調用GetAllList() 綁定控件，利用gridview 自帶分頁功能，顯示分頁按鈕、當前頁、分頁總數、記錄總數、5.3.6.1.2添加用戶1、 流程圖返回失敗信息返回成功信息輸入用戶資料選擇角色驗證必填項否填寫合規是驗證用戶名是是否存在否加密密碼用戶信息保存至表System_admin_info否是否成功是分拆角色 ID字符串循環字符串數組信息保存至表 Dict_admin_vs_roles操作記錄日志2、 輸入項用戶 ID

16、string必填姓名string必填用戶密碼string必填確認密碼string必填聯系電話stringE-mailstring狀態char用戶角色 IDstring3、 輸出項1) 成功， UI提示添加用戶完成；2) 失敗， UI提示具體信息。4、 算法描述1) 前端 js判斷必填項的輸入和二次密碼是否相同，角色可以不選；2) BLL須驗證必填項，用戶名是唯一的不能重復；3)加密密碼使用(string String, string Key)，Key = "XXXXXXXX"；4) 用戶信息保存至表 System_admin_info ， Add model) ；5)分拆角

17、色 ID字符串并循環字符串數組，信息保存至表Dict_admin_vs_roles ， Add model)。5.3.6.1.3修改用戶1、 流程圖輸入用戶資料選擇角色驗證必填項否填寫合規是加密密碼用戶信息保存至表System_admin_info否是否成功是根據用戶 ID刪除表Dict_admin_vs_roles 記錄返回失敗信息否是否成功是分拆角色 ID字符串循環字符串數組信息保存至表 Dict_admin_vs_roles返回成功信息操作記錄日志2、 輸入項用戶 IDstring頁面傳參數姓名string必填用戶密碼string必填確認密碼string必填聯系電話stringE-mai

18、lstring狀態char用戶角色 IDstring3、 輸出項1) 成功， UI提示修改用戶完成；2) 失敗， UI提示具體信息。4、 算法描述1) 前端 js判斷必填項的輸入和二次密碼是否相同，角色可以不選；2)加密密碼使用Encrypt(string String, string Key)，Key = "LinLiYan"；3) 根據用戶 ID刪除表 Dict_admin_vs_roles 的記錄 DeleteByAdminID(string admin_id) ；4)分拆角色 ID字符串并循環字符串數組，信息保存至該表Add model) 。5.3.6.1.4刪除用

19、戶1、 流程圖列表中點擊刪除按鈕根據用戶 ID刪除表System_admin_info 記錄否是否成功是根據用戶 ID刪除表Dict_admin_vs_roles 記錄返回失敗信息否是否成功是操作記錄日志返回成功信息2、 輸入項用戶 IDstring頁面傳參數3、 輸出項1、 成功， UI提示刪除用戶完成，刷新列表；2、 失敗， UI提示具體信息。3、 算法描述1) 根據用戶 ID刪除表 System_admin_info 的記錄 Delete(string admin_id) ；2) 根據用戶 ID刪除表 Dict_admin_vs_roles 的記錄 DeleteByAdminID(str

20、ing admin_id) 。5.3.6.2 角色管理模塊5.3.6.3 系統設置模塊5.3.6.4 系統登錄注銷模塊5.4系統界面詳細設計系統界面說明應用系統軟件的各種接口。整個系統的其他接口 （如系統硬件接口、 通訊接口等）在相應的部分說明。5.4.1 外部界面設計根據系統界面劃分進行系統外部界面設計，對系統的所有外部接口（包括功能和數據接口）進行設計。5.4.2 內部界面設計設計系統內部各功能模塊間的調用關系和數據接口。5.4.3 用戶界面設計規定人機界面的內容、界面風格、調用方式等，包括所謂的表單設計、報表設計和用戶需要的打印輸出等設計。此部分內容可能比較多。6 數據庫系統設計此數據庫設計可