分布式資源網(wǎng)平臺概要設(shè)計說明書

1、1引言21.1編寫目的21.2背景21.3定義21.4參考資料22總體設(shè)計22.1需求規(guī)定22.2運行環(huán)境22.3基本設(shè)計概念和處理流程32.4結(jié)構(gòu)32.5功能器求與程序的關(guān)系32.6人工處理過程32.7尚未問決的問題33接口設(shè)計33.1用戶接口33.2外部接口33.3內(nèi)部接口44運行設(shè)計44.1運行模塊組合44.2運行控制44.3運行時間45系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計45.1邏輯結(jié)構(gòu)設(shè)計要點45.2物理結(jié)構(gòu)設(shè)計要點45.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系46系統(tǒng)出錯處理設(shè)計56.1出錯信息56.2補救措施56.3系統(tǒng)維護設(shè)計5概要設(shè)計說明書1引言1.1編寫目的該文檔描述了針對用戶需求系統(tǒng)的概要情況，本文檔適用于用

2、戶業(yè)務(wù)專家（專指在教育教學資源建設(shè)方面的業(yè)務(wù)專家）、軟件系統(tǒng)分析員以及軟件測試人員。1.2背景說明：a. 該軟件系統(tǒng)名稱為深圳市教育資源網(wǎng)系統(tǒng)（shenzhen education resource network，簡稱為szernet）。b. 該系統(tǒng)由深圳市電化教育館提出需求，由北京師范大學現(xiàn)代化教育技術(shù)研究所、北京市校際通信息技術(shù)有限公司、深圳市電化教育館聯(lián)合開發(fā)，軟件開發(fā)完成以后，在深圳市電化教育館的計算機中心機房運行。1.3定義n 資源元數(shù)據(jù)：描述一條資源的各類屬性信息，叫資源元數(shù)據(jù)。n 資源屬性：即資源元數(shù)據(jù)，教育教學過程中、以及資源使用過程中人們的口頭語。n 資源文件：資源的物理存

3、在方式，例如一個磁盤文件（目前最為普通的方式）。n 資源站點：提供資源訪問功能的站點叫資源站點。資源站點的概念是相對的，不是絕對的。n 資源站點之間的互操作：資源站點之間不是獨立的，而是能夠通過某些公用的接口，來進行透明化的數(shù)據(jù)交流，這樣的關(guān)系叫做資源站點之間的互操作。n 資源網(wǎng)：將多個資源站點連接在一起，成樹狀結(jié)構(gòu)，提供資源站點的互操作，這樣的體系叫做資源網(wǎng)。n 站點注冊中心：用來維護資源網(wǎng)中，各個資源站點之間的關(guān)系的某類特殊站點，叫做站點注冊中心。n 資源同步：通過某種公用的接口，來將某個資源站點（或者某批資源站點）的資源元數(shù)據(jù)的信息匯集到資源中心（前提是這些資源站點必須已經(jīng)向該資源中心的

4、站點注冊中心注冊過），并且保持這些資源元數(shù)據(jù)的同步，這個過程叫做資源同步。資源同步并不將所有的資源文件同步到資源中心去。n 資源中心：配置有站點注冊中心等能夠?qū)ζ浞秶鷥?nèi)的資源站點間發(fā)出資源同步請求的資源站點，叫做資源中心。資源中心不是絕對的，而是相對的。n 系統(tǒng)管理員：資源站點或者資源中心的管理員，最高權(quán)限者。n 資源審核專家：對資源進行審核的人，還能對資源進行管理，但往往只能對某類資源進行該操作。n 地區(qū)管理員：能夠?qū)ξ挥谀车貐^(qū)的用戶進行管理。n 資源同步管理員：能夠?qū)Y源同步過程中進行控制的人，在資源站點，該管理員能夠?qū)⑦@個資源站點的信息注冊、修改、注銷在站點注冊中心上，在資源中心，該管理

