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

HUST學(xué)分制教務(wù)管理系統(tǒng)概要設(shè)計(jì)說明書Version1.1文擋編號(hào)hust_gaiyaosheji文擋名稱概要設(shè)計(jì)文檔撰寫人歐高炎審核/批準(zhǔn)創(chuàng)立時(shí)間2008-12-25更改說明版本號(hào)更改時(shí)間更改人更改原因?qū)徟薞ersion1.0Version1.12008-12-27歐高炎參考資料欄的筆誤進(jìn)行了更正目錄1引言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ǔ)救措施131引言1.1編寫目的 為明確HUST學(xué)分制教務(wù)管理系統(tǒng)的系統(tǒng)結(jié)構(gòu)、安排工程規(guī)劃與進(jìn)度、制定詳細(xì)測試方案、組織軟件開發(fā)與測試，特撰寫本文檔。本文檔供工程經(jīng)理、設(shè)計(jì)人員、開發(fā)人員參考。1.2背景開發(fā)軟件名稱：HUST學(xué)分制教務(wù)管理系統(tǒng)工程任務(wù)提出者：華中科技大學(xué)教務(wù)處工程開發(fā)者：ZOWL團(tuán)隊(duì)用戶：華中科技大學(xué)學(xué)生，教務(wù)管理人員實(shí)現(xiàn)軟件單位：ZOWL團(tuán)隊(duì)工程與其他軟件，系統(tǒng)的關(guān)系：該系統(tǒng)需要在學(xué)生成績管理系統(tǒng)，學(xué)生選課系統(tǒng)等已有系統(tǒng)直接復(fù)制數(shù)據(jù)，所以在定義數(shù)據(jù)時(shí)要與已有系統(tǒng)相兼容。本系統(tǒng)采用B/S，效勞器端采用MicrosoftServer2003為操作系統(tǒng)的工作站，是采用MicrosoftSQLServer2005的為開發(fā)軟件的數(shù)據(jù)庫效勞程序。1.3定義SQL：結(jié)構(gòu)化查詢語言，關(guān)系數(shù)據(jù)庫查詢的標(biāo)準(zhǔn)語言；SQLSERVER2005：微軟公司生產(chǎn)的SQLSERVER數(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：《工程方案說明書》汪瑤編號(hào)hust_xuqiuguifan《需求標(biāo)準(zhǔn)說明書》歐高炎2任務(wù)概述2.1目標(biāo)因大量用戶需要使用本系統(tǒng)的前臺(tái)，所以決定采用B/S體系來設(shè)計(jì)本系統(tǒng)。教務(wù)管理人員登錄本系統(tǒng)后，系統(tǒng)列出多有可供使用的功能模塊，主要有八大模塊：學(xué)籍管理、注冊管理、教師信息管理、學(xué)生信息管理、成績管理、課程管理、選課與排課管理、教務(wù)通知管理。教務(wù)管理人員工作時(shí)可以選擇相應(yīng)的功能模塊進(jìn)行快捷方便的教務(wù)管理。學(xué)生隨時(shí)隨地可以利用互聯(lián)網(wǎng)，來進(jìn)行查詢個(gè)人根本信息、成績查詢、注冊狀態(tài)查詢、課表下載，還可以查看教務(wù)人員發(fā)布的教務(wù)通知，方便地了解成績、課程、通知等信息。教師用戶同樣可以隨時(shí)隨地進(jìn)行進(jìn)行教務(wù)通知查看、同時(shí)進(jìn)行成績錄入工作。本系統(tǒng)基于UML建模，概要設(shè)計(jì)應(yīng)輸出用例圖，主要用例的順序圖，系統(tǒng)的主要類圖。2.2運(yùn)行環(huán)境硬件及軟件環(huán)境：1臺(tái)效勞器：PIII1.2G雙CPU，SCSI雙硬盤鏡像，1G以上內(nèi)存，WindowsNT，Apache+JSP+SQLSERVER2005效勞器；客戶機(jī)為普通支持瀏覽器的PC機(jī)；系統(tǒng)運(yùn)行環(huán)境示意圖如下：2.3需求概述旨在開發(fā)一個(gè)統(tǒng)一的網(wǎng)上教務(wù)信息管理平臺(tái)，利用信息化手段輔助教學(xué)管理，到達(dá)提升我校教學(xué)管理信息化水平的目的。教務(wù)管理人員能夠更方便地進(jìn)行教務(wù)管理工作，包括學(xué)籍管理，注冊管理，教師信息管理，學(xué)生信息管理，成績管理，課程管理，選課與排課管理，以及教務(wù)通知管理等；學(xué)生用戶能夠利用該系統(tǒng)進(jìn)行成績查詢，個(gè)人選課操作，查看教務(wù)通知，課表下載等；教師那么能夠進(jìn)行成績錄入，查看教務(wù)通知等。HUST學(xué)分制成績管理系統(tǒng)主要需求列表如下：學(xué)籍管理功能。包括轉(zhuǎn)專業(yè)管理、停學(xué)、休學(xué)、復(fù)學(xué)、退學(xué)、延長學(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)出班級、現(xiàn)轉(zhuǎn)入院系、現(xiàn)轉(zhuǎn)入專業(yè)〕，而停、休、復(fù)、退學(xué)那么內(nèi)容一致〔學(xué)號(hào)、姓名、院系、專業(yè)、停學(xué)時(shí)間、停學(xué)原因、醫(yī)院意見、班主任意見、院系意見、備注〕。注冊管理功能。包括個(gè)人注冊查詢與注冊操作、班級批量注冊查詢與操作。個(gè)人注冊管理時(shí)，只顯示個(gè)人的注冊狀態(tài)及相關(guān)信息；而班級注冊管理時(shí)那么顯示班級各成員的注冊信息列表，能夠支持統(tǒng)一處理。教師信息管理。包括教師信息查詢、修改、添加和刪除。學(xué)生信息管理。包括學(xué)生信息查詢、修改、添加和刪除。成績管理。包括成績錄入、成績報(bào)表〔個(gè)人學(xué)期、學(xué)年、綜合成績報(bào)表；班級學(xué)年加權(quán)、綜合加權(quán)成績表、學(xué)分統(tǒng)計(jì)表；年級加權(quán)成績一覽表〕。各種成績報(bào)表的格式參見《需求標(biāo)準(zhǔn)說明書》。課程管理。包括課程信息查詢、修改、添加和刪除。選課與排課管理。包括班級批量選課、個(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ì)概念和處理流程針對本系統(tǒng)的教務(wù)管理人員、學(xué)生、教師三種不同的角色，系統(tǒng)的處理流程如下列圖所示：圖2.1教務(wù)管理人員登錄時(shí)的系統(tǒng)流程圖圖2.2學(xué)生和教師登錄時(shí)的系統(tǒng)流程圖3.2結(jié)構(gòu)用一覽表及框圖的形式說明本系統(tǒng)的系統(tǒng)元素〔各層模塊、子程序、公用程序等〕的劃分，扼要說明每個(gè)系統(tǒng)元素的標(biāo)識(shí)符和功能，分層次地給出各元素之間的控制與被控制關(guān)系.本系統(tǒng)的體系架構(gòu)如圖3所示：本系統(tǒng)體系結(jié)構(gòu)大致可以定義為：客戶機(jī)層上的表示層主要是通過Struts框架實(shí)現(xiàn)的，由顯示視圖產(chǎn)生一個(gè)請求。請求被ActionServlet〔控制器〕接收，它在struts-config.xml文件中尋找請求的URI，找到對應(yīng)的Action類后，Action類執(zhí)行相應(yīng)的業(yè)務(wù)邏輯。Action類執(zhí)行建立在模型組件根底上的業(yè)務(wù)邏輯，模型組件是和應(yīng)用程序關(guān)聯(lián)的。一旦Action類處理完業(yè)務(wù)邏輯，它把控制權(quán)返回給ActionServlet。，Action類提供一個(gè)鍵值作為返回的一局部，它指明了處理的結(jié)果。ActionServlet使用這個(gè)鍵值來決定在什么視圖中顯示Action的類處理結(jié)果。當(dāng)ActionServlet把Action類的處理結(jié)果傳送到指定的視圖中，請求的過程也就完成了。中間業(yè)務(wù)層是通過Spring框架實(shí)現(xiàn)的，首先建立一個(gè)BaseAction,它繼承了Action類，而其他定義的Action都要繼承這個(gè)BaseAction。這個(gè)BaseAction需要導(dǎo)入AppContext工具類，這個(gè)AppContext需要導(dǎo)入Spring中org.springframework.context.support.*；這樣一個(gè)繼承BaseAction的Action，就可以getXXXService()的方法得到某一個(gè)service的實(shí)例效勞定位器的設(shè)計(jì)模式。持久〔PO〕層是由hibernate架構(gòu)實(shí)現(xiàn)的，它包括關(guān)于整體數(shù)據(jù)庫的hibernate.cfg.xml文件、每個(gè)表的JavaBean類和每個(gè)表的hbm.xml文件，通過Spring集成模板HibernateTemplate提供DAO來使用PO。在Spring的配置文件〔applicationContext.xml〕中配置sessionFactory的bean來管理hibernate。教務(wù)管理員擁有所有功能權(quán)限，學(xué)生和教師所有的功能均為教務(wù)管理員功能的子集。故系統(tǒng)只對管理員的角度進(jìn)行設(shè)計(jì)，學(xué)生和教師模塊可以直接復(fù)用相關(guān)模塊完成其功能。本系統(tǒng)組件圖如圖4所示：3.3功能分配本系統(tǒng)中各功能需求與程序模塊〔組件〕之間的關(guān)系如下列圖所示：功能需求學(xué)籍管理注冊管理教師管理學(xué)生管理成績管理課程管理選課與排課管理教務(wù)通知管理轉(zhuǎn)專業(yè)管理停學(xué)休學(xué)復(fù)學(xué)退學(xué)延長學(xué)習(xí)年限個(gè)人注冊操作班級注冊操作個(gè)人注冊狀態(tài)查詢班級注冊狀態(tài)查詢教師信息查詢教師添加教師修改教師刪除學(xué)生信息查詢學(xué)生添加學(xué)生修改學(xué)生刪除成績錄入個(gè)人成績報(bào)表班級成績報(bào)表年級成績報(bào)表課程信息查詢課程添加課程修改課程刪除課表發(fā)布課表查看班級批量選課個(gè)人選課教務(wù)通知查看教務(wù)通知發(fā)布教務(wù)通知修改教務(wù)通知?jiǎng)h除4接口設(shè)計(jì)4.1用戶接口在用戶界面局部，根據(jù)需求分析的結(jié)果，用戶需要一個(gè)用戶友善界面。在界面設(shè)計(jì)上，應(yīng)做到簡單明了，易于操作，并且要注意到界面的布局，應(yīng)突出的顯示重要以及出錯(cuò)信息?？梢允褂肈reamweaver網(wǎng)頁設(shè)計(jì)工具直接拖曳出美觀、簡介、友善的用戶接口。其中針對教務(wù)管理人員的界面要做到操作簡單，易于管理。在設(shè)計(jì)上采用逐級下拉式菜單方式，但菜單層數(shù)最多不能超過4層。同時(shí)，運(yùn)行出錯(cuò)時(shí)應(yīng)以標(biāo)準(zhǔn)形式給出出錯(cuò)提示?？偟膩碚f，系統(tǒng)的用戶界面應(yīng)作到可靠性、簡單性、易學(xué)習(xí)和使用。4.2外部接口效勞器端程序可DAO〔數(shù)據(jù)訪問對象〕應(yīng)用程序編程接口〔API〕，對SQLSERVER數(shù)據(jù)庫進(jìn)行所有的訪問。效勞器程序上可使用SQLSERVER的對數(shù)據(jù)庫的備分命令，以做到對數(shù)據(jù)的保存。在網(wǎng)絡(luò)軟件接口方面，使用一種無過失的傳輸協(xié)議，采用滑動(dòng)窗口方式對數(shù)據(jù)進(jìn)行網(wǎng)絡(luò)傳輸及接收。4.3內(nèi)部接口教師信息管理模塊。對其他模塊提供對課程的查詢接口。學(xué)生信息管理模塊。對其他模塊提供對學(xué)生信息查詢的接口，包括按學(xué)號(hào)查詢和按姓名查詢和按班級查詢?nèi)N。課程管理模塊。對其他模塊提供對課程信息查詢的接口，包括按課程編號(hào)查詢、按課程名查詢等。5運(yùn)行設(shè)計(jì)5.1運(yùn)行模塊組合客戶機(jī)程序在有輸入時(shí)啟動(dòng)接收數(shù)據(jù)模塊，通過各模塊之間的調(diào)用，讀入并對輸入進(jìn)行格式化。在接收數(shù)據(jù)模塊得到充分的數(shù)據(jù)時(shí)，將調(diào)用網(wǎng)絡(luò)傳輸模塊，將數(shù)據(jù)通過網(wǎng)絡(luò)送到效勞器，并等待接收效勞器返回的信息。接收到返回信息后隨即調(diào)用數(shù)據(jù)輸出模塊，對信息進(jìn)行處理，產(chǎn)生相應(yīng)的輸出。效勞器程序的接收網(wǎng)絡(luò)數(shù)據(jù)模塊必須始終處于活動(dòng)狀態(tài)。接收到數(shù)據(jù)后，調(diào)用數(shù)據(jù)處理/查詢模塊對數(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ù)中心模塊中，需對運(yùn)行控制進(jìn)行正確的判斷，選擇正確的運(yùn)行控制路徑。在網(wǎng)絡(luò)傳方面，客戶機(jī)在發(fā)送數(shù)據(jù)后，將等待效勞器確實(shí)認(rèn)收到信號(hào)，收到后，再次等待效勞器發(fā)送答復(fù)數(shù)據(jù)，然后對數(shù)據(jù)進(jìn)行確認(rèn)。效勞器在接到數(shù)據(jù)后發(fā)送確認(rèn)信號(hào)，在對數(shù)據(jù)處理、訪問數(shù)據(jù)庫后，將返回信息送回客戶機(jī)，并等待確認(rèn)。5.3運(yùn)行時(shí)間在軟體的需求分析中，對運(yùn)行時(shí)間的要求為必須對作出的操作有較快的反響。網(wǎng)絡(luò)硬件對運(yùn)行時(shí)間有最大的影響，當(dāng)網(wǎng)絡(luò)負(fù)載量大時(shí)，對操作反響將受到很大的影響。所以將采用高速ATM網(wǎng)絡(luò)，實(shí)現(xiàn)客戶機(jī)與效勞器之間的連接，以減少網(wǎng)絡(luò)傳輸上的開銷。其次是效勞器的性能，這將影響對數(shù)據(jù)庫訪問時(shí)間即操作時(shí)間的長短，影響加大客戶機(jī)操作的等待時(shí)間，所以必須使用高性能的效勞器。硬件對本系統(tǒng)的速度影響將會(huì)大于軟件的影響。6系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)在《數(shù)據(jù)庫設(shè)計(jì)說明書》進(jìn)行描述。7系統(tǒng)出錯(cuò)處理設(shè)計(jì)7.1出錯(cuò)信息出錯(cuò)名稱系統(tǒng)輸出信息處理方法用戶名輸入錯(cuò)誤“用戶名錯(cuò)！請重新輸入！”進(jìn)入登錄頁面前三次密碼錯(cuò)誤“您的密碼輸入有誤，請重新輸入！”進(jìn)入登錄頁面密碼錯(cuò)數(shù)次數(shù)超過三次“密碼錯(cuò)誤！請半個(gè)小時(shí)后再進(jìn)行登錄操作！”進(jìn)入默認(rèn)登錄頁，并半小時(shí)內(nèi)禁止