概要設(shè)計(jì)文檔最佳實(shí)例

1、HUST 學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)說明書編號(hào) :hust_gaiyaoshejiHUST 學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)說明書Version1.1文擋編號(hào)hust_gaiyaosheji文擋名稱概要設(shè)計(jì)文檔撰寫人歐高炎審核 /批準(zhǔn)創(chuàng)建時(shí)間2008-12-25Page1of13HUST 學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)說明書編號(hào) :hust_gaiyaosheji更改說明版本號(hào)更改時(shí)間更改人更改原因?qū)徟薞ersion1.0Version1.12008-12-27歐高炎參考資料欄的筆誤進(jìn)行了更正Page2of13HUST 學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)說明書編號(hào) :hust_gaiyaosheji目 錄1引

2、言 .41.1編寫目的 .41.2背景 .41.3定義 .41.4參考資料 .42 任務(wù)概述 .52.1目標(biāo) .52.2運(yùn)行環(huán)境 .52.3需求概述 .63總體設(shè)計(jì) .63.1基本設(shè)計(jì)概念和處理流程 .63.2結(jié)構(gòu) .93.3功能分配 .104接口設(shè)計(jì) .114.1用戶接口 .114.2外部接口 .124.3內(nèi)部接口 .125運(yùn)行設(shè)計(jì) .125.1運(yùn)行模塊組合 .125.2運(yùn)行控制 .125.3運(yùn)行時(shí)間 .136系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì) .137系統(tǒng)出錯(cuò)處理設(shè)計(jì) .137.1出錯(cuò)信息 .137.2補(bǔ)救措施 .13Page3of13HUST 學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)文檔編號(hào):hust_gaiyaosh

3、eji1 引言1.1 編寫目的為明確 HUST 學(xué)分制教務(wù)管理系統(tǒng)的系統(tǒng)結(jié)構(gòu)、安排項(xiàng)目規(guī)劃與進(jìn)度、制定詳細(xì)測(cè)試計(jì)劃、組織軟件開發(fā)與測(cè)試，特撰寫本文檔。本文檔供項(xiàng)目經(jīng)理、設(shè)計(jì)人員、開發(fā)人員參考。1.2 背景開發(fā)軟件名稱：HUST 學(xué)分制教務(wù)管理系統(tǒng)項(xiàng)目任務(wù)提出者：華中科技大學(xué)教務(wù)處項(xiàng)目開發(fā)者：ZOWL 團(tuán)隊(duì)用戶：華中科技大學(xué)學(xué)生，教務(wù)管理人員實(shí)現(xiàn)軟件單位：ZOWL 團(tuán)隊(duì)項(xiàng)目與其他軟件，系統(tǒng)的關(guān)系：該系統(tǒng)需要在學(xué)生成績(jī)管理系統(tǒng)， 學(xué)生選課系統(tǒng)等已有系統(tǒng)直接復(fù)制數(shù)據(jù)， 所以在定義數(shù)據(jù)時(shí)要與已有系統(tǒng)相兼容。本系統(tǒng)采用 B/S ，服務(wù)器端采用 Microsoft Server 2003 為操作系統(tǒng)的工作

4、站， 是采用 Microsoft SQL Server 2005 的為開發(fā)軟件的數(shù)據(jù)庫服務(wù)程序。1.3 定義SQL ：結(jié)構(gòu)化查詢語言，關(guān)系數(shù)據(jù)庫查詢的標(biāo)準(zhǔn)語言；SQL SERVER 2005 ：微軟公司生產(chǎn)的SQL SERVER 數(shù)據(jù)庫管理系統(tǒng)；1.4 參考資料華中科技大學(xué)本科學(xué)分制學(xué)籍管理?xiàng)l例華中科技大學(xué)學(xué)分制選課辦法華中科技大學(xué)學(xué)生學(xué)號(hào)編碼管理辦法編號(hào) hust_FSR：可行性研究報(bào)告鎮(zhèn)祎編號(hào)hust_xiangmujihua ：項(xiàng)目計(jì)劃說明書汪瑤編號(hào)hust_xuqiuguifan 需求規(guī)范說明書歐高炎page4of13HUST 學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)文檔編號(hào):hust_gaiyao