5、員能夠設(shè)置各種同步所屬資源站點資源的各種開關(guān)，并發(fā)出開始、停止同步命令。n 資源導入導出人員：能夠?qū)①Y源導入、導出到資源站點。n 訪客 guest：沒有注冊的系統(tǒng)使用者，很多功能受到限制。例如，不能擁有自己的收藏夾，不能上傳資源、不能設(shè)置自己喜歡的資源范圍等。n 資源視圖：某種類別的資源分類，用來關(guān)聯(lián)一批資源和資源視圖，方便終端用戶的使用。資源視圖與資源的物理存放沒有關(guān)系。n 存儲單元：在服務(wù)器端真正保存資源的最小管理單位。n 永久資源（正式資源）：已經(jīng)經(jīng)過審核的資源，可能是上傳的資源已經(jīng)通過了審核，也可能是導入的資源已經(jīng)通過了審核。n 上載資源：用戶通過http協(xié)議，上傳一條資源，在沒有得到

6、資源審核專家的審核以前，該資源叫上載資源。n 臨時資源：上載資源或者永久資源，被刪除以后，叫做臨時資源。在以后系統(tǒng)擴展的時候，可以用來實現(xiàn)“回收站”功能，來回收被錯誤刪除的資源。n 同步系統(tǒng)：對資源同步服務(wù)器端和資源同步客戶端程序的統(tǒng)稱，該系統(tǒng)能夠?qū)①Y源元數(shù)據(jù)同步到資源中心來。1.4參考資料a. 合同；開發(fā)計劃書；b. 國家標準化委員會資源屬性標注n :8082/celtsc/n celts-3n celts-41c. 軟件開發(fā)標準j2ee規(guī)范1.2software engineering a practitioners approach, fourth editionj2ee服務(wù)器端高級編程

7、d.2總體設(shè)計2.1需求規(guī)定說明對本系統(tǒng)的主要的輸入輸出項目、處理的功能性能要求，詳細的說明可參見附錄c。輸入/輸出項目描述性能要求資源導入能夠?qū)⒒趪覙藴寿Y源描述的資源導入到本系統(tǒng)，至少需要支持兩種格式：n 北京校際通公司的資源描述格式n 標委會的資源描述格式能夠在服務(wù)器端處理海量資源。資源導出能夠?qū)⒈鞠到y(tǒng)中的資源導出為北京校際通公司的資源描述格式。（考慮到保護資源提供上的版權(quán)，我們不提供導出為基于標委會的資源描述格式的資源的功能）能夠在服務(wù)器端處理海量資源。資源同步的服務(wù)器端接口能夠?qū)Y源同步的請求進行響應(yīng)，將本地資源的屬性信息通過網(wǎng)絡(luò)進行發(fā)送，該接口為web service 接口。能夠

8、在服務(wù)器端長時間處理海量資源，后臺運行，不要求高性能。2.2運行環(huán)境本系統(tǒng)對硬件環(huán)境的需求推薦：數(shù)據(jù)庫服務(wù)器24路cpu，頻率在700m以上，內(nèi)存4g應(yīng)用服務(wù)器2路cpu，頻率在700m以上，內(nèi)存8g本系統(tǒng)運行操作系統(tǒng)推薦：本系統(tǒng)可以運行在主流操作系統(tǒng)之上，例如，unix (ibm aix 4.3.3), linux (red hat 7.2), windows (windows 2000 server)。推薦使用ibm aix 4.3.3。本系統(tǒng)運行軟件：數(shù)據(jù)庫：采用oracle9i enterprise應(yīng)用服務(wù)器：采用websphere application advanced serve

9、r, edition 4(fix pack 4以上)推薦數(shù)據(jù)庫服務(wù)器和應(yīng)用服務(wù)器運行在單獨的服務(wù)器上。2.3基本設(shè)計概念和處理流程系統(tǒng)基本設(shè)計概念(1) 編程框架在j2ee開發(fā)規(guī)范的基礎(chǔ)上，我們采用ibm的business framework開發(fā)框架（4層開發(fā)體系），所有表現(xiàn)層都采用jsp來進行顯示，所有的流程控制都采用servlet來完成（充分利用mvc的開發(fā)模式），對于用戶需求中的每一個具體的使用案例的商務(wù)邏輯，我們都采用一個專門的command bean和一個session bean來對其進行包裝，對于數(shù)據(jù)庫的訪問，在訪問單條數(shù)據(jù)庫記錄（且限于單表的情況）的時候，我們采用entity b

