Java程序設(shè)計(jì)-模塊設(shè)計(jì)報(bào)告

1、:機(jī)構(gòu)圖標(biāo)項(xiàng)目名稱模塊設(shè)計(jì)報(bào)告文件狀態(tài)：文件標(biāo)識(shí)：Company-Project-SD-MODULEV草稿當(dāng)前版本：X.Y正式發(fā)布作者：正在修改完成日期：Year-Month-Day機(jī)構(gòu)公開信息項(xiàng)目名稱，模塊設(shè)計(jì)報(bào)告機(jī)構(gòu)名稱，2002Page of20版本歷史目錄TOC o 1-5 h z HYPERLINK l bookmark4 o Current Document 0.文檔介紹4 HYPERLINK l bookmark6 o Current Document 0.1文檔目的4 HYPERLINK l bookmark8 o Current Document 0.2文檔范圍4 HYPER

2、LINK l bookmark10 o Current Document 0.3讀者對(duì)象4 HYPERLINK l bookmark12 o Current Document 0.4參考文獻(xiàn)4 HYPERLINK l bookmark14 o Current Document 0.5術(shù)語與縮寫解釋4 HYPERLINK l bookmark16 o Current Document 模塊命名規(guī)則6 HYPERLINK l bookmark24 o Current Document 模塊匯總6 HYPERLINK l bookmark26 o Current Document 模塊匯總表6 HY

3、PERLINK l bookmark28 o Current Document 模塊關(guān)系圖6子系統(tǒng)A的模塊設(shè)計(jì)N模塊A-N子系統(tǒng)B的模塊設(shè)計(jì)N模塊B-N錯(cuò)誤！未定義書簽錯(cuò)誤！未定義書簽錯(cuò)誤！未定義書簽錯(cuò)誤！未定義書簽5.其他200.文檔介紹0.1文檔目的作為企業(yè)即時(shí)通軟件設(shè)計(jì)文檔的重要組成部分，本文檔主要對(duì)該軟件各個(gè)模塊以及模塊與模塊之間的關(guān)系進(jìn)行了詳細(xì)描述，并對(duì)相關(guān)內(nèi)容做出了統(tǒng)一的規(guī)定。0.2文檔范圍本文檔包含以下幾個(gè)部分:0.文檔介紹模塊命名規(guī)則模塊匯總其它0.3讀者對(duì)象本文檔的主要讀者包括：本系統(tǒng)的設(shè)計(jì)人員：包括模塊設(shè)計(jì)人員本系統(tǒng)的系統(tǒng)開發(fā)人員：編碼人員。本系統(tǒng)的測(cè)試人員0.4參考文獻(xiàn)提

4、示：列出本文檔的所有參考文獻(xiàn)（可以是非正式出版物），格式如下：標(biāo)識(shí)符作者，文獻(xiàn)名稱，出版單位（或歸屬單位），日期例如：AAA作者，立項(xiàng)建議書，機(jī)構(gòu)名稱，日期SPP-PROC-SDSEPG，系統(tǒng)設(shè)計(jì)規(guī)范，機(jī)構(gòu)名稱，日期0.5術(shù)語與縮寫解釋縮寫、術(shù)語解釋SPP精簡(jiǎn)并行過程，SimplifiedParallelProcessSD系統(tǒng)設(shè)計(jì)，SystemDesign模塊命名規(guī)則1.1類和接口1）類和接口名均采用名詞，首字母大寫，其他單詞首字母大寫。例如：BufferedStreamReader，縮寫詞必須全部大寫。例如：TargetURL。1.2包1）所有包名只能用小寫字母。盡量別使包名長(zhǎng)度超過8個(gè)字符

5、，避免使用多個(gè)詞作為包名；2）頂級(jí)包名采用開發(fā)者所在機(jī)構(gòu)的域名的逆序，若沒有域名，可采用公司英文名稱例如：com.sun.jdbc、org.jboss3）非頂級(jí)包名采用名詞，或名詞的縮寫。模塊匯總2.1模塊匯總表用戶界面（客戶端）模塊名稱功能簡(jiǎn)述LoginJFrameLoginJFrame類為用戶提供登錄界面。MainJFrameMainJFrame類為客戶端主窗體界面。ChatJFrameChatJFrame類為用戶提供發(fā)送、顯示聊天消息的操作界面。ChatRecordJFrameChatRecordJFrame類為用戶提供導(dǎo)出聊天記錄、清除聊天記錄的操作界面。UpdatelnfoJFram

