《詳細設(shè)計說明書_v1.0范版.doc》由會員分享，可在線閱讀，更多相關(guān)《詳細設(shè)計說明書_v1.0范版.doc（11頁珍藏版）》請在裝配圖網(wǎng)上搜索。

1、編寫：* 日期：2006-07-02 審核：日期： 批準：日期： 受控狀態(tài)：是 發(fā)布版次：1.0日期：2006-07-02 編號：XS 1.0 協(xié)同辦公系統(tǒng)協(xié)同辦公系統(tǒng) 詳細設(shè)計說明書詳細設(shè)計說明書 變更記錄變更記錄 日期版本變更說明作者 2006-07-021.0初始版本王正韜、張敏 簽字確認簽字確認 系統(tǒng)模塊對應(yīng)章節(jié)對應(yīng)部門負責人簽字 目目 錄錄 1引言引言3 1.1編寫目的3 1.2背景3 1.3基線3 1.4范圍4 1.5定義4 1.6參考資料4 2模塊命名規(guī)則模塊命名規(guī)則5 3模塊匯總模塊匯總6 3.1模塊匯總表6 3.2模塊關(guān)系圖7 4子系統(tǒng)模塊設(shè)計子系統(tǒng)模塊設(shè)計7 4.1數(shù)據(jù)庫連

2、接模塊7 4.2公司通訊錄模塊 ADDRESS.8 4.3在線信息模塊 MESSAGES.11 4.4名片夾模塊 NAMECARD.15 4.5代辦事項模塊 NOTES.20 4.6個人文件夾模塊 PERSONALFILE.24 4.7日程模塊 SCHEDULE.30 4.8用戶信息模塊 USERINFORMATION.37 4.9系統(tǒng)管理模塊 SYSTEMMANAGE41 1 引言引言 1.1 編寫目的編寫目的 本說明書目的在于明確說明系統(tǒng)各功能的實現(xiàn)方式，指導(dǎo)開發(fā)員進行編碼。 本說明書的預(yù)期讀者為：項目經(jīng)理、+Teamgeist 項目組開發(fā)人員 1.2 背景背景 待開發(fā)軟件系統(tǒng)的名稱：協(xié)同

3、辦公系統(tǒng) 此軟件系統(tǒng)任務(wù)提出者：項目經(jīng)理 此軟件系統(tǒng)任務(wù)開發(fā)者：*小組 1.3 基線基線 協(xié)同辦公平臺需求分析說明書 v1.1 1.4 范圍范圍 此說明書主要應(yīng)用整個軟件代碼開發(fā)的生命周期以及測試周期 1.5 定義定義 無 1.6 參考資料參考資料 項目計劃 V1.2 概要設(shè)計說明書 V1.0 2 模塊命名規(guī)則模塊命名規(guī)則 標識符類型命名規(guī)則例子 包（Packages）一個唯一包名的前綴總是全部小寫的 ASCIIzimu 并且是一個頂級域名，通常 是 com,edu,gov,mil,net,org,或 1981 年 ISO3166 標準所指定的標識國家的英文 雙字符代碼。包名的后續(xù)部分根據(jù)不同

4、 機構(gòu)各自內(nèi)部的命名規(guī)范而不盡相同。 這類命名規(guī)范可能以特定目錄名的組成 來區(qū)分部門(department),項目（project） ， 及其（machine） ，或注冊名（login name） 。包括基本為全小寫的字母 com.sun.eng com.apple.quicktime.v2 .cs.bovik.cheese 類(Classes)類名是一個單詞，采用大小寫混合的方 式，每個單詞的首字母大寫。盡量使你 的類名簡潔而富于描述。使用完整單詞， 避免錯寫詞（除非該錯寫詞被更廣泛使 用，像 URL，HTML） class Raster; class ImageSprite; 借口（Int

5、erfaces）命名規(guī)則：大小寫規(guī)則與類名相似interface RasterDelegate; interface Storing; 方法（Methods）方法名是一個動詞，采用大小寫混合的 方式，第一個單詞的首字母小寫，其后 單詞的首字母音大寫 run(); runFast(); getBackground(); 變量（Variables）除了變量名外，所有實例，包括類，類 常量，均采用大小寫混合的方式，第一 個單詞的首字母小寫，其后單詞的首字 母大寫。變量名不應(yīng)以下劃線或類元符 號開頭，盡管這在語法上是允許的。變 量名應(yīng)簡短且富于描述。變量名的選用 應(yīng)該易于記憶，即，能夠指出其用途。 盡

6、量避免單個字符的變量名，除非是一 次性的臨時變量。臨時變量通常被取名 為 i,j,k,m 和 n，它們一般用于整型； c，d，e，它們一般用于字符型。 int I; float myWidth; 實例變量(instance Variables) 大小寫規(guī)則和變量名相似，處理前面需 要一個下劃線 int_employeeld; String_name; Customer_customer; 常量（Constants）類常量和 ANSI 常量的聲明，應(yīng)該全部 大寫，單詞間用下劃線隔開。 （盡量避免 ANSI 常量，容易引起錯誤） ，使用 static final 進行標明。 static fina

7、l int MIN_WIDTH=4; static final int MAX_WIDTH=999; static final int GET_THE_CPU=1; 3 模塊匯總模塊匯總 3.1 模塊匯總表模塊匯總表 提示：提示：這里模塊是指相對獨立的軟件設(shè)計單元，例如對象類、函數(shù)包等等。 子系統(tǒng)子系統(tǒng) Address 公司通訊錄公司通訊錄 模塊名稱功能簡述 公司通訊錄通過人員姓名檢索公司通訊錄，通過公司組織樹檢索公司通訊錄 子系統(tǒng)子系統(tǒng) Messages 在線信息在線信息 模塊名稱功能簡述 收件箱可以查詢具體內(nèi)容、刪除信件 發(fā)件箱可以查詢具體內(nèi)容、增加、刪除、修改、發(fā)送 草稿箱可以查詢具體內(nèi)