5、sheji2 任務(wù)概述2.1 目標(biāo)因大量用戶需要使用本系統(tǒng)的前臺(tái)，所以決定采用B/S 體系來設(shè)計(jì)本系統(tǒng)。教務(wù)管理人員登錄本系統(tǒng)后，系統(tǒng)列出多有可供使用的功能模塊，主要有八大模塊：學(xué)籍管理、 注冊(cè)管理、 教師信息管理、 學(xué)生信息管理、 成績(jī)管理、 課程管理、 選課與排課管理、教務(wù)通知管理。教務(wù)管理人員工作時(shí)可以選擇相應(yīng)的功能模塊進(jìn)行快捷方便的教務(wù)管理。學(xué)生隨時(shí)隨地可以利用互聯(lián)網(wǎng)，來進(jìn)行查詢個(gè)人基本信息、成績(jī)查詢、注冊(cè)狀態(tài)查詢、課表下載，還可以查看教務(wù)人員發(fā)布的教務(wù)通知，方便地了解成績(jī)、課程、通知等信息。教師用戶同樣可以隨時(shí)隨地進(jìn)行進(jìn)行教務(wù)通知查看、同時(shí)進(jìn)行成績(jī)錄入工作。本系統(tǒng)基于UML 建模，概

6、要設(shè)計(jì)應(yīng)輸出用例圖，主要用例的順序圖，系統(tǒng)的主要類圖。2.2 運(yùn)行環(huán)境硬件及軟件環(huán)境：1 臺(tái)服務(wù)器：PIII1.2G雙 CPU ， SCSI 雙硬盤鏡像，1G 以上內(nèi)存，WindowsNT ，Apache+JSP+SQLSERVER 2005 服務(wù)器；客戶機(jī)為普通支持瀏覽器的PC 機(jī)；系統(tǒng)運(yùn)行環(huán)境示意圖如下：用戶終端 1INTERNET用戶終端 2服務(wù)器用戶終端 N數(shù)據(jù)庫圖1 系統(tǒng)環(huán)境示意圖page5of13HUST 學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)文檔編號(hào):hust_gaiyaosheji2.3 需求概述旨在開發(fā)一個(gè)統(tǒng)一的網(wǎng)上教務(wù)信息管理平臺(tái)，利用信息化手段輔助教學(xué)管理，達(dá)到提升我校教學(xué)管理信息化

7、水平的目的。 教務(wù)管理人員能夠更方便地進(jìn)行教務(wù)管理工作， 包括學(xué)籍管理，注冊(cè)管理，教師信息管理，學(xué)生信息管理，成績(jī)管理，課程管理，選課與排課管理，以及教務(wù)通知管理等； 學(xué)生用戶能夠利用該系統(tǒng)進(jìn)行成績(jī)查詢， 個(gè)人選課操作， 查看教務(wù)通知，課表下載等；教師則能夠進(jìn)行成績(jī)錄入，查看教務(wù)通知等。HUST 學(xué)分制成績(jī)管理系統(tǒng)主要需求列表如下：? 學(xué)籍管理功能。包括轉(zhuǎn)專業(yè)管理、停學(xué)、休學(xué)、復(fù)學(xué)、退學(xué)、延長(zhǎng)學(xué)習(xí)年限。在進(jìn)行學(xué)籍管理各子功能的操作時(shí)， 操作界面應(yīng)統(tǒng)一、 直觀。其中轉(zhuǎn)專業(yè)時(shí)應(yīng)包括的信息為（學(xué)號(hào)、轉(zhuǎn)專業(yè)記錄號(hào)、原轉(zhuǎn)出院系、原轉(zhuǎn)出專業(yè)、原轉(zhuǎn)出班級(jí)、現(xiàn)轉(zhuǎn)入院系、現(xiàn)轉(zhuǎn)入專業(yè)），而停、休、復(fù)、退學(xué)則內(nèi)容一

8、致（學(xué)號(hào)、姓名、院系、專業(yè)、停學(xué)時(shí)間、停學(xué)原因、醫(yī)院意見、班主任意見、院系意見、備注） 。? 注冊(cè)管理功能 。包括個(gè)人注冊(cè)查詢與注冊(cè)操作、班級(jí)批量注冊(cè)查詢與操作。個(gè)人注冊(cè)管理時(shí)，只顯示個(gè)人的注冊(cè)狀態(tài)及相關(guān)信息；而班級(jí)注冊(cè)管理時(shí)則顯示班級(jí)各成員的注冊(cè)信息列表，能夠支持統(tǒng)一處理。? 教師信息管理。包括教師信息查詢、修改、添加和刪除。? 學(xué)生信息管理。包括學(xué)生信息查詢、修改、添加和刪除。? 成績(jī)管理。包括成績(jī)錄入、成績(jī)報(bào)表（個(gè)人學(xué)期、學(xué)年、綜合成績(jī)報(bào)表；班級(jí)學(xué)年加權(quán)、綜合加權(quán)成績(jī)表、學(xué)分統(tǒng)計(jì)表；年級(jí)加權(quán)成績(jī)一覽表）。各種成績(jī)報(bào)表的格式參見需求規(guī)范說明書。? 課程管理。包括課程信息查詢、修改、添加和刪