6、eUpdateInfoJFrame類為用戶提供更新用戶信息的操作界面。UserlnfoJFrameUserInfoJFrame類為用戶提供查看在線用戶信息的界面。ClientReceiveThreadClientReceiveThread類負(fù)責(zé)接收服務(wù)器端轉(zhuǎn)發(fā)的消息。表1-1表示層（客戶端）模塊匯總表用戶界面（服務(wù)器端）模塊名稱功能簡(jiǎn)述MainJFrameMainJFrame類為用戶提供服務(wù)器端的主窗體界面。CorperationJFrameCorperationJFrame類為用戶提供更新公司信息的操作界面。DepartmentJFrameDepartmentJFrame類為用戶提供增加、刪

7、除、修改、顯示部門信息的操作界面。UserInfoJFrameUserInfoJFrame類為用戶提供增加、刪除、修改、顯示用戶的操作界面。DepartmentAddFrmDepartmentAddJFrame類為用戶提供增加部門的操作界面。UserlnfoAddJFrameUserInfoAddJFrame類為用戶提供增加用戶的操作界面。ServerListenThreadServerListenThread類負(fù)責(zé)偵聽客戶端的連接請(qǐng)求ServerReceiveThreadServerReceiveThread類負(fù)責(zé)接收、轉(zhuǎn)發(fā)客戶端的消息。表1-2表示層（服務(wù)器端）模塊匯總表自定義界面模塊名稱

8、功能簡(jiǎn)述AboutPanelAboutPanel類定義了“關(guān)于”面板上圖像的布局方式InfoPanelInfoPanel類定義了“信息”面板上圖像與程序信息的布局方式HelpDailogHelpDailog類為自定義對(duì)話框，作為AboutPane和InfoPanel的容器PicPanelPicPanel類為自定義圖像框，作為圖像顯示的容器表1-3自定義界面模塊匯總表業(yè)務(wù)規(guī)則類模塊名稱功能簡(jiǎn)述CorperationBLCorperationBL類用于處理與公司相關(guān)的業(yè)務(wù)操作，例如查詢或更新公司信息。繼承自DbUtils類DepartmentBLDepartment類負(fù)責(zé)處理與部門相關(guān)的業(yè)務(wù)操作，

9、例如部門信息的增、刪、改。繼承自DbUtils類UserInfoBLUserInfoBL類負(fù)責(zé)處理與用戶相關(guān)的業(yè)務(wù)操作，例如用戶信息的增、刪、改。繼承自DbUtils類DeptsUsersBLDeptssUsersBL類負(fù)責(zé)處理與部門用戶信息相關(guān)的業(yè)務(wù)規(guī)則。表1-4業(yè)務(wù)規(guī)則模塊匯總表數(shù)據(jù)實(shí)體類模塊名稱功能簡(jiǎn)述CorperationCorperation類定義公司對(duì)象，包含了訪問公司屬性的方法。DepartmentDepartment類定義部門對(duì)象，包括部門的編號(hào)、名稱、描述等屬性，其中包括訪問這些屬性的方法。UserInfoUserInfo類定義用戶對(duì)象，包括用戶的基本屬性和訪問這些信息的方法

10、。OnlineUserOnLineUser類定義在線用戶對(duì)象，該類繼承自UserInfo，它不僅包括用戶的基本屬性，而且加入了一些與網(wǎng)絡(luò)通信相關(guān)的屬性。它也包含訪問這些屬性的方法。表1-5數(shù)據(jù)實(shí)體匯總表工具類模塊名稱功能簡(jiǎn)述ConstantValuesConstantValues類中定義了程序中常用的符號(hào)與數(shù)字常量。DbUtils類DbUtils類定義了訪問數(shù)據(jù)庫的常用方法。CommonUtils類CommonUtils類定義了和字符串、日期、文件、Swing界面開發(fā)相關(guān)的常用方法。PropConfig類PropConfig類定義了與資源文件操作相關(guān)的屬性與方法。表1-6工具類匯總表2.2模塊

