系統(tǒng)概要設(shè)計(jì)文檔

1、系統(tǒng)概要設(shè)計(jì)文檔目錄系統(tǒng)概要設(shè)計(jì)文檔1目錄21引言31.1編寫目的及閱讀建議31.2系統(tǒng)概述31.3文檔概述31.4設(shè)計(jì)原則與設(shè)計(jì)要求32引用文件33設(shè)計(jì)概述43.1功能需求規(guī)定43.2 運(yùn)行環(huán)境44系統(tǒng)體系結(jié)構(gòu)設(shè)計(jì)44.1系統(tǒng)總體設(shè)計(jì)44.1.1概述44.1.2設(shè)計(jì)思想54.1.3基本處理流程64.1.4系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)94.4接口設(shè)計(jì)104.4.1用戶接口104.4.2外部接口104.4.3內(nèi)部接口115運(yùn)行設(shè)計(jì)115.1系統(tǒng)初始化115.2運(yùn)行控制115.3運(yùn)行結(jié)束116系統(tǒng)出錯(cuò)處理設(shè)計(jì)116.1出錯(cuò)信息116.2補(bǔ)救措施127系統(tǒng)維護(hù)設(shè)計(jì)12附錄121引言1.1編寫目的及閱讀建議由前面

2、的需求分析，得出了系統(tǒng)的基本需求，要實(shí)現(xiàn)整個(gè)系統(tǒng)，需要對(duì)用戶的需求進(jìn)行設(shè)計(jì)，概要設(shè)計(jì)主要是利用比較抽象的語言對(duì)整個(gè)系統(tǒng)進(jìn)行概括，確定對(duì)系統(tǒng)的物理配置，確定整個(gè)系統(tǒng)的處理流程和系統(tǒng)的數(shù)據(jù)結(jié)構(gòu)，接口設(shè)計(jì)，實(shí)現(xiàn)對(duì)系統(tǒng)的初步設(shè)計(jì)。目的在于推動(dòng)軟件工程的規(guī)范化，使設(shè)計(jì)人員遵循統(tǒng)一的概要設(shè)計(jì)書寫規(guī)范，節(jié)省制作文檔的時(shí)間，降低系統(tǒng)實(shí)現(xiàn)的風(fēng)險(xiǎn)，做到系統(tǒng)設(shè)計(jì)資料的規(guī)范性與全面性，以利于系統(tǒng)的實(shí)現(xiàn)、測試、維護(hù)、版本升級(jí)等。1.2系統(tǒng)概述本系統(tǒng)為學(xué)生信息管理系統(tǒng)，主要實(shí)現(xiàn)了對(duì)學(xué)生信息的管理，包括添加用戶賬號(hào)，修改用戶信息、刪除用戶信息、修改密碼等功能。1.3文檔概述本文檔為學(xué)生信息管理系統(tǒng)的概要設(shè)計(jì)，主要闡述了學(xué)生

3、信息管理系統(tǒng)的整體結(jié)構(gòu)和設(shè)計(jì)思想。1.4設(shè)計(jì)原則與設(shè)計(jì)要求本系統(tǒng)進(jìn)行概要設(shè)計(jì)的原則： 命名規(guī)則； 模塊獨(dú)立性原則： 數(shù)據(jù)庫設(shè)計(jì)規(guī)則； 系統(tǒng)易操作性要求； 系統(tǒng)可維護(hù)性要求；2引用文件1 張海藩主編，軟件工程導(dǎo)論，清華大學(xué)出版社2 陸麗娜主編，軟件工程，經(jīng)濟(jì)科學(xué)出版社 3 瞿中主編，軟件工程，機(jī)械工業(yè)出版社。3設(shè)計(jì)概述3.1功能需求規(guī)定學(xué)生信息管理系統(tǒng)完成對(duì)學(xué)生信息的管理，包括添加用戶賬號(hào)，修改用戶信息、刪除用戶信息。3.2 運(yùn)行環(huán)境運(yùn)行平臺(tái)： Linux操作系統(tǒng)數(shù)據(jù)庫：MySQL數(shù)據(jù)庫Web服務(wù)器：Tomcat開發(fā)語言：java4系統(tǒng)體系結(jié)構(gòu)設(shè)計(jì)本章分條描述系統(tǒng)體系結(jié)構(gòu)設(shè)計(jì)。如果設(shè)計(jì)的部分或全