9、除。? 選課與排課管理。包括班級(jí)批量選課、個(gè)人選課；課表導(dǎo)入（上傳）、課表導(dǎo)出（下載） 。不需要提供排課功能，只需要實(shí)現(xiàn)課表文件的導(dǎo)入與導(dǎo)出。即實(shí)現(xiàn)上傳與下載功能。? 教務(wù)通知管理。包括通知查詢、修改、添加和刪除。教務(wù)管理人員進(jìn)行通知修改、添加和刪除。教師和學(xué)生進(jìn)行查看。3 總體設(shè)計(jì)3.1 基本設(shè)計(jì)概念和處理流程針對(duì)本系統(tǒng)的教務(wù)管理人員、學(xué)生、教師三種不同的角色，系統(tǒng)的處理流程如下圖所示：page6of13HUST 學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)文檔編號(hào):hust_gaiyaoshejiHUST 學(xué)分制教務(wù)管理系統(tǒng)教務(wù)管理人員登錄學(xué)籍管理教務(wù)管理員注冊(cè)管理教師信息管理學(xué)生信息管理課程管理成績(jī)管理選

10、課與排課管理教務(wù)通知管理轉(zhuǎn)專業(yè)管理停學(xué)復(fù)學(xué)休學(xué)退學(xué)延長(zhǎng)學(xué)習(xí)年限注冊(cè)狀態(tài)查詢注冊(cè)操作教師信息查詢教師信息修改教師信息添加教師信息刪除學(xué)生信息查詢學(xué)生信息修改學(xué)生信息添加學(xué)生信息刪除課程信息查詢課程信息修改課程信息添加課程信息刪除成績(jī)錄入成績(jī)報(bào)表排課選課教務(wù)通知查看教務(wù)通知發(fā)布教務(wù)通知修改教務(wù)通知?jiǎng)h除學(xué)籍信息相關(guān)信息文件個(gè)人注冊(cè)狀態(tài)查詢批量注冊(cè)狀態(tài)查詢教師信息文件學(xué)生信息文件課程信息文件個(gè)人成績(jī)報(bào)表班級(jí)成績(jī)報(bào)表年級(jí)成績(jī)報(bào)表個(gè)人選課批量選課教務(wù)通知信息文件學(xué)生注冊(cè)信息文件成績(jī)信息文件選課與排課信息文件圖 2.1 教務(wù)管理人員登錄時(shí)的系統(tǒng)流程圖page7of13HUST 學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)文檔

11、編號(hào):hust_gaiyaoshejiHUST學(xué)分制教務(wù)管理系統(tǒng)教師登錄學(xué)生登錄學(xué)生注冊(cè)狀態(tài)查詢學(xué)生注冊(cè)信個(gè)人信息中心息文件學(xué)生信息查詢學(xué)生信息文件課程信息查詢課程信息文件課程管理個(gè)人選課選課信息文課表下載件課表信息文學(xué)期成績(jī)件成績(jī)查看學(xué)年成績(jī)成績(jī)信息文綜合成績(jī)件教務(wù)通知查看教務(wù)通知文件教師信息文教師信息查看件教師成績(jī)錄入所授課程查看教務(wù)通知查看圖 2.2 學(xué)生和教師登錄時(shí)的系統(tǒng)流程圖page8of13HUST 學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)文檔編號(hào):hust_gaiyaosheji3.2 結(jié)構(gòu)用一覽表及框圖的形式說明本系統(tǒng)的系統(tǒng)元素（各層模塊、子程序、公用程序等）的劃分，扼要說明每個(gè)系統(tǒng)元素的標(biāo)