10、ean（這樣做，我們能夠大幅度提高開發(fā)效率），其他情況，為了提高訪問效率，我們采用直接jdbc連接的方式來進行。(2) 系統(tǒng)體系劃分分布式資源網(wǎng)平臺的開發(fā)需要按照三個步驟來進行。n 實現(xiàn)傳統(tǒng)資源庫功能的開發(fā)采用傳統(tǒng)的開發(fā)方式開發(fā)傳統(tǒng)資源庫的功能，例如，對資源的瀏覽、使用、收藏、下載等。n 定義資源庫互操作的接口，并根據(jù)接口實現(xiàn)資源庫服務(wù)器端功能該服務(wù)器端能夠?qū)涌趯嵭许憫?yīng)，以純xml數(shù)據(jù)流或者web service接口的方式來實現(xiàn)資源庫之間互操作的接口。n 根據(jù)資源庫互操作的接口實現(xiàn)資源庫客戶端的功能更新傳統(tǒng)資源庫的實現(xiàn)方式，將需要資源庫互操作的所有傳統(tǒng)實現(xiàn)更新為針對純xml流或者web se

11、rvice接口的實現(xiàn)。系統(tǒng)基本處理流程（1）資源庫中資源的建設(shè)問題n 允許普通用戶通過http協(xié)議遠程上載資源。n 允許導入資源（用來滿足用戶購買商業(yè)教學資源的需求）。這樣的海量資源，在服務(wù)器端進行，要求程序運行穩(wěn)定，性能優(yōu)良，能夠靈活配置，以適應(yīng)各地的不同部署環(huán)境。n 必須考慮到將來的資源訪問收費問題，必須留下實現(xiàn)該功能的足夠接口。（2）資源庫中資源的管理問題n 在邏輯上，資源可以存放在三個地方，臨時資源庫（用來存放臨時的資源，例如，刪除的資源等），上載資源庫（用戶上載的資源，還沒有通過審核的），永久資源庫（用戶購買的資源，用戶上載并且經(jīng)過審核的資源）。n 在物理上，資源存放在磁盤（陣列）上

12、。對于臨時資源庫，上載資源庫，永久資源庫來說，都需要一個資源存儲管理系統(tǒng)，臨時資源庫對應(yīng)著臨時資源存儲管理系統(tǒng)，上載資源庫對應(yīng)著上載資源存儲管理系統(tǒng)，永久資源庫對應(yīng)著永久資源存儲管理系統(tǒng)。對于任何一個存儲管理系統(tǒng)，應(yīng)該提供建立/修改/刪除單個存儲單元或建立批量存儲單元的功能。n 用戶上載的資源首先保存在上載資源庫，經(jīng)過資源審核專家審核以后保存在永久資源庫。永久資源庫和上載資源庫里面的資源，審核專家或者資源管理員刪除以后，保存在臨時資源庫。n 在分布式前提下，各個地方的資源是各自管理的。2.4結(jié)構(gòu)（1）技術(shù)路線session beanshtmljspservletcommandbrowseren

13、tity beansdbresourcejava beans圖技術(shù)路線圖（2）功能模塊基本系統(tǒng)之終端用戶（主要功能模塊）圖基本系統(tǒng)之終端用戶的前臺使用圖基本系統(tǒng)之終端用戶的資源瀏覽圖基本系統(tǒng)之終端用戶的資源查看基本系統(tǒng)之后臺管理圖基本系統(tǒng)之系統(tǒng)管理圖基本系統(tǒng)之資源審核專家圖基本系統(tǒng)之地區(qū)用戶管理擴展系統(tǒng)之終端用戶圖擴展系統(tǒng)之資源瀏覽(1)圖擴展系統(tǒng)之資源瀏覽(2)圖擴展系統(tǒng)之資源檢索擴展系統(tǒng)之后臺管理圖0擴展系統(tǒng)之資源導入/導出圖2.4.2.

