分布式资源网平台概要设计说明书.docx
《分布式资源网平台概要设计说明书.docx》由会员分享，可在线阅读，更多相关《分布式资源网平台概要设计说明书.docx（30页珍藏版）》请在冰豆网上搜索。
分布式资源网平台概要设计说明书
1引言2
1.1编写目的2
1.2背景2
1.3定义2
1.4参考资料2
2总体设计2
2.1需求规定2
2.2运行环境2
2.3基本设计概念和处理流程3
2.4结构3
2.5功能器求与程序的关系3
2.6人工处理过程3
2.7尚未问决的问题3
3接口设计3
3.1用户接口3
3.2外部接口3
3.3内部接口4
4运行设计4
4.1运行模块组合4
4.2运行控制4
4.3运行时间4
5系统数据结构设计4
5.1逻辑结构设计要点4
5.2物理结构设计要点4
5.3数据结构与程序的关系4
6系统出错处理设计5
6.1出错信息5
6.2补救措施5
6.3系统维护设计5
概要设计说明书
1引言
1.1编写目的
该文档描述了针对用户需求系统的概要情况，本文档适用于用户业务专家（专指在教育教学资源建设方面的业务专家）、软件系统分析员以及软件测试人员。
1.2背景
说明：
a.该软件系统名称为深圳市教育资源网系统（ShenZhenEducationResourceNetwork，简称为SZERNET）。
b.该系统由深圳市电化教育馆提出需求，由北京师范大学现代化教育技术研究所、北京市校际通信息技术有限公司、深圳市电化教育馆联合开发，软件开发完成以后，在深圳市电化教育馆的计算机中心机房运行。
1.3定义
⏹资源元数据：
描述一条资源的各类属性信息，叫资源元数据。
⏹资源属性：
即资源元数据，教育教学过程中、以及资源使用过程中人们的口头语。
⏹资源文件：
资源的物理存在方式，例如一个磁盘文件（目前最为普通的方式）。
⏹资源站点：
提供资源访问功能的站点叫资源站点。
资源站点的概念是相对的，不是绝对的。
⏹资源站点之间的互操作：
资源站点之间不是独立的，而是能够通过某些公用的接口，来进行透明化的数据交流，这样的关系叫做资源站点之间的互操作。
⏹资源网：
将多个资源站点连接在一起，成树状结构，提供资源站点的互操作，这样的体系叫做资源网。
⏹站点注册中心：
用来维护资源网中，各个资源站点之间的关系的某类特殊站点，叫做站点注册中心。
⏹资源同步：
通过某种公用的接口，来将某个资源站点（或者某批资源站点）的资源元数据的信息汇集到资源中心（前提是这些资源站点必须已经向该资源中心的站点注册中心注册过），并且保持这些资源元数据的同步，这个过程叫做资源同步。
资源同步并不将所有的资源文件同步到资源中心去。
⏹资源中心：
配置有站点注册中心等能够对其范围内的资源站点间发出资源同步请求的资源站点，叫做资源中心。
资源中心不是绝对的，而是相对的。
⏹系统管理员：
资源站点或者资源中心的管理员，最高权限者。
⏹资源审核专家：
对资源进行审核的人，还能对资源进行管理，但往往只能对某类资源进行该操作。
⏹地区管理员：
能够对位于某地区的用户进行管理。
⏹资源同步管理员：
能够对资源同步过程中进行控制的人，在资源站点，该管理员能够将这个资源站点的信息注册、修改、注销在站点注册中心上，在资源中心，该管理员能够设置各种同步所属资源站点资源的各种开关，并发出开始、停止同步命令。
⏹资源导入导出人员：
能够将资源导入、导出到资源站点。
⏹访客guest：
没有注册的系统使用者，很多功能受到限制。
例如，不能拥有自己的收藏夹，不能上传资源、不能设置自己喜欢的资源范围等。
⏹资源视图：
某种类别的资源分类，用来关联一批资源和资源视图，方便终端用户的使用。
资源视图与资源的物理存放没有关系。
⏹存储单元：
在服务器端真正保存资源的最小管理单位。
⏹永久资源（正式资源）：
已经经过审核的资源，可能是上传的资源已经通过了审核，也可能是导入的资源已经通过了审核。
⏹上载资源：
用户通过http协议，上传一条资源，在没有得到资源审核专家的审核以前，该资源叫上载资源。
⏹临时资源：
上载资源或者永久资源，被删除以后，叫做临时资源。
在以后系统扩展的时候，可以用来实现“回收站”功能，来回收被错误删除的资源。
⏹同步系统：
对资源同步服务器端和资源同步客户端程序的统称，该系统能够将资源元数据同步到资源中心来。
1.4参考资料
a.合同；开发计划书；
b.国家标准化委员会资源属性标注
⏹:
8082/celtsc/
⏹CELTS-3
⏹CELTS-41
c.软件开发标准
J2EE规范1.2
《SoftwareEngineering–APractitioner’sApproach,FourthEdition》
《J2EE服务器端高级编程》
d.
2总体设计
2.1需求规定
说明对本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见附录C。
输入/输出项目
描述
性能要求
资源导入
能够将基于国家标准资源描述的资源导入到本系统，至少需要支持两种格式：
⏹北京校际通公司的资源描述格式
⏹标委会的资源描述格式
能够在服务器端处理海量资源。
资源导出
能够将本系统中的资源导出为北京校际通公司的资源描述格式。
（考虑到保护资源提供上的版权，我们不提供导出为基于标委会的资源描述格式的资源的功能）
能够在服务器端处理海量资源。
资源同步的服务器端接口
能够对资源同步的请求进行响应，将本地资源的属性信息通过网络进行发送，该接口为WebService接口。
能够在服务器端长时间处理海量资源，后台运行，不要求高性能。
2.2运行环境
本系统对硬件环境的需求推荐：
数据库服务器 2~4路CPU，频率在700M以上，内存4G
应用服务器 2~４路CPU，频率在700M以上，内存8G
本系统运行操作系统推荐：
本系统可以运行在主流操作系统之上，例如，Unix（IBMAIX4.3.3）,Linux（RedHat7.2）,Windows（Windows2000Server）。
推荐使用IBMAIX4.3.3。
本系统运行软件：
数据库：
采用Oracle9iEnterprise
应用服务器：
采用WebSphereApplicationAdvancedServer,Edition4（FixPack4以上）
推荐数据库服务器和应用服务器运行在单独的服务器上。
2.3基本设计概念和处理流程
系统基本设计概念
（1）编程框架
在J2EE开发规范的基础上，我们采用IBM的BusinessFramework开发框架（4层开发体系），所有表现层都采用JSP来进行显示，所有的流程控制都采用Servlet来完成（充分利用MVC的开发模式），对于用户需求中的每一个具体的使用案例的商务逻辑，我们都采用一个专门的CommandBean和一个SessionBean来对其进行包装，对于数据库的访问，在访问单条数据库记录（且限于单表的情况）的时候，我们采用EntityBean（这样做，我们能够大幅度提高开发效率），其他情况，为了提高访问效率，我们采用直接JDBC连接的方式来进行。
（2）系统体系划分
分布式资源网平台的开发需要按照三个步骤来进行。
⏹实现传统资源库功能的开发
采用传统的开发方式开发传统资源库的功能，例如，对资源的浏览、使用、收藏、下载等。
⏹定义资源库互操作的接口，并根据接口实现资源库服务器端功能
该服务器端能够对接口实行响应，以纯XML数据流或者WebService接口的方式来实现资源库之间互操作的接口。
⏹根据资源库互操作的接口实现资源库客户端的功能
更新传统资源库的实现方式，将需要资源库互操作的所有传统实现更新为针对纯XML流或者WebService接口的实现。
系统基本处理流程
（1）资源库中资源的建设问题
⏹允许普通用户通过HTTP协议远程上载资源。
⏹允许导入资源（用来满足用户购买商业教学资源的需求）。
这样的海量资源，在服务器端进行，要求程序运行稳定，性能优良，能够灵活配置，以适应各地的不同部署环境。
⏹必须考虑到将来的资源访问收费问题，必须留下实现该功能的足够接口。
（2）资源库中资源的管理问题
⏹在逻辑上，资源可以存放在三个地方，临时资源库（用来存放临时的资源，例如，删除的资源等），上载资源库（用户上载的资源，还没有通过审核的），永久资源库（用户购买的资源，用户上载并且经过审核的资源）。
⏹在物理上，资源存放在磁盘（阵列）上。
对于临时资源库，上载资源库，永久资源库来说，都需要一个资源存储管理系统，临时资源库对应着临时资源存储管理系统，上载资源库对应着上载资源存储管理系统，永久资源库对应着永久资源存储管理系统。
对于任何一个存储管理系统，应该提供建立/修改/删除单个存储单元或建立批量存储单元的功能。
⏹用户上载的资源首先保存在上载资源库，经过资源审核专家审核以后保存在永久资源库。
永久资源库和上载资源库里面的资源，审核专家或者资源管理员删除以后，保存在临时资源库。
⏹在分布式前提下，各个地方的资源是各自管理的。
2.4结构
（1）技术路线
（2）功能模块
基本系统之终端用户（主要功能模块）
图2.4.2.1基本系统之终端用户的前台使用
图2.4.2.2基本系统之终端用户的资源浏览
图2.4.2.3基本系统之终端用户的资源查看
基本系统之后台管理
图2.4.2.4基本系统之系统管理
图2.4.2.5基本系统之资源审核专家
图2.4.2.6基本系统之地区用户管理
扩展系统之终端用户
图2.4.2.7扩展系统之资源浏览
（1）
图2.4.2.8扩展系统之资源浏览
（2）
图2.4.2.9扩展系统之资源检索
扩展系统之后台管理
图2.4.2.10扩展系统之资源导入/导出
图2.4.2.10扩展系统之站点注册
图2.4.2.11扩展系统之后台服务
（3）每个系统元素的扼要说明
编号
系统元素名称
英文名称
扼要说明
基本系统用户/角色
A_001
终端用户
WebSiteUser
使用资源网的普通用户，包括注册用户和访客（GUEST）
A_002
系统管理员
SystemManager
系统后台维护人员，资源站点的最高权限者
A_003
资源审核专家
Expert
资源审核专家，能够对指定属性的资源进行资源管理、审核、专家评论
扩展系统用户/角色
A_004
地区管理员
AreaManager
能够对本资源站点该地区的注册用户进行管理、审核
A_005
资源导入/导出员
Importer/Exporter
能够将系统资源导出为标准的xml格式，也能将符合标准格式的xml资源导入到本资源站点
A_006
站点同步管理员
SiteSynchronizationManager
能够进行站点注册、审核、管理的站点注册中心管理人员。
基本系统中的前台应用
F_001
资源浏览系统
BrowsingResourceMataDataInfo.
浏览资源站点中的资源
F_002
用户通信模块
SendMessagestoothers
注册用户可以通过这个发消息模块，互相通信
F_003
资源上传
Upload
上载资源
F_004
购买资源
BuyResources
通过付费的方式使用资源
F_005
修改用户信息
ModifyUserInfo
修改已经注册用户的一些信息
F_006
用户注册
Registration
用户向站点注册
F_007
资源评论
ResourceEvaluation
注册用户对资源进行评论
F_008
资源搜索
SearchResource
通过输入关键字搜索该资源站点中的资源
F_009
高级资源检索
AdvancedSearch
通过组合的条件来精确检索该资源站点中的资源
F_010
查看资源视图
ViewResourceCategoryTree
通过系统提供的几种方式来进行查看该资源站点中的资源视图，用来加速资源的浏览
F_011
查看资源视图中的资源列表
ViewResourceListinaSelectedCategory
当选定该资源站点中具体某一个资源视图以后，可以查看该资源视图下的所有资源，提供分页方式
F_012
查看资源
ViewResource
通过下载查看该资源站点中的资源，包括查看资源的属性信息和资源内容
F_013
查看个人浏览资源历史
BrowsingHistory
查看个人浏览资源的历史记录
F_014
用户收藏范围设置
UserFavoriteResourceCategorySetting
用户设置自己感兴趣的资源的范围，将来可以用来过滤资源，可以定购该范围内的资源。
F_015
站点书签浏览
WebSiteBookmarksBrowsing
浏览站点书签
F_016
资源收藏管理
UserFavoriteManagement
用户管理（添加、删除、修改）收藏的资源信息
F_017
下载站内资源
DownloadingintheWebSite
下载站点内部的资源
F_018
查看资源的属性信息（资源元数据）
ViewResourceMataDataInfo.Details
查看资源的属性信息（资源元数据）
基本系统中的后台维护
F_019
系统设置管理
SystemSettingManagement
设置系统参数
F_020
永久资源存储单元管理
PersistentResourceStorageLocationManagement
管理放置永久资源的存储单元
F_021
上载资源存储单元管理
UploadResourceStorageLocationManagement
管理放置上载资源的存储单元
F_022
系统安全管理
Privilege/Role/UserManagement
权限、角色、用户管理
F_023
资源提供商信息管理
ResourceProviderInfo.Management
对于资源提供商的信息、各种商业资源的信息进行管理
F_024
资源评论管理
ResourceEvaluationManagement
资源审核员对用户给资源的评论进行管理，可以进行置顶、删除等操作。
F_025
资源专家评论
ResourceEvaluationbyExpert
资源审核员可以对资源进行专家评论
F_026
审核资源
ValidateUploadedResource
对于用户上载的资源，审核员对资源进行审核，并把通过审核的资源关联到适当的资源视图。
F_027
地区用户管理
AreaUserManagement
地区管理员可以对该授权地区内的用户进行管理
扩展系统中的前台应用
F_028
分布式系统中的资源浏览
BrowsingDistributedResourceMataDataInfo（ExtendSystem）
依旧包含了查看资源视图、查看资源视图中的资源列表、查看资源等功能模块，但是对基本系统中的资源浏览进行了扩充
F_029
分布式系统中的查看资源视图
ViewDistributedResourceCategoryTree（ExtendSystem）
扩充了基本系统中查看资源视图的功能，如果该站点是资源中心，那么能够查看整个资源网中的资源视图
F_030
分布式系统中的查看资源视图中的资源列表
ViewDistributedResourceListinaSelectedCategory（ExtendSystem）
扩充了基本系统中查看资源视图中的资源列表的功能，如果该站点是资源中心，那么可以查看该资源视图下的整个资源网中的资源列表
F_031
分布式系统中的下载资源
DownloadingacrossWebSites（ExtendSystem）
扩充了基本系统中下载资源的功能，能够跨资源站点下载资源
F_032
分布式系统中的资源检索
SearchDistributedResource
扩充了基本系统中资源搜索功能，能够搜索整个资源网中的所有资源
F_033
分布式系统中的高级检索
AdvancedDistributedSearch
扩充了基本系统中的高级搜索功能，能够通过组合条件精确搜索整个资源网中的所有资源
扩展系统中的后台维护
F_034
资源导入
ResourceBatchImport
批量导入符合标准的海量资源到本地资源站点
F_035
资源导出
ResourceBatchExport
将本地海量资源导出为符合标准的格式
F_036
资源站点注册与注销
WebSiteRegistration/Un-registration
在站点注册中心注册/修改/注销某个资源站点的信息
F_037
资源同步
ResourceMataDataSynchronization
将某个/某些资源站点的资源属性信息同步到资源中心
F_038
站点书签同步
WebSiteBookmarksSynchronization
将某个/某些资源站点的站点书签信息同步到资源中心
F_039
资源订阅
MailingNewResourceSubscription
系统将系统新增的资源按照用户设置给用户发送新增资源列表
F_040
网络资源搜索
InternetSearching
定时监视某些指定的Internet站点，将其最新的教育教学方面的信息采集到资源站点中
2.5功能需求与程序的关系
批量导入程序ResImporter.jar
run.bat（Windows）
run.sh（AIX,LINUX）
批量导出程序ResExporter.exe
标准转换程序RDF2XML.exe
资源同步客户端ResSyn.exe/ResSyn.jar
资源站点服务程序ResApps.ear
内含
⏹ResourceInventoryEJBs.jar
⏹AllSessionBeans.jar
⏹ResSynWeb.war
⏹ResUddi.war
⏹WebPrjs.war
2.6人工处理过程
2.7尚未问决的问题
3接口设计
3.1用户接口
3.2外部接口
（1）同步接口（通过输出为WebService接口）
publicstaticlonggetAllResCount（String strUser,
String strPasswd,
String strReqIp）
取得某个资源站点的所有有效资源数目，传入参数为用户名,密码和请求者的ip
publicstaticString[]getAllResSepGuid（String strUser,
String strPasswd,
long lngBlockCount,
String strReqIp）
所有资源的guid要分多次返回,返回的数组为分次返回的间隔条件,数组的大小与传入的参数大小相同,表示要分多少次返回，由于我们认为最小值为空””,所以传回的数组为第一个间隔到最大值，也就是说不包括””
publicstaticString[]getAllResBlockGuid（String strUser,
String strPasswd,
String strStartGuid,
String strEndGuid,
String strReqIp）
取得某个区间的所有资源的guid,传入参数表示范围,返回的guid需要大于startguid,需要小于或者等于endguid
publicstaticlonggetUpdateResCount（String strUser,
String strPasswd,
String strLastUpdateTime,
String strCurUpdateTime,
String strReqIp）
取得需要修改的资源数目,需要传入上次更新的时间,由于两台机器的系统时间不同,所以也需要传入更新截至时间,该时间用作下次参数的上次更新时间,资源站点返回的是在这段时间内修改的资源纪录,等于这两个时间也满足条件
publicstaticString[]getUpdateResSepGuid（String strUser,
String strPasswd,
long lngBlockCount,
String strLastUpdateTime,
String strCurUpdateTime,
String strReqIp）
分次返回需要修改的资源的guid的分割字符串,与getAllResSepGuid类似
publicstaticString[]getUpdateResBlockGuid（String strUser,
String strPasswd,
String strStartGuid,
String strEndGuid,
String strLastUpdateTime,String strCurUpdateTime,
String strReqIp）
返回某个区间内资源的guid
publicstaticElementgetResItemElement（String strUser,
String strPasswd,
String strResGuid,
String strReqIp）
返回某个资源的所有属性
publicstaticbyte[]getResContent（String strUser,
String strPasswd,
String strResGuid,
String strReqIp）
返回某个资源的文件内容，该接口是可选的，资源站点可以根据自己的情况是否实现
publicstaticlonggetDelResCount（String strUser,
String strPasswd,
String strLastUpdateTime,
String strCurUpdateTime,
String strReqIp）
取得需要删除的资源数目,需要传入上次更新的时间,由于两台机器的系统时间不同,所以也需要传入更新截至时间,该时间用作下次参数的上次更新时间,资源站点返回的是在这段时间内修改的资源纪录,等于这两个时间也满足条件
publicstaticString[]getDelResSepGuid（String strUser,
String strPasswd,
long lngBlockCount,
String strLastU
升级会员 