4、部依賴于系統(tǒng)狀態(tài)或方式，應(yīng)指明這種依賴關(guān)系。如果設(shè)計(jì)信息在多條中出現(xiàn)，可以只描述一次，而在其他條加以引用。也需指出或引用為理解這些設(shè)計(jì)所需的設(shè)計(jì)約定。注：為簡明起見，本章的描述是把一個(gè)系統(tǒng)直接組織成由硬件配置項(xiàng)(HWCI)、計(jì)算機(jī)軟件配置項(xiàng)(CSCI)、手工操作所組成，但應(yīng)解釋為它涵蓋了把一個(gè)系統(tǒng)組織成子系統(tǒng)，子系統(tǒng)被組織成由HWCI.CSCI、手工操作組成，或其他適當(dāng)變種的情況。4.1系統(tǒng)總體設(shè)計(jì)4.1.1概述4.1.1.1功能描述學(xué)生信息管理系統(tǒng)主要功能包括：學(xué)生信息管理，用戶管理。學(xué)生信息管理主要包括：管理員對(duì)學(xué)生基本信息修改，學(xué)生對(duì)自己信息管理修改。用戶管理主要包括：管理員添加學(xué)生，刪

5、除學(xué)生，修改學(xué)生賬號(hào)密碼。學(xué)生修改自己的密碼4.1.2設(shè)計(jì)思想4.1.2.1系統(tǒng)設(shè)計(jì)說明本系統(tǒng)設(shè)計(jì)的功能模塊管理員的用例圖學(xué)生的用例圖4.1.2.2關(guān)鍵技術(shù)簡要說明本系統(tǒng)設(shè)計(jì)采用的關(guān)鍵技術(shù)和主要算法。項(xiàng)目主體框架介紹Spring MVCSpring 框架提供了構(gòu)建 Web 應(yīng)用程序的全功能 MVC 模塊。使用 Spring 可插入的 MVC 架構(gòu)，可以選擇是使用內(nèi)置的 Spring Web 框架還是 Struts 這樣的 Web 框架。通過策略接口，Spring 框架是高度可配置的，而且包含多種視圖技術(shù)，例如 JavaServer Pages（JSP）技術(shù)、Velocity、Tiles、iTe

6、xt 和 POI。Spring MVC 框架并不知道使用的視圖，所以不會(huì)強(qiáng)迫您只使用 JSP 技術(shù)。Spring MVC 分離了控制器、模型對(duì)象、分派器以及處理程序?qū)ο蟮慕巧@種分離讓它們更容易進(jìn)行定制。4.1.3基本處理流程4.1.3.1系統(tǒng)流程圖管理員添加學(xué)生賬號(hào)：管理員刪除學(xué)生賬號(hào)：管理員修改學(xué)生信息：4.1.4系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)4.1.4.1邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)系統(tǒng)ER圖：數(shù)據(jù)表的說明表序號(hào)表名表的詳細(xì)說明1admin管理員信息表2user賬號(hào)表3student學(xué)生信息表管理員信息表(admin)的定義字段名中文名類型主鍵可空關(guān)聯(lián)表項(xiàng)備注adminid管理員idVarchar(255)否否

7、student.sudentid學(xué)生學(xué)號(hào)ididInt是否表idphone手機(jī)Varchar(255)否是管理員手機(jī)號(hào)mail郵件Varchar(255)否是管理員郵件imagepath圖片所在路徑Varchar(255)否是管理員圖片所在路徑賬號(hào)表(user)的定義字段名中文名類型主鍵可空關(guān)聯(lián)表項(xiàng)備注userid賬號(hào)名Varchar(255)否否student.sudentid學(xué)生學(xué)號(hào)ididInt是否表idpassword密碼Varchar(255)否否賬號(hào)密碼role角色Varchar(255)否否賬號(hào)角色學(xué)生信息表(student)的定義字段名中文名類型主鍵可空關(guān)聯(lián)表項(xiàng)備注id表idI

8、nt是否表idname學(xué)生姓名Varchar(255)否否學(xué)生姓名sex性別Varchar(255)否否學(xué)生性別grade年級(jí)Varchar(255)否否學(xué)生年級(jí)imagepath圖片所在路徑Varchar(255)否否學(xué)生圖片所在路徑studentid學(xué)號(hào)Varchar(255)否否學(xué)號(hào)phone手機(jī)號(hào)Varchar(255)否否學(xué)生手機(jī)號(hào)mail郵件Varchar(255)否否學(xué)生郵件4.4接口設(shè)計(jì)4.4.1用戶接口學(xué)生信息管理系統(tǒng)采用的瀏覽器與服務(wù)器的形式，系統(tǒng)通過網(wǎng)頁的形式為不同身份的用戶提供登錄界面，不同身份的用戶通過自身的身份驗(yàn)證登錄系統(tǒng)，實(shí)現(xiàn)自己權(quán)限范圍內(nèi)的各種操作。4.4.2外