14、10擴展系統(tǒng)之站點注冊圖1擴展系統(tǒng)之后臺服務(wù)（3）每個系統(tǒng)元素的扼要說明 編號系統(tǒng)元素名稱英文名稱扼要說明基本系統(tǒng)用戶/角色a_001終端用戶web site user使用資源網(wǎng)的普通用戶，包括注冊用戶和訪客（guest）a_002系統(tǒng)管理員system manager系統(tǒng)后臺維護人員，資源站點的最高權(quán)限者a_003資源審核專家expert資源審核專家，能夠?qū)χ付▽傩缘馁Y源進行資源管理、審核、專家評論擴展系統(tǒng)用戶/角色a_004地區(qū)管理員area manager能夠?qū)Ρ举Y源站點該地區(qū)的注冊用戶進行管理、審核a_005資源導入/導出員importer/exporter能夠?qū)⑾到y(tǒng)資源

15、導出為標準的xml格式，也能將符合標準格式的xml資源導入到本資源站點a_006站點同步管理員site synchronization manager能夠進行站點注冊、審核、管理的站點注冊中心管理人員?；鞠到y(tǒng)中的前臺應(yīng)用f_001資源瀏覽系統(tǒng)browsing resource matadata info.瀏覽資源站點中的資源f_002用戶通信模塊send messages to others注冊用戶可以通過這個發(fā)消息模塊，互相通信f_003資源上傳upload上載資源f_004購買資源buy resources通過付費的方式使用資源f_005修改用戶信息modify user info修改已

16、經(jīng)注冊用戶的一些信息f_006用戶注冊registration用戶向站點注冊f_007資源評論resource evaluation注冊用戶對資源進行評論f_008資源搜索search resource通過輸入關(guān)鍵字搜索該資源站點中的資源f_009高級資源檢索advanced search通過組合的條件來精確檢索該資源站點中的資源f_010查看資源視圖view resource category tree通過系統(tǒng)提供的幾種方式來進行查看該資源站點中的資源視圖，用來加速資源的瀏覽f_011查看資源視圖中的資源列表view resource list in a selected category當

17、選定該資源站點中具體某一個資源視圖以后，可以查看該資源視圖下的所有資源，提供分頁方式f_012查看資源view resource通過下載查看該資源站點中的資源，包括查看資源的屬性信息和資源內(nèi)容f_013查看個人瀏覽資源歷史browsing history查看個人瀏覽資源的歷史記錄f_014用戶收藏范圍設(shè)置user favorite resource category setting用戶設(shè)置自己感興趣的資源的范圍，將來可以用來過濾資源，可以定購該范圍內(nèi)的資源。f_015站點書簽瀏覽web site bookmarks browsing瀏覽站點書簽f_016資源收藏管理user favorite

18、management用戶管理（添加、刪除、修改）收藏的資源信息f_017下載站內(nèi)資源downloading in the web site下載站點內(nèi)部的資源f_018查看資源的屬性信息（資源元數(shù)據(jù)）view resource mata data info. details查看資源的屬性信息（資源元數(shù)據(jù)）基本系統(tǒng)中的后臺維護f_019系統(tǒng)設(shè)置管理system setting management設(shè)置系統(tǒng)參數(shù)f_020永久資源存儲單元管理persistent resource storage location management管理放置永久資源的存儲單元f_021上載資源存儲單元管理upload

19、 resource storage location management管理放置上載資源的存儲單元f_022系統(tǒng)安全管理privilege/role/user management 權(quán)限、角色、用戶管理f_023資源提供商信息管理resource provider info. management對于資源提供商的信息、各種商業(yè)資源的信息進行管理f_024資源評論管理resource evaluation management資源審核員對用戶給資源的評論進行管理，可以進行置頂、刪除等操作。f_025資源專家評論resource evaluation by expert資源審核員可以對資源進行專

