【正文】 概要設計說明書1．導言 目的本文檔的目旨在推動軟件工程的規(guī)范化，對本系統(tǒng)的業(yè)務流程、軟件架構(gòu)、功能模塊設計、數(shù)據(jù)庫設計、接口設計等做了分析和說明，使設計人員遵循統(tǒng)一的軟件設計規(guī)范，降低系統(tǒng)實現(xiàn)的風險，做到系統(tǒng)設計文檔的規(guī)范性與全面性，以利于整個系統(tǒng)的實現(xiàn)、測試、維護等。 范圍本文檔用于軟件設計階段的概要設計，它的依據(jù)的基線是《需求分析規(guī)格書》，它的下游是《詳細設計說明書》，并為《詳細設計說明書》提供測試的依據(jù)。軟件概要設計的范圍是：軟件系統(tǒng)業(yè)務流程分析、總體結(jié)構(gòu)設計、全局數(shù)據(jù)庫和數(shù)據(jù)結(jié)構(gòu)設計、外部接口設計、主要部件功能分配設計、部件之間的接口設計等方面的內(nèi)容。該范圍應覆蓋《需求規(guī)格說明書》中的功能點列表、性能點列表。 命名規(guī)則 變量對象命名規(guī)則：局部變量：采用駝峰式命名規(guī)則，第一單詞全小寫，其他單詞首字母大寫。例如：userName。全局變量：首字母為大寫的P，后面與局部變量的命名一致。例如：PuserName。函數(shù)名：。采用駝峰式命名規(guī)則，第一單詞全小寫，其他單詞首字母大寫例如：addUser()。常量：所有字母均要小寫。例如：name。類：首字母為大寫的C，其他的單詞首字母都大寫。例如：CUser。對象：與局部變量命名規(guī)則一致。例如：userOne。：數(shù)據(jù)庫表名：采用駝峰式命名規(guī)則。例如：cpInfo。字段名：表名首字母小寫加下劃線加相應單詞小寫。若表名首字母相同的，則在字段名的前兩個字母為表名的前兩個字母小寫。例如：u_name。索引名：“index_”加相應的名稱。例如：index_name。視圖名：首字母為大寫的V，后面加相應的名稱。例如：Vpest。 術語定義術語定義如表1所示。表1 術語定義表序 號術 語 名 稱術 語 定 義1總體結(jié)構(gòu)軟件系統(tǒng)的總體邏輯結(jié)構(gòu)。按照不同的設計方法，有不同的總體邏輯結(jié)構(gòu)。若采用面向功能或面向數(shù)據(jù)的設計方法，則總體邏輯結(jié)構(gòu)為一樹形的功能模塊結(jié)構(gòu)圖。若采用面向?qū)ο蠡蛎嫦虿考?gòu)件）的設計方法，則總體邏輯結(jié)構(gòu)為部件（構(gòu)件）的組裝圖2外部接口本軟件系統(tǒng)與其他軟件系統(tǒng)之間的接口，接口設施可以是中間件。接口描述包括：傳輸方式、帶寬、數(shù)據(jù)結(jié)構(gòu)、傳輸頻率、傳輸量、傳輸協(xié)議3數(shù)據(jù)結(jié)構(gòu)數(shù)據(jù)結(jié)構(gòu)包括：數(shù)據(jù)庫表的結(jié)構(gòu)、其他數(shù)據(jù)結(jié)構(gòu)等4概念數(shù)據(jù)模型CDM關系數(shù)據(jù)庫的邏輯設計模型，叫做概念數(shù)據(jù)模型。主要內(nèi)容包括一張邏輯ER圖及其相應的數(shù)據(jù)字典5物理數(shù)據(jù)模型PDM關系數(shù)據(jù)庫的物理設計模型，叫做物理數(shù)據(jù)模型。主要內(nèi)容包括一張物理表關系圖及其相應的數(shù)據(jù)字典6視圖在基表或其他視圖之上建立的一張?zhí)摫?，叫做視圖，它具有物理表的許多性質(zhì)，在數(shù)據(jù)處理和授權(quán)上很有用7角色數(shù)據(jù)庫中享有某些特權(quán)操作的用戶，叫做角色。角色的權(quán)利通過授權(quán)來實現(xiàn)8子系統(tǒng)具有相對獨立功能的小系統(tǒng)叫做子系統(tǒng)。一個大的軟件系統(tǒng)可以劃分為多個子系統(tǒng)，每個子系統(tǒng)可由多個模塊或多個部件組成9模塊具有功能獨立、能被調(diào)用的信息單元叫做模塊。模塊是結(jié)構(gòu)化設計中的概念10內(nèi)部接口軟件系統(tǒng)內(nèi)部各子系統(tǒng)之間、各部件之間、各模板之間的接口，叫做內(nèi)部接口。接口描述包括：調(diào)用方式、入口信息、出口信息等11相關文件相關文件是指當本文件內(nèi)容變更后，可能引起變更的其他文件。如需求分析報告、詳細設計說明書、測試計劃、用戶手冊12參考資料參考資料是指本文件書寫時用到的其他資料。如各種有關規(guī)范、模板、標準、準則 參考資料[1] 用戶需求報告[2] 軟件開發(fā)合同[3] 數(shù)據(jù)庫設計規(guī)范[4] 命名規(guī)范 相關文檔[1] 《詳細設計說明書》[2] 源程序清單[3] 測試計劃及報告[4] 《用戶使用手冊》2．業(yè)務流程分析 業(yè)務流程分析依據(jù)前面的需求分析說明書，我們從整個系統(tǒng)中提取了普通用戶和管理員兩實體（操作員）。從用戶和管理員兩個角度對本系統(tǒng)的業(yè)務流程進行分析說明，繪制出如圖1所示的業(yè)務流程圖。圖 1 業(yè)務流程圖圖中符號說明：圖中紅色實績箭頭為系統(tǒng)管理員所擁有的操作。圖中藍色虛線箭頭為普通用戶不可操作，但要沿箭頭方向傳送數(shù)據(jù)。圖中黑色虛線方框表示需要人工處理過程。依據(jù)用戶的要求和整個系統(tǒng)的特征，我們這個系統(tǒng)采用B/S的計算模式，如圖2所示。圖 2 柑橘蟲害專家系統(tǒng)計算模式 用戶操作流程首先，用戶要先注冊登錄，或以游客的身份登錄本網(wǎng)站。登錄后可以進行瀏覽本站內(nèi)的信息、柑橘蟲害診斷、瀏覽用戶的留言信息、發(fā)表或回復留言、修改用戶的基本信息（游客不擁有后面兩項操作權(quán)限）等操作。如果這些鏈接滿足用戶的要求條件，則系統(tǒng)進行查詢給出相應的信息；反之則進行智能診斷操作，這要求用戶輸入一些柑橘害蟲的描述。這里系統(tǒng)給用戶的信息包括這些柑橘害蟲的信息、柑橘蟲病的信息以及害蟲天敵的信息。系統(tǒng)根據(jù)用戶給出的描述判斷時運是否為數(shù)據(jù)庫中沒有存在的新害蟲的特征描述。若數(shù)據(jù)庫存在這種害蟲特征，則給出相應信息；若沒有，則存儲這些新特征，由系統(tǒng)管理員來做下一步的處理。在用戶診斷柑橘蟲害后也可以進行瀏覽、發(fā)表或回復相關主題的留言。 管理員操作流程同樣管理員只有登錄后才能進行相應的操作。瀏覽用戶留言信息、發(fā)表新留言、回復用戶留言、刪除用戶留言、從用戶留言中提取出有關柑橘蟲害的息、系統(tǒng)的日常維護。系統(tǒng)的日常維護包括系統(tǒng)的一般性維護和對用戶提交的新害蟲的特征的管理。一旦發(fā)現(xiàn)有用戶提交了新的害蟲的信息，管理員要組織相關的專家對這些信息進行分析歸類，將分析的結(jié)果存儲到數(shù)據(jù)庫中，以便用戶的下次的查詢。 系統(tǒng)各模塊時序圖 用戶信息管理模塊時序圖，如下圖3所示圖 3 用戶信息處理時序圖摘要：用戶注冊、專家注冊用戶時，用戶信息表單將注冊信息提交給用戶信息控制者，用戶信息控制者再將注冊信息保存到系統(tǒng)。用戶登錄時，用戶信息表單將登錄信息提交給用戶信息控制者，用戶信息控制者從系統(tǒng)讀取信息進行驗證，并返回登錄結(jié)果。登錄后的用戶修改信息時用戶信息表單將修改后的信息提交給用戶信息控制者，用戶信息控制者再將信息保存到系統(tǒng)。管理員瀏覽用戶時，用戶信息表單向用戶信息控制者提出請求，用戶信息控制者從系統(tǒng)讀出已有用戶信息，用戶信息表單將返回的用戶信息顯示出來。管理員對已有用戶的信息進行修改時，用戶信息表單將修改后的信息提交到用戶信息控制者，用戶信息控制再保存到系統(tǒng)。用戶信息表單的方法：提交用戶信息submitUserInfo(),請求用戶信息requestUserInfo,提交編輯用戶信息submitEditUserInfo()，顯示注冊結(jié)果showRegistResult()顯示登錄結(jié)果showLoginResult(),顯示刪除結(jié)果showDeleteResult(),顯示用戶信息showUserInfo()。用戶信息控制者的方法：保存用戶信息saveUserInfo(),提交登錄信息submitUserInfo(),保存用戶信息saveUserInfo(),請求用戶信息requestUserInfo(),提交刪