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

2、、程序分別進(jìn)行了實(shí)現(xiàn)層面上的要求和說(shuō)明。軟件開(kāi)發(fā)小組的產(chǎn)品實(shí)現(xiàn)成員應(yīng)該閱讀和參考本說(shuō)明進(jìn)行代碼的編寫(xiě)、測(cè)試。1.2背景說(shuō)明：A、 軟件系統(tǒng)的名稱(chēng):信息發(fā)布系統(tǒng)B、 任務(wù)提出者：JAVA實(shí)踐小學(xué)期開(kāi)發(fā)者：第22組成員C、 實(shí)現(xiàn)完成的系統(tǒng)將可用在所有JAVA虛擬機(jī)的個(gè)人PC上.為使用者提供信息發(fā)布，瀏覽，評(píng)論的方式，溝通各個(gè)用戶.1.3定義服務(wù)器端API ：服務(wù)器端設(shè)計(jì)者通過(guò)規(guī)范的API文檔，提供給客戶端，以方便客戶端的開(kāi)發(fā)，使得同時(shí)進(jìn)行，提高效率，節(jié)約時(shí)間。兩端通過(guò)protocol（協(xié)議類(lèi)）進(jìn)行通信。Gson：Google提供的一個(gè)類(lèi)庫(kù)。通過(guò)使用這個(gè)類(lèi)庫(kù)，可以把把對(duì)象轉(zhuǎn)換成json格式的字符串，

3、以方便在網(wǎng)絡(luò)中的傳輸。也可反向?qū)⒆址D(zhuǎn)換成對(duì)象，這樣帶有方法地操作對(duì)象，可以有效，方便地保證信息的溝通。Json：JavaScript Object Notation，是一種輕量級(jí)的數(shù)據(jù)交換格式。易于人閱讀和編寫(xiě)，同時(shí)也易于機(jī)器解析和生成。它基于JavaScript的一個(gè)子集，JSON采用完全獨(dú)立于語(yǔ)言的文本格式，這些特性使得JSON成為理想的數(shù)據(jù)交換語(yǔ)言。1.4參考資料，相關(guān)的文件包括：A、 項(xiàng)目需求說(shuō)明；B、 項(xiàng)目詳細(xì)設(shè)計(jì)說(shuō)明書(shū)；C、 項(xiàng)目概要設(shè)計(jì)說(shuō)明書(shū)；參考資料：軟件工程概論，王華第二部分、程序系統(tǒng)的結(jié)構(gòu)該系統(tǒng)為了兩大部分：客戶端與服務(wù)器端，中間通過(guò)protocol類(lèi)通信。其中使用gs

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

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

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

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

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

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

10、不為“”則必須)返回：如查看成功則返回則返回type=“41”,不成功則返回type=“42”;文檔內(nèi)容在content中，文檔名列表在filenames中，對(duì)應(yīng)的文檔摘要在filesummaries中;回復(fù)內(nèi)容在recordContents中，對(duì)應(yīng)的回復(fù)作者在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”,如不成功則返