20、家評論f_026審核資源validate uploaded resource對于用戶上載的資源，審核員對資源進行審核，并把通過審核的資源關(guān)聯(lián)到適當?shù)馁Y源視圖。f_027地區(qū)用戶管理area user management地區(qū)管理員可以對該授權(quán)地區(qū)內(nèi)的用戶進行管理擴展系統(tǒng)中的前臺應(yīng)用f_028分布式系統(tǒng)中的資源瀏覽browsing distributed resource mata data info(extend system)依舊包含了查看資源視圖、查看資源視圖中的資源列表、查看資源等功能模塊，但是對基本系統(tǒng)中的資源瀏覽進行了擴充f_029分布式系統(tǒng)中的查看資源視圖view distribu

21、ted resource category tree (extend system)擴充了基本系統(tǒng)中查看資源視圖的功能，如果該站點是資源中心，那么能夠查看整個資源網(wǎng)中的資源視圖f_030分布式系統(tǒng)中的查看資源視圖中的資源列表view distributed resource list in a selected category(extend system)擴充了基本系統(tǒng)中查看資源視圖中的資源列表的功能，如果該站點是資源中心，那么可以查看該資源視圖下的整個資源網(wǎng)中的資源列表f_031分布式系統(tǒng)中的下載資源downloading across web sites(extend system)擴充

22、了基本系統(tǒng)中下載資源的功能，能夠跨資源站點下載資源f_032分布式系統(tǒng)中的資源檢索search distributed resource擴充了基本系統(tǒng)中資源搜索功能，能夠搜索整個資源網(wǎng)中的所有資源f_033分布式系統(tǒng)中的高級檢索advanced distributed search擴充了基本系統(tǒng)中的高級搜索功能，能夠通過組合條件精確搜索整個資源網(wǎng)中的所有資源擴展系統(tǒng)中的后臺維護f_034資源導入resource batch import批量導入符合標準的海量資源到本地資源站點f_035資源導出resource batch export將本地海量資源導出為符合標準的格式f_036資源站點注冊與注

23、銷web site registration / un-registration在站點注冊中心注冊/修改/注銷某個資源站點的信息f_037資源同步resource mata data synchronization將某個/某些資源站點的資源屬性信息同步到資源中心f_038站點書簽同步web site bookmarks synchronization將某個/某些資源站點的站點書簽信息同步到資源中心f_039資源訂閱mailing new resource subscription 系統(tǒng)將系統(tǒng)新增的資源按照用戶設(shè)置給用戶發(fā)送新增資源列表f_040網(wǎng)絡(luò)資源搜索internet searching定

24、時監(jiān)視某些指定的internet站點，將其最新的教育教學方面的信息采集到資源站點中2.5功能需求與程序的關(guān)系批量導入程序 resimporter.jar run.bat(windows) run.sh (aix,linux)批量導出程序resexporter.exe標準轉(zhuǎn)換程序 rdf2xml.exe資源同步客戶端ressyn.exe/ressyn.jar資源站點服務(wù)程序resapps.ear內(nèi)含n resourceinventoryejbs.jarn allsessionbeans.jarn ressynweb.warn resuddi.warn webprjs.war2.6人工處理過程2.

25、7尚未問決的問題3接口設(shè)計3.1用戶接口3.2外部接口（1）同步接口(通過輸出為web service接口)public static long getallrescount(stringstruser, stringstrpasswd, stringstrreqip)取得某個資源站點的所有有效資源數(shù)目，傳入?yún)?shù)為用戶名,密碼和請求者的ip public static string getallressepguid(stringstruser, stringstrpasswd, longlngblockcount, stringstrreqip)所有資源的guid要分多次返回,返回的數(shù)組為分次