12、識(shí)符和功能，分層次地給出各元素之間的控制與被控制關(guān)系.本系統(tǒng)的體系架構(gòu)如圖3 所示：表示層控制層業(yè)務(wù)層持久層圖 3系統(tǒng)架構(gòu)圖本系統(tǒng)體系結(jié)構(gòu)大致可以定義為：客戶機(jī)層上的表示層主要是通過Struts 框架實(shí)現(xiàn)的，由顯示視圖產(chǎn)生一個(gè)請(qǐng)求。請(qǐng)求被 ActionServlet （控制器）接收，它在struts-config.xml文件中尋找請(qǐng)求的 URI ，找到對(duì)應(yīng)的Action 類后， Action 類執(zhí)行相應(yīng)的業(yè)務(wù)邏輯。Action類執(zhí)行建立在模型組件基礎(chǔ)上的業(yè)務(wù)邏輯，模型組件是和應(yīng)用程序關(guān)聯(lián)的。一旦Action 類處理完業(yè)務(wù)邏輯，它把控制權(quán)返回給ActionServlet 。， Action 類提

13、供一個(gè)鍵值作為返回的一部分，它指明了處理的結(jié)果。ActionServlet 使用這個(gè)鍵值來決定在什么視圖中顯示Action 的類處理結(jié)果。當(dāng) ActionServlet 把 Action 類的處理結(jié)果傳送到指定的視圖中，請(qǐng)求的過程也就完成了。中間業(yè)務(wù)層是通過Spring 框架實(shí)現(xiàn)的，首先建立一個(gè)BaseAction, 它繼承了 Action類，而其他定義的 Action 都要繼承這個(gè) BaseAction 。這個(gè) BaseAction 需要導(dǎo)入 AppContext 工具類，這個(gè) AppContext 需要導(dǎo)入 Spring 中；這樣一個(gè)繼承 BaseAction 的 Action ，就可以

14、getXXXService() 的方法得到某一個(gè) service 的實(shí)例 -服務(wù)定位器的設(shè)計(jì)模式。持久（PO）層是由hibernate 架構(gòu)實(shí)現(xiàn)的，它包括關(guān)于整體數(shù)據(jù)庫的文件、每個(gè)表的JavaBean 類和每個(gè)表的hbm.xml 文件，通過Spring 集成 模 板HibernateTemplate提 供DAO來 使 用PO 。 在Spring的 配 置 文 件page9of13HUST 學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)文檔編號(hào):hust_gaiyaosheji（ applicationContext.xml ）中配置 sessionFactory 的 bean 來管理 hibernate。教務(wù)管理

15、員擁有所有功能權(quán)限，學(xué)生和教師所有的功能均為教務(wù)管理員功能的子集。故系統(tǒng)只對(duì)管理員的角度進(jìn)行設(shè)計(jì)，學(xué)生和教師模塊可以直接復(fù)用相關(guān)模塊完成其功能。本系統(tǒng)組件圖如圖4 所示：用戶登業(yè)務(wù)調(diào)錄度教師管理學(xué)生管成績(jī)管課程管理選課與排學(xué)籍管理注冊(cè)管理理理課管理數(shù)據(jù)鏈接DAO組件持久實(shí)體XML解析器圖4 系統(tǒng)組件圖3.3 功能分配本系統(tǒng)中各功能需求與程序模塊（組件）之間的關(guān)系如下圖所示：教務(wù)通知管理功能需求轉(zhuǎn)專業(yè)管理停學(xué)休學(xué)復(fù)學(xué)退學(xué)延長(zhǎng)學(xué)習(xí)年限個(gè)人注冊(cè)操作班級(jí)注冊(cè)操作個(gè)人注冊(cè)狀態(tài)查詢選課務(wù)教學(xué)籍注冊(cè)教師學(xué)生成績(jī)課程與排知管理管理管理管理管理管理課通管理管理?page 10 of13HUST 學(xué)分制教務(wù)管理系

16、統(tǒng)概要設(shè)計(jì)文檔編號(hào):hust_gaiyaosheji班級(jí)注冊(cè)狀態(tài)查詢教師信息查詢教師添加教師修改教師刪除學(xué)生信息查詢學(xué)生添加學(xué)生修改學(xué)生刪除成績(jī)錄入個(gè)人成績(jī)報(bào)表班級(jí)成績(jī)報(bào)表年級(jí)成績(jī)報(bào)表課程信息查詢課程添加課程修改課程刪除課表發(fā)布課表查看班級(jí)批量選課個(gè)人選課教務(wù)通知查看教務(wù)通知發(fā)布教務(wù)通知修改教務(wù)通知?jiǎng)h除?4 接口設(shè)計(jì)4.1 用戶接口在用戶界面部分，根據(jù)需求分析的結(jié)果，用戶需要一個(gè)用戶友善界面。在界面設(shè)計(jì)上，應(yīng)做到簡(jiǎn)單明了，易于操作，并且要注意到界面的布局，應(yīng)突出的顯示重要以及出錯(cuò)信息。可以使用Dreamweaver 網(wǎng)頁設(shè)計(jì)工具直接拖曳出美觀、簡(jiǎn)介、友善的用戶接口。其中針對(duì)教務(wù)管理人員的界面要