11、關(guān)系圖2.2.1包關(guān)系1.表示層（客戶端）如下圖（圖2-3）所示：圖2-3客戶端表示層表示層（服務(wù)器端）如下圖（圖2-4）所示：3AAMainJFrameJFrameThread圖2-4服務(wù)器端表示層DepartmentAddJFrameServerReceiveThreadSeruerListenThreadOnlineWatchJFrameCorperationJFrame成DepartmentJFrame-用戶界面十一謝-Abaseformk-UserlnfoAddFrameUserlnfoJFrame3.自定義界面（圖2-5）所示：AboutPanelInfoPanel圖2-5自定義界

12、面類自定文界面HelpDialogPicPanelJPanelJDialog4.業(yè)務(wù)規(guī)則類如下圖（圖2-6）所示：5.圖2-7）所示：數(shù)據(jù)實(shí)體類如下圖圖2-7數(shù)據(jù)實(shí)體類1OnlinellserJ6.工具類如下圖（圖2-8）所示：圖2-8工具類7.圖像資源和資源文件圖像資源主要包含程序中用到的圖像文件，本項(xiàng)目中使用的圖像文件格式均為gif格式。2.2.2表示層模塊設(shè)計(jì)2.2.2.1客戶端表示層模塊1：LoginJFrame如下表：模塊名稱LoginJFrame功能描述LoginJFrame為用戶提供登錄界面，用戶輸入帳號(hào)、密碼、服務(wù)器IP和服務(wù)器端口號(hào)進(jìn)行登錄。接口與屬性函數(shù)名訪問性返回值參數(shù)功

13、能verifiedInput私有有無客戶端驗(yàn)證數(shù)據(jù)結(jié)構(gòu)無補(bǔ)充說明無表2-10LoginJFrame類模塊2：MainJFrame模塊名稱MainJFrame功能描述MainJFrame為用戶提供基本客戶端操作界面，用戶登錄成功后顯示該窗體，該窗體偵聽服務(wù)器發(fā)送的信息，并做相應(yīng)處理。接口與屬性函數(shù)名訪問性返回值參數(shù)功能refreshinterface私有無無刷新界面addChildTree公有無有添加子結(jié)點(diǎn)openNewChatJFrame公有無有打開聊天窗體checkAccount私有布爾值有檢查有效用戶數(shù)據(jù)結(jié)構(gòu)無補(bǔ)充說明無表2-11MainJFrame類2.2.2.2服務(wù)器端表示層模塊1：M

14、ainJFrame模塊名稱MainJFrame功能描述MainJFrame為用戶提供基本操作界面，負(fù)責(zé)啟動(dòng)、停止服務(wù)、偵聽客戶端發(fā)送的消息并進(jìn)行處理。接口與屬性函數(shù)名訪問性返回值參數(shù)功能startServer私有無無啟動(dòng)服務(wù)stopServer私有無無停止服務(wù)顯示服務(wù)器配getConfiguration私有無無置initComponentsState私有無有初始化界面控件數(shù)據(jù)結(jié)構(gòu)無補(bǔ)充說明無表2-12MainJFrame類模塊2：OnlineWatchJFrame模塊名稱OnlineWatchJFrame功能描述OnlineWatchJFrame為用戶提供了顯示在線用戶詳細(xì)信息的功能接口與屬性

15、函數(shù)名訪問性返回值參數(shù)功能刷新在線人員界refreshOnlineTable私有無無面數(shù)據(jù)結(jié)構(gòu)無補(bǔ)充說明表2-13OnlineWatchJFrame類2.2.3工具類模塊設(shè)計(jì)模塊1：DbUtils模塊名稱DbUtils功能描述DbUtils類提供了訪問數(shù)據(jù)庫數(shù)據(jù)的操作，該類被業(yè)務(wù)規(guī)則類繼承。接口與屬性函數(shù)名訪問性返回值參數(shù)功能connOpen私有無無打開數(shù)據(jù)庫連接connClose私有無無關(guān)閉數(shù)據(jù)庫連接prepstmtClose私有無無關(guān)閉Sql執(zhí)行對(duì)象resultsetClose私有無無關(guān)閉結(jié)果集對(duì)象getSqlStatement私有無無得到替換sql語句excuteQuery私有有有執(zhí)行查