8、容、增加、刪除、修改、發(fā)送 搜索可以搜索符合要求的信件并查看信件的具體內(nèi)容 子系統(tǒng)子系統(tǒng) NameCard 名片夾名片夾 模塊名稱功能簡述 名片夾可以查詢具體內(nèi)容、增加、刪除、修改 子系統(tǒng)子系統(tǒng) Notes 待辦工作待辦工作 模塊名稱功能簡述 待辦工作可以查看具體內(nèi)容、增加、刪除、修改 最近日程可以查看最近五條日程的內(nèi)容，可以鏈接到所有日程列表 最近留言可以查看最近五條留言的內(nèi)容，可以鏈接到所有留言列表 子系統(tǒng)子系統(tǒng) PersonalFile 個人文件夾個人文件夾 模塊名稱功能簡述 個人文件夾可以上傳、刪除文件，可以新建、修改、刪除文件夾，可以修改文件夾名及屬 性 共享文件夾可以下載共享文件

9、子系統(tǒng)子系統(tǒng) Schedule 日程日程 模塊名稱功能簡述 日程管理可以增加、修改、刪除日程 代辦設(shè)置可以授予或取消代辦權(quán)限 讀者設(shè)置可以授予或取消讀者權(quán)限 日程查詢可查詢?nèi)粘滩⒉榭淳唧w內(nèi)容 子系統(tǒng)子系統(tǒng) UserInfo 個人信息管理個人信息管理 模塊名稱功能簡述 基本信息管理可以修改自己的基本信息 密碼修改可以修改密碼 查詢他人信息可以查詢他人的公開信息 子系統(tǒng)子系統(tǒng) DeptManage 部門管理部門管理 模塊名稱功能簡述 部門管理可以增加、刪除、修改部門，可以修改部門的聯(lián)系電話 子系統(tǒng)子系統(tǒng) RoleManage 角色管理角色管理 模塊名稱功能簡述 角色列表管理可以增加、刪除、修改角色

10、列表 個人角色管理可以修改個人的角色 3.2 模塊關(guān)系圖模塊關(guān)系圖 數(shù)據(jù)庫 數(shù)據(jù)庫訪問接口 個人辦公 個人信息管理 名片管理 日程安排 在線信息 個人文件夾 登陸認證 系統(tǒng)管理 公司通訊錄 角色管理 部門管理 待辦事項 會議管理 控制器 個人辦公界面系統(tǒng)管理界面 4 子系統(tǒng)模塊設(shè)計子系統(tǒng)模塊設(shè)計 4.1 數(shù)據(jù)庫連接模塊數(shù)據(jù)庫連接模塊 功能描述連接數(shù)據(jù)庫 接口與屬性 AbstractDAO getConnection() : Connection 函數(shù)功能：返回數(shù)據(jù)庫連接對象 返回值：Connection（數(shù)據(jù)庫連接對象） AbstractDAOFactory createDAO(): Abst

11、ractDAO 函數(shù)功能：創(chuàng)建數(shù)據(jù)庫訪問類的實例 返回值：數(shù)據(jù)庫訪問類的實例 DAOFactoryBuilder getFactory() : AbstractDAOFactory 函數(shù)功能：創(chuàng)建 DAO 工廠類 返回值：DAO 工廠 數(shù)據(jù)結(jié)構(gòu) 與算法 采用工廠方法設(shè)計模式將 DAO 的創(chuàng)建與使用者分離，F(xiàn)actoryBuilder 負 責創(chuàng)建 DAOFactory 使得使用者不會因 DAOFactory 的改變而改變 補充說明 4.2 公司通訊錄公司通訊錄模塊模塊 Address 模塊名稱Address（公司通訊錄） 功能描述查詢通訊錄、導(dǎo)出通訊錄 接口與屬性 getAddressByVal

12、ue(key : String, value : String) : Object 函數(shù)功能：通過輸入的查詢條件、查詢類別查詢指定的員工、部門或者 所有的員工的通訊資料 輸入?yún)?shù)：key : String, value : String 返回值：UserInfoBean、DeptBean（得到的個人、部門或者所有員工的通 訊資料） buildTreeFile() 函數(shù)功能：構(gòu)建樹型結(jié)構(gòu) 數(shù)據(jù)結(jié)構(gòu) 與算法 補充說明 : 戶 戶 : AddressServlet : AddressCtrl : AddressManager : Utility : DeptBean : UserInfoBean 1

13、: 2: buildTreeFile( ) 4: 3: getTreeInfo( ) 6: getAllDeptAddress( ) 8: buildTreeFile( ) 7: new 5: new 用戶打開公司通訊錄 : 戶 戶 : AddressServlet : AddressCtrl : AddressManager : Utility : DeptBean : UserInfoBean 1: 2: buildTreeFile( ) 4: 3: getTreeInfo( ) 6: getAllDeptAddress( ) 8: buildTreeFile( ) 7: new 5: new 進行查詢 : 戶 戶 : AddressServlet : AddressCtrl : AddressManager : DeptBean 1: 2: getDeptAddressById(String) 3: getDeptAddressById(String) 4: new 顯示部門通訊錄 : 戶 戶 : AddressServlet : AddressCtrl : UserInfoBean : AddressManager 1: 2: getUserAddressById(String) 3: 4: new 顯示個人通訊錄