CMS项目概要设计文档.docx
《CMS项目概要设计文档.docx》由会员分享，可在线阅读，更多相关《CMS项目概要设计文档.docx（13页珍藏版）》请在冰豆网上搜索。
CMS项目概要设计文档
CSSP_CMS
网站开发概要设计说明书
长沙园有限公司
信息中心
文档历史
日期
作者
版本
描述
2006-1-6
谢平
1.0.0
建立文档结构
2006-1-8
谢平
1.0.1
编写总体设计、接口设计、运行设计、系统数据结构设计、系统出错处理设计；
1引言
1.1编写目的
本文描述CSSP_CMS网站的概要设计，以作为详细设计以及系统实现的依据。
（本项目为长沙软件园门户网站项目内容发布子项目）
1.2背景
长沙国家软件产业基地、长沙863软件专业孵化器的建设不断完善，各种服务也逐步对外开放，目前长沙软件园的静态网站系统，存在如下问题，不能满足要求：
1.目前的静态网站，不能集中体现软件园的服务和品牌形象。
现在的网站上只是简单地把内容收集在上面，显得过于单一和单板，信息过于平面化，不能满足现在园内业务的需要，实效性差，软件园的整体形象没有在门户上体现。
2.目前软件园的系统过于单一，部分业务需要门户系统支撑。
长沙软件园目前已有863门户系统（包括资源库、构件库系统、项目管理系统）、视频点播系统、IDC服务系统，缺乏统一的对外服务门户；同时随着教育培训实训基地、软件评测中心的建设，急需统一的对外服务门户系统的支撑；软件企业作为高新技术企业的子集，与高新区门户系统需要统一设计。
3.需要与高新区、麓谷形象，政务公开，企业交流保持一致。
为更好地为企业提供更多的资源和服务，目前单一的静态网站无法满足需求；需要面向企业提供包括专家资源、项目资源、统一交流平台等服务。
4.无法满足招商引资的需要。
1.3定义
：
长沙软件园有限公司网址。
1.4参考资料
列出有关的参考文件，如：
a.本项目的经核准的计划任务书或合同，上级机关的批文；
b.属于本项目的其他已发表文件；
本文件中各处引用的文件、资料，包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2总体设计
2.1需求规定
（说明对本系统的主要的输入输出项目、处理的功能性能要求。
）
WEB服务器：
Tomcat+apache结合。
Tomcat解析JSP/Servlet，Apache解析静态HTML文件；
数据库：
ORACLE9i；
JAVA开发工具：
JBuilderX。
JBuilder提供图形使用者接口以简化组件文件strutsconfig.xml编辑与设定，此外，JBuilder于ObjectGallery对话框内的Web页次，提供四种向导以简化Struts开发流程；或者采用Eclipse插件；
页面开发工具：
MacromediaDreamweaverMX2004；
UML设计：
RationalROSE；
数据库设计：
PowerDesigner9；
项目计划：
Project2003；
版本管理：
VSS6；运行环境
2.2运行环境
WEB服务器：
CPU：
3.0G以上，内存1G以上；操作系统WINDWOS2000SERVER/2003SERVER，或者LINUX/UNIX；web应用服务器：
tomcat、weblogic等；
数据库服务器：
CPU：
3.0G以上，内存1G以上；操作系统WINDWOS2000SERVER/2003SERVER，或者LINUX/UNIX；数据库：
ORACLE9i
说明本系统的基本设计概念和处理流程，尽量使用图表的形式。
2.3基本设计概念和处理流程
2.3.1用户角色模型
说明：
网站用户角色分为：
注册用户（能使用其他子系统提供的平台管理功能），游客（仅能浏览信息，并发布留言或评论）；
管理员：
超级管理员（初始化系统，分配用户角色及操作权限），系统管理员（按照超级管理员分配的权限管理相关功能），网络编辑（发布新闻内容）；
2.3.2用例
用例描述：
●新闻采用在线编辑器,可以象使用word一样编辑新闻;
●可web上传图片,新闻内其它网站图片自动下载;
●无限级目录分类;
●可设头条新闻和图片新闻;
●新闻点评功能，可自由发表评论;
●权限管理可以任意设置角色;
●采用MVC模式显示与逻辑分离,方便修改页面显示效果;
●支持多界面风格,只需增加相应的风格包;
●支持国际化多语言,只需要增加响应语言包;
●支持多种数据库,Oracle,SqlServer,Mysql;
●支持全文索引,检索速度更快更准确;
●支持rss新闻聚合
●自带留言簿
2.4结构
2.4.1项目框架模型
从架构图中可以看出系统分为四层：
ØUI层：
借助Struts实现。
用ActionForm类封装与用户互动的数据元素；用Action类实现业务逻辑、动作处理、链接转向。
实现MVC中的C；借助Struts标签来完成数据呈现，实现MVC中的V。
Ø业务层：
借助SpringFramework进行业务组件的组装关联。
实际的项目开发中，每个领域都会有自己独特的业务逻辑，正因为这样，致使项目中代码高度耦合，原本有可能被重用的代码或功能，因为与具体的业务逻辑绑定在一块而导致很难被重用。
因此我们将实现这些具体逻辑的代码抽取出来分为单独的一层，其目的是希望通过层，来降低它与系统其他部分的耦合度。
通过依赖注入、AOP应用、面向接口编程，来降低业务组件之间的耦合度，增强系统扩展性。
Ø数据持久层：
借助Hibernate实现。
实现了数据库访问性能优化和与数据库交互的常用操作（CRUD），还将数据表与对象进行了关联，让我们可以脱离数据表，而直接针对对象来与数据库交互，我们不再需要用字符串去描述表中字段，不再需要组装Sql语句。
Ø域对象层：
将所有域对象划分在一个层面。
该层应该说是ORM思想的产物，ORM用对象关联数据表，我们将这些对象的集合归为一个专门的层DomainLayer。
域对象是各层之间数据通信的载体。
实际上域对象也是一个完完全全的业务对象，如User对象、Book对象。
通过对业务的对象化，这有利于业务逻辑的重用。
为什么采用这样的四层架构？
Ø通过成熟的开源产品实现各层，同自己编写代码实现，相比之下能缩短开发周期，且架构所用到的开源产品均有很广泛的用户群，经受过实践的考验，质量和性能更有保障；
Ø层与层之间松散耦合，增加代码重用率；
Ø各层分工明确，这样也利于团队的明确分工；
2.4.2包结构划分
2.4.3Web目录结构划分
config
放置后台管理JSP页面，可根据具体模块划分子目录
css
CSS文件存放
error
出错显示页面
file
上传文件存放目录，需考虑文件负载均衡
general
存放公用JSP页面，可根据具体模块划分子目录
images
图片存放目录，可根据具体模块划分子目录
js
Javascript文件及Jscript文件存放目录，可根据具体模块划分子目录
module
的静态HTML插件模块，可根据具体模块划分子目录
WEB-INF
后台类、包、TLD、配置文件……
2.4.4公用模块
2.4.4.1com.cssp.cms.web.servlet包
2.4.4.2com.cssp.cms.web.tag包
m.db包
m.util包
m.web包
2.4.4.6net.sf.hibernate.id包
2.5功能器求与程序的关系
2.6人工处理过程
说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。
2.7尚未解决的问题
说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
3接口设计
3.1用户接口
说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。
ApplicationResources.properties统一定义后台回答信息；
JS中统一定义页面回答信息；
3.2外部接口
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。
3.3内部接口
说明本系统之内的各个系统元素之间的接口的安排。
4运行设计
4.1运行模块组合
说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。
4.2运行控制
说明每一种外界的运行控制的方式方法和操作步骤。
4.3运行时间
说明每种运行模块组合将占用各种资源的时间。
5系统数据结构设计
5.1逻辑结构设计要点
给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。
5.1.1CSSP_TABLEID最大关键字存储表
字段名
类型
空
默认
含义
ID
VARCHAR2（50）
N
表名主键
IDVALUE
NUMBER（19,0）
1
最大关键字
5.1.2CSSP_WEB.CSSP_USERINFO用户表
字段名
类型
空
默认
含义
USERID
NUMBER（19,0）
N
1
用户ID，关键字
USERNAME
VARCHAR2（32）
N
用户登陆名
PASSWORD
VARCHAR2（32）
N
密码，MD5加密
NICKNAME
VARCHAR2（100）
N
昵称
USERDUTY
VARCHAR2（200）
用户权限，对应权限配置文件
SEX
CHAR
（2）
性别
BIRTHDAY
NUMBER（19,0）
生日，日期转换为数字型
HOMEADDRESS
VARCHAR2（200）
住址
POST
VARCHAR2（50）
邮编
PHONE
VARCHAR2（50）
联系电话
MOBILEPHONE
VARCHAR2（50）
移动电话
MAILADDRESS
VARCHAR2（50）
EMAIL
OICQNO
VARCHAR2（50）
OICQ
MSN
VARCHAR2（50）
MSN
USERTEXT
VARCHAR2（256）
用户说明
5.1.3CSSP_CONTENTTYPE发布类别表
字段名
类型
空
默认
含义
TYPEID
NUMBER（19,0）
N
类别ID，关键字
PARENTID
NUMBER（19,0）
N
0
父ID，0为根结点
TYPENAME
VARCHAR2（50）
N
类别名称
TYPETEXT
VARCHAR2（256）
类别说明
ISPUBLIC
NUMBER（5,0）
N
1
是否公开
ORDERS
VARCHAR2（4）
排序字段
SUBTYPENUM
NUMBER（19,0）
0
子类别数量
RSSPATH
VARCHAR2（256）
RSS文件路径
5.1.4CSSP_FILESINFO文件存储表
字段名
类型
空
默认
含义
FILESID
NUMBER（19,0）
N
文件ID，关键字
FILESNAME
VARCHAR2（256）
N
文件名
FILESPATH
VARCHAR2（256）
N
文件存储相对路径
FILESSIZE
NUMBER（19,0）
N
文件大小
UPDATETIME
NUMBER（19,0）
上传日期，日期转换整型
FILESEXPLAIN
VARCHAR2（256）
文件说明
FILESEXTNAME
VARCHAR2（10）
文件扩展名
5.1.5CSSP_CONTENTINFO发布内容表
字段名
类型
空
默认
含义
CONTENTID
NUMBER（19,0）
N
内容ID，关键字
CONTENTTITLE
VARCHAR2（100）
N
内容标题
CONTENTTEXT
VARCHAR2（256）
内容正文
FILESINFO
VARCHAR2（200）
附加文件，多个用“,”分割
BEGINDATE
NUMBER（19,0）
N
发布日期
ORDERS
VARCHAR2（4）
‘XXXX’
排序字段
USERID
NUMBER（19,0）
N
发布人ID
CLICKNUM
NUMBER（19,0）
N
0
点击次数
TYPEID
NUMBER（19,0）
N
类别ID
REALTIME
NUMBER（19,0）
N
实际发布时间
CONTENTSIZE
NUMBER（19,0）
N
内容字数大小
CONTENTEXCERPT
VARCHAR2（256）
内容摘要
5.1.6CSSP_CONTENTCOMMENT评论表
字段名
类型
空
默认
含义
CONTENTID
NUMBER（19,0）
N
内容ID
COMMENTTIME
NUMBER（19,0）
N
Today
评论日期
COMMENUSERNAME
VARCHAR2（100）
N
评论人
CONTENTCOMMENT
VARCHAR2（200）
N
评论内容文件路径，用XML文件存储
5.2物理结构设计要点
给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。
5.3数据结构与程序的关系
说明各个数据结构与访问这些数据结构的形式:
1）数据库访问采用连接池和JDBC方式；
2）配置信息采用xml文件，以JDOM读取及修改（系统配置信息须重启服务）；
3）耦合比较小的信息（如个人留言版）采用XML文件形式存取；
4）用户上传文件采用数据表记录路径方式存取；
5）发布内容采用XML文件方式存储，XML数据岛方式读取；
6系统出错处理设计
6.1出错信息
用一览表的方式说朗每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。
6.2补救措施
说明故障出现后可能采取的变通措施，包括：
a.后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；
b.降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；
c.恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。
6.3系统维护设计
说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。
各个程序之间的对应关系；
升级会员 