16、詢excuteUpdate私有有有執(zhí)行更新query受保護(hù)有有查詢update受保護(hù)有有更新一、關(guān)閉所有數(shù)據(jù)庫對(duì)closeALL受保護(hù)無有象closeALL受保護(hù)無無同上數(shù)據(jù)結(jié)構(gòu)無補(bǔ)充說明無表2-14DbUtils類圖2-9DbUtils類圖模塊2：PropConfig模塊名稱PropConfig功能描述PropConfig類提供了訪問資源配置文件的常用操作。接口與屬性函數(shù)名訪問性返回值參數(shù)功能初始化Socket資源實(shí)initSocketConfig私有無無體初始化數(shù)據(jù)庫資源實(shí)initDbConfig私有無無體initMsgConfig私有無無初始化消息資源實(shí)體initSqlConfig私有無

17、無初始化Sql資源實(shí)體getSocket_resource公有有無得到Socket資源實(shí)體getDb_resource公有有無得到Db資源實(shí)體getMsg_resource公有有無得到消息資源實(shí)體getSql_resource公有有無得到Sql資源實(shí)體getComplexMsg公有有有取得復(fù)合消息數(shù)據(jù)結(jié)構(gòu)無補(bǔ)充說明無表2-15PropUtils模塊PropConfig-cibregciuru已：尺已suuru亡Buntil已-mciuketremourue:尺egdurceBuncile-mwqrewnurce:FesnurueEiunclle-gqlr已sciuru亡：FegciurueBu

18、ncll亡constructor+PropConfigO-initSncketCcinafig:wnicJ-initDbCcinfiq門：vciicl-initblegmacieCcinficiCi:woici-initSqlCcinficil):wnicjuuciett亡rnn+qetDbregciuru已):尺egciuru已Bunclleuucietternn+qetSciuketremourue門：RemciurueBuncJleuucietternn+qetMwqresnurueCi:ResnurueEiuncllerEtterx+qetScilremciurue門：Rewciuru

19、eEiundleuuqett亡rnn+qetCcimulexMgqfr亡suurue:Regduru已BuncJle,k亡y:Strinq,:Strinql):String圖2-10PropConfig類圖模塊3：CommonUtils模塊名稱CommonUtils功能描述CommonUtils類提供了一些公用方法，包括Swing開發(fā)相關(guān)方法、文件操作相關(guān)方法、日期操作相關(guān)方法、字符串操作相關(guān)方法、與網(wǎng)絡(luò)操作相關(guān)方法，這里只列舉一部分接口與屬性參函數(shù)名訪問性返回值込功能數(shù)getScreenHeight私有有無取得屏幕高度getScreeWidth私有有無取得屏幕寬度setScreenCente

20、r公有無有將組件位置設(shè)置在屏幕中心將組件位置設(shè)置在屏幕右上setScreenRight公有無有角getCurrentTime公有有無得到當(dāng)前機(jī)器時(shí)間writeToFile公有無有寫文件操作getContentFromFile公有有有從文件中讀取內(nèi)容檢查字符串是否包含特殊字checkNumsLetters公有有有符checkNums公有有有檢查字符串是否只包含數(shù)字checkLetters公有有有檢查字符串是否只包含字母getServerIP公有有有取得服務(wù)器端IP地址getServerPort公有有有取得服務(wù)器端口號(hào)數(shù)據(jù)結(jié)構(gòu)無補(bǔ)充說明無表2-16CommonUtils類CommonLils-di

21、mensicin:Dimenmicin=Toolkit.qetDefaultToolkitn.qetScreenSizef)-numsStrina:Strinq=0123456789-lettersStrinq:String=abcdefqhiiklmnopqrstuvwxYzABCDEFGHIJKLMNOPQRSTUVWKYZ-numslettersStrina:String=0123456789abcdefahiiklmnoDCirstuYWXVzABCDEFGHIJKLMNOPQRSTUVWXYZ11=：constructor+CommonUtils()qetter-qetScreenW

22、1dth():double=：qetter-qetScreenHeiahtC):double=：setter+setScreenCenterfc:Component:voidsetter+setScreenRiqhtCc:Component):void+checklPCipStrina:Strinq:boolean+writeToFileCfilename:Strinq,obis:Obiectn1:voidqetter+aetContentFromFileffilename:String:StrinqTlaetter+aetCurrentTime():String-checkNumsfstr:

23、Strinq:boolean-checkLettersfstr:Strinq：boolean-checkNumsLetterststr:Strinq：booleanqetter+cietServerlPCserverSocket:ServerSocket:Strinq=：qetter+qetServerPortfserverSocket:ServerSocket:Strinq圖2-11CommonUtils類圖限于篇幅，表2-16中只列出了大部分的方法，其它方法的使用請(qǐng)參照本案例的模塊設(shè)計(jì)文檔。2.2.4數(shù)據(jù)實(shí)體模塊設(shè)計(jì)模塊1：Corperation模塊名稱Corperation功能描述Cor

24、peration類用于保存公司信息。此類提供了訪問公司屬性的方法。接口與屬性提供了訪問公司屬性的get/set方法數(shù)據(jù)結(jié)構(gòu)無補(bǔ)充說明無表2-17Corperation類Corperation-corpName:String-corpAddr:String-corpDomain:String-corpEmail:String-corpPhon亡：String-corpFAX:Stringconstructor+Corperation()=：getter+getCorpName():String-=：setter+setCorpName(corpName:String):voidgetter+ge

25、tCorpAddr():String=：setter+setCorpAddr(corpAddr:String):void=：=：getter+getCorpDomainO:Stringsetter+setCorpDomain(corpDomain:String):voidgetter+getCorpEmail(；):String=：setter+setCorpEmail(corpEmail:String):void-=：getter+getCorpPhone():Stringsetter+setCorpPhone(corpPhone:String):void=：getter+getCorpFA

26、X():String+setDeptlD(deptID:int):voidgetter+getDeptName():Stringsetter+setDeptName(deptName:String):void-=：getter+getDeptDescrO:Stringsetter+setDeptDescr(deptDescr:String):void圖2-13Department類圖模塊3：UserInfo模塊名稱UserInfo功能描述UserInfo類用于保存用戶信息，此類提供了訪問用戶屬性信息的方法。接口與屬性提供了訪問用戶屬性的get/set方法數(shù)據(jù)結(jié)構(gòu)無補(bǔ)充說明無表2-19UserI

27、nfo類圖2-14UserInfo類圖模塊4：OnlineUser模塊名稱OnlineUser功能描述OnLineUser類是用來保存在線用戶信息的，此類繼承UserInfo類，提供了訪問在線用戶屬性的方法。接口與屬性提供了訪問在線用戶屬性的get/set方法數(shù)據(jù)結(jié)構(gòu)無補(bǔ)充說明無表2-20OnlineUser類OnlineUser-socket:Socket-in:BufferedReader-out:PrintVWiter-onlineAvl:intconstructor+OnlineUser(；)constructor+OnliriELlgErfserverSocket:ServerSoc

28、ket)getter+getSocket():Socketsetter+setSocket(socket:Socket):void-=：getter+getln。：BufferedReadersetter+setln(in:BufferedReader):voidgetter+getOut():PrintWViter-=：setter+set0ut(out:PrintVWiter):voidsetter+setOnlineAvl(onlineAvl:int):voidgetter+getOnlineAvl():int圖2-15OlineUser類圖2.2.5業(yè)務(wù)邏輯模塊設(shè)計(jì)模塊1：Corper

29、ationBL模塊名稱CorperationBL功能描述CorperationBL類提供操縱公司信息數(shù)據(jù)的功能，此類繼承了DbUtils類。接口與屬性函數(shù)名訪問性返回值參數(shù)功能取得公司信息實(shí)getCorperation公有有有體數(shù)據(jù)結(jié)構(gòu)無補(bǔ)充說明無表2-21CorperationBL類CorperationBL=:constructor+CorperationBLQgetter+getOorperationO:Corperation圖2-16CorperationBL類圖模塊2：DepartmentBL模塊名稱DepartmentBL功能描述DepartmentBL類提供了操縱部門信息數(shù)據(jù)的功能，此類繼承了DbUtils類。接口與屬性函數(shù)名訪問性返回值參數(shù)功能取得所有部門信getALLDepartment公有有有丿息、數(shù)據(jù)結(jié)構(gòu)無補(bǔ)充說明無表2-22DepartmentBL類DepartmentL+DepartmentBLj()getter+getALLDepa