17、做到操作簡(jiǎn)單，易于管理。 在設(shè)計(jì)上采用逐級(jí)下拉式菜單方式，但菜單層數(shù)最多不能超過4 層。同時(shí)，運(yùn)行出錯(cuò)時(shí)應(yīng)以標(biāo)準(zhǔn)形式給出出錯(cuò)提示?？偟膩碚f，系統(tǒng)的用戶界面應(yīng)作到可靠性、簡(jiǎn)單性、易學(xué)習(xí)和使用。page 11 of13HUST 學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)文檔編號(hào):hust_gaiyaosheji4.2 外部接口服務(wù)器端程序可DAO （數(shù)據(jù)訪問對(duì)象）應(yīng)用程序編程接口（API ），對(duì) SQL SERVER數(shù)據(jù)庫進(jìn)行所有的訪問。服務(wù)器程序上可使用SQL SERVER 的對(duì)數(shù)據(jù)庫的備分命令，以做到對(duì)數(shù)據(jù)的保存。在網(wǎng)絡(luò)軟件接口方面，使用一種無差錯(cuò)的傳輸協(xié)議，采用滑動(dòng)窗口方式對(duì)數(shù)據(jù)進(jìn)行網(wǎng)絡(luò)傳輸及接收。4.3

18、內(nèi)部接口? 教師信息管理模塊。對(duì)其他模塊提供對(duì)課程的查詢接口。? 學(xué)生信息管理模塊。對(duì)其他模塊提供對(duì)學(xué)生信息查詢的接口，包括按學(xué)號(hào)查詢和按姓名查詢和按班級(jí)查詢?nèi)N。? 課程管理模塊。對(duì)其他模塊提供對(duì)課程信息查詢的接口，包括按課程編號(hào)查詢、按課程名查詢等。5 運(yùn)行設(shè)計(jì)5.1 運(yùn)行模塊組合客戶機(jī)程序在有輸入時(shí)啟動(dòng)接收數(shù)據(jù)模塊，通過各模塊之間的調(diào)用，讀入并對(duì)輸入進(jìn)行格式化。 在接收數(shù)據(jù)模塊得到充分的數(shù)據(jù)時(shí)，將調(diào)用網(wǎng)絡(luò)傳輸模塊，將數(shù)據(jù)通過網(wǎng)絡(luò)送到服務(wù)器， 并等待接收服務(wù)器返回的信息。接收到返回信息后隨即調(diào)用數(shù)據(jù)輸出模塊，對(duì)信息進(jìn)行處理，產(chǎn)生相應(yīng)的輸出。服務(wù)器程序的接收網(wǎng)絡(luò)數(shù)據(jù)模塊必須始終處于活動(dòng)狀態(tài)。接收到數(shù)據(jù)后， 調(diào)用數(shù)據(jù)處理/ 查詢模塊對(duì)數(shù)據(jù)庫進(jìn)行訪問，完成后調(diào)用網(wǎng)絡(luò)發(fā)送模塊，將信息返回客戶機(jī)。5.2 運(yùn)行控制運(yùn)行控制將嚴(yán)格按照各模塊間函數(shù)調(diào)用關(guān)系來實(shí)現(xiàn)。在各事務(wù)中心模塊中，需對(duì)運(yùn)行控制進(jìn)行正確的判斷，選擇正確的運(yùn)行控制路徑。在網(wǎng)絡(luò)傳方面，客戶機(jī)在發(fā)送數(shù)據(jù)后，將等待服務(wù)器的確認(rèn)收到信號(hào)，收到后，再次等待服務(wù)器發(fā)送回答數(shù)據(jù)， 然后對(duì)數(shù)據(jù)進(jìn)行確認(rèn)。 服務(wù)器在接到數(shù)據(jù)后發(fā)送確認(rèn)信號(hào)， 在對(duì)數(shù)據(jù)處理、訪問數(shù)據(jù)庫后，將返回信息送回客戶機(jī)，并等待確認(rèn)。page 12 of13HUST 學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)文檔編號(hào):hust_gaiyaosheji5.3 運(yùn)行時(shí)間在軟體的需求分析中， 對(duì)