9、部接口學(xué)生信息管理系統(tǒng)，以瀏覽器與服務(wù)器的形式，通過查詢數(shù)據(jù)庫服務(wù)器，查詢相關(guān)信息。并通過鼠標(biāo)、鍵盤、顯示器輸入與輸出相關(guān)信息。4.4.3內(nèi)部接口學(xué)生信息管理系統(tǒng)的內(nèi)部接口有：學(xué)生信息管理、用戶管理、密碼管理5運(yùn)行設(shè)計(jì)5.1系統(tǒng)初始化學(xué)生信息管理系統(tǒng)在初始化階段對(duì)內(nèi)置的管理員賬號(hào)進(jìn)行初始化，包括對(duì)管理員登錄ID初始化，登錄密碼初始化，個(gè)人信息初始化。5.2運(yùn)行控制具體軟件的運(yùn)行模塊組合為多個(gè)瀏覽器并發(fā)交互的運(yùn)行環(huán)境，各個(gè)模塊在軟件運(yùn)行過程中能較好的交換信息，處理數(shù)據(jù)。當(dāng)用戶登錄到系統(tǒng)時(shí)，用戶輸入的數(shù)據(jù)通過瀏覽器傳輸?shù)椒?wù)器端，由后臺(tái)的管理模塊對(duì)輸入進(jìn)行驗(yàn)證，瀏覽器接收服務(wù)器返回的信息，瀏覽器接

10、收服務(wù)器返回的用戶信息，給不同的用戶展示不同的界面。用戶在瀏覽器上對(duì)學(xué)生信息進(jìn)行操作，提交數(shù)據(jù)給服務(wù)器后，服務(wù)器校驗(yàn)數(shù)據(jù)，服務(wù)器返回提交結(jié)果給瀏覽器，是否修改成功。用戶在瀏覽器使用學(xué)生信息管理系統(tǒng)時(shí)，能夠見到漂亮清晰地界面，簡單的操作流程。5.3運(yùn)行結(jié)束用戶退出學(xué)生信息管理系統(tǒng)后，服務(wù)器會(huì)自動(dòng)關(guān)閉與遠(yuǎn)程用戶主機(jī)的連接。6系統(tǒng)出錯(cuò)處理設(shè)計(jì)6.1出錯(cuò)信息錯(cuò)誤類型原因解決辦法數(shù)據(jù)庫連接錯(cuò)誤數(shù)據(jù)庫設(shè)置不正確或SQL Server異常取消本次操作，提醒用戶檢查數(shù)據(jù)庫輸入錯(cuò)誤輸入不規(guī)范通過對(duì)話框，提醒用戶，然后再次操作不可預(yù)知錯(cuò)誤未知異常進(jìn)行數(shù)據(jù)庫備份，幫助開發(fā)者完善程序6.2補(bǔ)救措施我們對(duì)于本程序的幾種

11、可能的錯(cuò)誤進(jìn)行了分析，分別進(jìn)行了不同的處理。主要的錯(cuò)誤可能有：數(shù)據(jù)庫連接錯(cuò)誤：這類錯(cuò)誤主要是數(shù)據(jù)庫設(shè)置不正確，或MYSQL異常引起的，我們只要取消本次操作，提醒用戶檢查數(shù)據(jù)庫問題就可。輸入錯(cuò)誤：這主要是用戶輸入不規(guī)范造成的，我們?cè)诒M量減少用戶出錯(cuò)的條件的情況下，主要也是通過對(duì)話框，提醒用戶，然后再次操作。其他操作錯(cuò)誤：對(duì)于用戶的不正當(dāng)操作，有可能使程序發(fā)生錯(cuò)誤。我們主要是中止操作，并提醒用戶中止的原因和操作的規(guī)范。其他不可預(yù)知的錯(cuò)誤：程序也會(huì)有一些我們無法預(yù)知或沒考慮完全的錯(cuò)誤，我們對(duì)此不可能作出安全的異常處理，這時(shí)我們主要要保證數(shù)據(jù)的安全，所以要經(jīng)常的進(jìn)行數(shù)據(jù)庫備份，并能及時(shí)的和我們聯(lián)系，以逐步的完善我們的程序。7系統(tǒng)維護(hù)設(shè)計(jì)軟件的維護(hù)主要包括數(shù)據(jù)庫的維護(hù)和管理子系統(tǒng)服務(wù)器的維護(hù)。對(duì)于數(shù)據(jù)庫的維護(hù)，需要提供數(shù)據(jù)庫的備份和恢復(fù)功能，方便地實(shí)現(xiàn)數(shù)據(jù)庫的維