1、信息發布系統(詳細設計說明書)編寫單位：JAVA實踐小學期第22組設計人員：版 本：1.0編寫日期：2010/9/5 目錄第一部分、引言21.1編寫目的21.2背景31.3定義33.1程序描述53.2整體結構53.3性能53.4輸入輸出項53.5算法53.6主要類的設計53.7存儲分配73.8注釋73.9限制條件73.10測試計劃73.11尚未解決的問題74.1 程序描述74.2 功能74.3 性能84.4 輸入輸出項84.5 限制條件85 設計特點85.1 通信便捷85.2 開發速度快8第六部分、項目分工8附錄：9第一部分、引言1.1編寫目的本說明書在概要設計的基礎上，對信息發布系統的各模塊

2、、程序分別進行了實現層面上的要求和說明。軟件開發小組的產品實現成員應該閱讀和參考本說明進行代碼的編寫、測試。1.2背景說明：A、 軟件系統的名稱:信息發布系統B、 任務提出者：JAVA實踐小學期開發者：第22組成員C、 實現完成的系統將可用在所有JAVA虛擬機的個人PC上.為使用者提供信息發布，瀏覽，評論的方式，溝通各個用戶.1.3定義服務器端API ：服務器端設計者通過規范的API文檔，提供給客戶端，以方便客戶端的開發，使得同時進行，提高效率，節約時間。兩端通過protocol（協議類）進行通信。Gson：Google提供的一個類庫。通過使用這個類庫，可以把把對象轉換成json格式的字符串，

3、以方便在網絡中的傳輸。也可反向將字符串轉換成對象，這樣帶有方法地操作對象，可以有效，方便地保證信息的溝通。Json：JavaScript Object Notation，是一種輕量級的數據交換格式。易于人閱讀和編寫，同時也易于機器解析和生成。它基于JavaScript的一個子集，JSON采用完全獨立于語言的文本格式，這些特性使得JSON成為理想的數據交換語言。1.4參考資料，相關的文件包括：A、 項目需求說明；B、 項目詳細設計說明書；C、 項目概要設計說明書；參考資料：軟件工程概論，王華第二部分、程序系統的結構該系統為了兩大部分：客戶端與服務器端，中間通過protocol類通信。其中使用gs

4、on庫來轉換和逆向轉換對象，實現標準包括：1、客戶端主程序A、工程類型：JAVA項目；B、工程名稱：信息發布系統C、編譯生成文件：jar形式D、引用的組件：JDK，Gson庫注：以上提供的是工具集合，具體用到的類都包含在里面2、服務器端主程序：服務器端程序以及數據庫操作類（DBO）3、服務器端數據庫操作驗證用戶，用戶注冊，更改密碼，更新文檔，新建文檔，新建記錄（包括瀏覽記錄和回復記錄），查看文檔，刪除文檔，查看記錄。第三部分、基本操作部分界面設計如下圖：3.1程序描述A、客戶端窗體：盡量友好的設計，讓用戶盡可能地關注信息的內容主體。B、服務器端設計：該窗體在設計上盡量的符合人們的使用習慣，并且

5、在出現非法操作的情況下，有相應的提示信息輸出。3.2整體結構系統的整體大致結構為下圖：3.3性能靈 活 性：窗口響應絕大部分的快捷菜單和控制面板操作；時間特性：響應鼠標單擊的時間在23秒之間；3.4輸入輸出項輸入的數據是戶執行的各種操作，包括鼠標、鍵盤等操作。輸出是從數據庫中讀取的數據，或錯誤警告信息。3.5算法本部分沒有采用自定義的算法。3.6主要類的設計用戶類數據庫操作類（包括靜態方法） 3.7存儲分配本程序在高級語言JAVA進行編碼，直接的內存分配由JAVA運行時分配。本組件內所依賴的變量、結構要求全部在組件元素內申明。3.8注釋在代碼的適當出有中文代碼注釋。注釋設計請參考Visual

6、Basic 可視化程序設計的附錄部分。3.9限制條件所有用戶的權限都經過嚴格設置，不能進行權限外的操作。用戶組分為三組：管理員，用戶和游客。3.10測試計劃測試日期、測試人員安排請參考測試計劃，測試用例的具體內容，請參考測試用例說明。3.11尚未解決的問題在文件中存儲文檔文件中，不能存儲文件名相同，但類型不同的文檔。可以通過在文件名中加入文檔類型來解決。但因時間關系，尚未解決。第四部分、其它附加功能及幫助系統4.1 程序描述本程序設計是客戶機和服務器機通過C/S模式，建立連接。在此基礎上，進行信息的共享，發布等功能。系統的目的是為了方便用戶的溝通。4.2 功能主要功能就是給用戶帶來信息的溝通，

7、交流的便捷。4.3 性能靈活性：響應鼠標操作和鍵盤操作。時間性：視網絡響應速度而定。4.4 輸入輸出項從鍵盤，鼠標按提示輸入。依服務器響應從界面輸出響應信息。4.5 限制條件在界面上控制輸入輸出，服務器端如果出錯也會返回出錯信息。5 設計特點5.1 通信便捷 本系統客戶端與服務器端采用JSON格式作為信息載體，在開發中將信息作為對象，信息傳遞很便捷。5.2 開發速度快由于使用通信協議約定，所以只要客戶端與服務器端約定好通信協議API文檔，即可以進行通信。而且直接對對象操作，不存在類型轉換的問題。這樣可以使客戶端與服務器端開發同時在API文檔的約定下進行，提高開發效率。第六部分、項目分工

8、0;王佳龍: 負責編寫GUI部分代碼，以及客戶端部分的所有代碼 戴清灝:編寫服務器端代碼，設計通信協議，以及對數據庫的操作。負責編寫詳細設計文檔。 華從男:各方面知識全面，負責組織工作，在軟件測試方面有一定的能力。在軟件開發過程負責測試文檔等文檔的編寫。  王瑋柯:負責測試，組織工作。附錄：服務器端操作API文檔（最少需要的參數，如不全服務器會返回type=“0”的信息）：服務器和客戶端之間的所有通信都封裝在protocol對象中，通過對要發送的protocol對象進行set和get操作就可以通信。驗證用戶，用戶注冊，更改密碼，更新文檔，新建文檔，新建記錄（包括瀏

9、覽記錄和回復記錄），查看文檔，刪除文檔，查看記錄1.驗證用戶 name,pass,LimitsOfAuthority返回：如驗證通過則返回type=“11”,不通過則返回type=“12”2.用戶注冊 name,pass,LimitsOfAuthority返回：如注冊成功則返回type=“21”,不成功則返回type=“22”3.更改密碼 name,pass,newPass返回：如更改成功則返回type=“31”,不成功則返回type=“32”4.查看文檔 filename（可選，如為“”則查詢本類的所有文檔，不帶全部內容）,filetype，replyAuthor(可選，如果filename

10、不為“”則必須)返回：如查看成功則返回則返回type=“41”,不成功則返回type=“42”;文檔內容在content中，文檔名列表在filenames中，對應的文檔摘要在filesummaries中;回復內容在recordContents中，對應的回復作者在recordAuthors中5.建立新文檔 filename,filetype,content,author,filesummary返回：如果建立成功則返回type=“51”,如不成功則返回type=“52”6.修改文檔 filename,filetype,newFilename,newFiletype,filesummary返回：如果修改成功則返回type=“61”,如不成功則返回type=“62”7.建立新記錄 filename,filetype,recordContent,replyAuthor返回：如果建立成功則返回type=“71”,如不成功則返