26、返回的間隔條件,數(shù)組的大小與傳入的參數(shù)大小相同,表示要分多少次返回，由于我們認為最小值為空” ”,所以傳回的數(shù)組為第一個間隔到最大值，也就是說不包括” ” public static string getallresblockguid(stringstruser, stringstrpasswd, stringstrstartguid, stringstrendguid, stringstrreqip)取得某個區(qū)間的所有資源的guid,傳入?yún)?shù)表示范圍,返回的guid需要大于startguid,需要小于或者等于endguid public static long getupdaterescou

27、nt(stringstruser, stringstrpasswd, stringstrlastupdatetime, stringstrcurupdatetime, stringstrreqip)取得需要修改的資源數(shù)目,需要傳入上次更新的時間,由于兩臺機器的系統(tǒng)時間不同,所以也需要傳入更新截至時間,該時間用作下次參數(shù)的上次更新時間,資源站點返回的是在這段時間內(nèi)修改的資源紀錄,等于這兩個時間也滿足條件 public static string getupdateressepguid(stringstruser, stringstrpasswd, longlngblockcount, strin

28、gstrlastupdatetime, stringstrcurupdatetime, stringstrreqip)分次返回需要修改的資源的guid的分割字符串, 與getallressepguid類似public static string getupdateresblockguid(stringstruser, stringstrpasswd, stringstrstartguid, stringstrendguid, stringstrlastupdatetime, stringstrcurupdatetime, stringstrreqip)返回某個區(qū)間內(nèi)資源的guidpublic

29、static element getresitemelement(stringstruser, stringstrpasswd, stringstrresguid, stringstrreqip)返回某個資源的所有屬性public static byte getrescontent(stringstruser, stringstrpasswd, stringstrresguid, stringstrreqip)返回某個資源的文件內(nèi)容，該接口是可選的，資源站點可以根據(jù)自己的情況是否實現(xiàn) public static long getdelrescount(stringstruser, string

30、strpasswd, stringstrlastupdatetime, stringstrcurupdatetime, stringstrreqip)取得需要刪除的資源數(shù)目,需要傳入上次更新的時間,由于兩臺機器的系統(tǒng)時間不同,所以也需要傳入更新截至時間,該時間用作下次參數(shù)的上次更新時間,資源站點返回的是在這段 時間內(nèi)修改的資源紀錄,等于這兩個時間也滿足條件 public static string getdelressepguid(stringstruser, stringstrpasswd, longlngblockcount, stringstrlastupdatetime, string

31、strcurupdatetime, stringstrreqip)返回需要刪除的資源的guid的分割字符串 public static string getdelresblockguid(stringstruser, stringstrpasswd, stringstrstartguid, stringstrendguid, stringstrlastupdatetime, stringstrcurupdatetime, stringstrreqip)返回某個區(qū)間內(nèi)需要刪除的資源的guid （2）異構(gòu)資源互換接口(a）rdf格式資源接口rdf格式資源，即符合基礎(chǔ)教育教學資源元數(shù)據(jù)規(guī)范要求的資源

32、屬性描述文件，現(xiàn)在已知的支持該格式的資源提供商有國之源公司。格式如下：國之源兵蟻和蟻后file10001000215304113.jpg以白蟻為例講述昆蟲綱的主要特征或講述動物的社群行為。zh媒體素材-圖形（圖像）類素材商業(yè)收費基礎(chǔ)教育教學元數(shù)據(jù)規(guī)范(berms)zh0image/jpeg2002-3-21 18:15:35動物的行為社群行為昆蟲昆蟲綱節(jié)肢動物門自然科學-生物-動物的運動和行為-動物的行為-動物行為的類型北京國之源軟件技術(shù)有限公司學生教師初中教育普通中等教育7年級8年級9年級普通中等教育-自然科學-生物-動物的運動和行為-動物的行為-動物行為的類型103814n已審核pict022.jpg上述格式中粗體字為國之源公司對該格式的擴展部分。我們需要能夠解析這樣格式的資源元數(shù)據(jù)，能夠通過某種途徑將這種屬性描述