详细设计说明书-模板

｛项目名称｝

详细设计说明书

编 号

文件状态

□ 征求意见稿

 正式发布

当前版本

拟 制 人

审 核 人

批 准 人

完成日期

｛项目名称｝详细设计说明书

版 本 历 史

版本

作 者 参与者

起止时间

备 注

｛项目名称｝详细设计说明书

目 录

1. 引言 ..................................................................................................................................................... 1

1.1编写目的 ........................................................................................................................................ 1

1.2项目背景 ........................................................................................................................................ 1

1.3参考资料 ........................................................................................................................................ 1

2.1 项目现状 ........................................................................................................................................... 2

2.2建设目标 ........................................................................................................................................ 2

2.3建设内容 ........................................................................................................................................ 2

2.4功能需求 ........................................................................................................................................ 2

2.5非功能需求 .................................................................................................................................... 2

3. 总体设计 ............................................................................................................................................. 3

3.1

体系结构 ....................................................................................................................................... 3

3.2逻辑架构 ........................................................................................................................................ 3

3.2.1分层架构模型 ......................................................................................................................... 3

3.2.2组件架构模型 ......................................................................................................................... 3

3.2.3数据流转模型 ......................................................................................................................... 4

3.3包结构设计 .................................................................................................................................... 4

3.3.1……包介绍 .............................................................................................................................. 4

3.3.2……包介绍 .............................................................................................................................. 5

3.3.3……包介绍 .............................................................................................................................. 6

3.3.4页面资源介绍 ......................................................................................................................... 6

3.3

软件功能结构设计 ....................................................................................................................... 8

3.4

系统运行环境 ............................................................................................................................... 9

3.5

标准性与扩展性 ........................................................................................................................... 9

4．功能设计 .......................................................................................................................................... 11

4.1

……功能设计 .............................................................................................................................. 11

4.1.1业务流程设计 ....................................................................................................................... 11

4.1.2功能概述 ............................................................................................................................... 11

4.1.3主要功能模块设计 ............................................................................................................... 11

5．非功能性设计 .................................................................................................................................. 11

5.1系统接口设计 .............................................................................................................................. 11

5.1系统集成设计 .............................................................................................................................. 11

5.2系统配置设计 .............................................................................................................................. 11

5.3

系统安全设计 ............................................................................................................................. 11

5.4系统部署方案设计 ...................................................................................................................... 11

｛项目名称｝详细设计说明书 第1页

1. 引言

1.1编写目的

本文档描述了维护审批程序设计人员对该程序总体框架的设计方案，用于指导程序开发人员进行编码设计开发，并且帮助后续升级维护人员了解掌握该程序的设计思路。用户也可以通过该文档更深一步的了解该程序。

1.2项目背景

1.3参考资料

 《……项目项目任务书》2014-06-01

 《……项目任务书-1.0版》2013-11-18

｛项目名称｝详细设计说明书

2. 项目概述

2.1 项目现状

2.2建设目标

2.3建设内容

2.4功能需求

2.5非功能需求

(1) 可用性：系统应操作简单、实用高效、好记易学、少错和令人满意，具备较高的可用性；

(2) 可靠性：系统应经过完善的设计和充分的测试运行，具备在较长时间内连续无故障的运行能力；

(3) 健壮性：系统应具备较强的容错、数据恢复与稳定运行的能力。

(4) 扩展性：……。

｛项目名称｝详细设计说明书

3. 总体设计

3.1 体系结构

3.2逻辑架构

本系统核心架构为FreeMarker+hibernate+Spirng的mvc分层架构。

3.2.1分层架构模型

3.2.2组件架构模型

客户层FreeMarkerJQueryHTML5JSON展现层TAGSpringMVCDWRDom4J业务层（含持久层）Spring3LuceneHibernate3基础设施层CSS3Commons-fileuploadJavaMailLog4J

Commons-ioJUnitXfireCommons-nethtmlparserHttpClientJTAQuartzJmagickC3P0SLF4JEhCacheAntJDBC Driver

｛项目名称｝详细设计说明书

3.2.3数据流转模型

3.3包结构设计

3.3.1……包介绍

具体包名

comjeecmscms

comjeecmscmsaction

comjeecmscmsactionadmin

comjeecmscmsactionadminassist

comjeecmscmsactionadminmain

comjeecmscmsactiondirective

comjeecmscmsactiondirectiveabs

comjeecmscmsactionfront

comjeecmscmsdaoassist

comjeecmscmsdaoassistimpl

comjeecmscmsdaomain

comjeecmscmsdaomainimpl

comjeecmscmsentityassist

comjeecmscmsentityassistbase

相关功能描述

常量包

通用action抽象类包

后台欢迎页的action

后台辅助包

后台核心功能包

cms自定义标签包,公用部分继承于abs包

公用部分自定义标签的抽象包

前台action包

会员中心包

辅助dao的接口层

辅助dao的接口实现层

核心的dao接口层

核心的dao接口实现层

cms辅助实体类子类

cms辅助实体类基类

｛项目名称｝详细设计说明书

comjeecmscmsentityassisthbm

comjeecmscmsentityback

comjeecmscmsentitybackbase

comjeecmscmsentitybackhbm

comjeecmscmsentitymain

comjeecmscmsentitymainbase

comjeecmscmsentitymainhbm

comjeecmscmslucene

comjeecmscmsmanagerassist

comjeecmscmsmanagerassistimpl

comjeecmscmsmanagermain

comjeecmscmsmanagermainimpl

comjeecmscmsservice

comjeecmscmsstaticpage

comjeecmscmsstaticpageexception

comjeecmscmsstatistic

comjeecmscmsstatisticworkload

comjeecmscmsweb

comjeecmscmstask

comjeecmscmstaskjob

hibernate辅助实体类的关系映射文件

cms备份实体类子类

cms备份实体类基类

hibernate备份实体类类的关系映射文件

cms核心实体类子类

cms核心实体类基类

hibernate核心实体类的关系映射文件

搜索引擎封装包

辅助的service接口层

辅助的service接口实现层

核心的service接口层

核心的service接口实现层

service封装层

静态页的封装包包

静态页的异常处理类型

内容发布统计包

流量统计包

拦截器包

任务包

具体任务包

3.3.2……包介绍

具体包名

comjeecmscommoncaptcha

comjeecmscommondic

comjeecmscommonemail

comjeecmscommonfck

comjeecmscommonfile

comjeecmscommonhibernate3

comjeecmscommonimage

comjeecmscommonipseek

comjeecmscommonlucene

comjeecmscommonoffice

comjeecmscommonpage

comjeecmscommonsecurity

comjeecmscommonsecurityannotation

comjeecmscommonsecurityencoder

comjeecmscommonsecurityrememberme

comjeecmscommonsecurityuserdetails

comjeecmscommonupload

相关功能描述

验证码封装包

分词

邮件包

fck编辑器封装包

文件操作封装包

hibeinate封装包

图片的封装包

ip地址库封装

收索引擎的基础包

文档转换相关工具类

jeecms分页封装包

安全认证相关的包

上传封装包

｛项目名称｝详细设计说明书

comjeecmscommonutil

comjeecmscommonweb

comjeecmscommonwebfreemarker

comjeecmscommonwebsession

comjeecmscommonwebsessioncache

comjeecmscommonwebspringmvc

comjeecmscmsmanagermain

comjeecmscmsmanagermainimpl

comjeecmscmsservice

comjeecmscmsstaticpage

comjeecmscmsstaticpageexception

comjeecmscmsstatistic

comjeecmscmsstatisticworkload

comjeecmscmsweb

工具包

常量包

freemarker视图封装包

session包

session缓存包

springMVC的简单封装

核心的service接口层

核心的service接口实现层

service封装层

静态页的封装包

静态页的异常处理类型

流量统计包

内容发布统计包

拦截器包

3.3.3……包介绍

具体包名

comjeecmscore

comjeecmscoreactionfront

comjeecmscoredao

comjeecmscoredaoimpl

comjeecmscoreentity

comjeecmscoreentitybase

comjeecmscoreentityhbm

comjeecmscoremanager

comjeecmscoremanagerimpl

comjeecmscoresecurity

comjeecmscoretpl

comjeecmscoreweb

comjeecmscorewebutil

相关功能描述

一般常量和异常处理

核心前台的action

核心dao的接口

核心dao的接口实现类

登录认证和核心用户的实体子类

登录认证和核心用户的实体基类

相关的hibernate的映射文件

核心的service接口层

核心的service接口实现层

认证登录、退出相关

模板接口和相关service层

定义内容显示的接口，工具类，和错误页面的指定

uri帮助类

3.3.4页面资源介绍

具体包名 相关功能描述

WebContent

r

res

thirdparty

前台资源文件，如css、img、js等

后台资源文件

第三方插件（ckeditor编辑器、swf上传、My97DatePicker日期

｛项目名称｝详细设计说明书

u

选择）

默认的用户上传资源目录

WebContent/WEB-INF

cache

common

config

directive

error

ftl

ispeek

jeecms_sys

缓存文件

通用页面

核心的配置文件，如果action，service,manager,dao,bean等

标签向导模板文件

错误页面

自定义的freemark宏文件

ip地址库

后台管理页面

account 账号绑定列表

acquisition 采集

admin 管理员

advertising 广告

advertising_space 广告版位

channel 栏目

comment 评论

common 公用错误页面

config 系统配置

content 内容

content_reuse 内容复用

data 数据备份

department 部门

dictionary 字典

directive 向导标签

file 文件

frame 框架集

friendlink 友情链接

friendlink_ctg 友情链接分类

ftp ftp

group 用户组

guestbook 留言

guestbook_ctg 留言分类

item 模型字段

keyword 关键词

log 日志

lucene 全文检索

member 会员

menu 自定义菜单

message 短消息

model 模型

｛项目名称｝详细设计说明书

languages

lucene

t/cms

t/cms/www

t/cms/www/plan

origin

personal

plug

resource

role

scoregroup

scoreitem

searchwords

sensitivity

site

site_config

static

statistic

tag

template

topic

type

visual

unified_user

vote_topic

workflow

workflowRecord

国际化配置

jeecms/admin

jeecms/front

jeecms/tpl

jeecore/admin

lucene文件夹

前台模板页面

站点资源目录

站点方案

来源

个人中心

插件

资源

角色

评分组

评分项

搜索词

敏感词

站点

站点配置

静态化

浏览统计

Tag关键词

模版

专题

内容类型

可视化编辑

用户

投票

工作流

工作流记录

后台

前台

模版

公用国际化

3.3 软件功能结构设计

……的功能描述如下表所示，其详细功能介绍请参见后面几章内容介绍。

子系统 功能描述

｛项目名称｝详细设计说明书

模块1 (1) 项目组公告通知及工作动态

(2) 项目成果展示

(3) 各农村人居环境改善标准化试点单位的宣传与展示

(4) 其它媒体、部门与本项目相关的信息整理与发布

(5) 相关新闻资讯发布

模板2

{项目名称}

(1) 内部讨论、互动交流

(2) 文件共享

(3) 网站视频会议

模板3 (1) 农村人居环境改善标准化试点单位运转情况上报

(2) 用农村人居环境改善标准化试点单位上报数据指标提取

(3) 各类地方标准分类上传共享

(4) 试点单位工作动态、年终考核与项目验收上报

(5) 上报数据统计分析为决策服务

(6) 国家标准委管理、跟踪各试点单位工作情况

3.4 系统运行环境

服务器操作系统

数据库管理系统（DBMS）

Web服务器

客户端操作系统

客户端Web浏览器

网络传输协议

Windows 2008 Server

MYSQL 5.6

Apache Tomcat 7.X

Windows 9X/2000/NT Workstation系列

IE7.0以上或firefox 等主流浏览器

TCP/IP、HTTP、FTP

3.5 标准性与扩展性

操作系统支持要求

Windows 2008(x86,x64,EM64T,AMD64,Itanium)

数据库支持要求

｛项目名称｝详细设计说明书

Mysql 5.6

应用服务器支持要求

支持JDK1.6以上版本和J2EE1.2以上版本

支持JSP1.2/Servlet2.3以上版本的 Application Server Tomcat7

网络协议

TCP/IP（国际标准网络协议），HTTP协议，FTP协议，SMTP协议

数据库访问标准

Web服务器端和客户端均采用标准JDBC等方式进行数据库连接

OOP与组件技术标准

基于Windows的ActiveX COM (+) 组件

系统集成与衔接能力

由于在软件平台、网络协议、数据库访问接口、组件标准等方面均采用了开放性和国际化标准的体系结构与技术规范，因此可方便地与其它MIS系统衔接，实现网络、数据库和软件的无缝集成

扩展与升级

采用OOP和组件式开发技术，具有较好的软件重用性，能够根据实际数字化档案馆管理工作中新的业务需求，快速方便地对软件进行定制与升级，以增强、扩充系统功能，并保持对原有系统的高度兼容性。可实现系统整体的平滑升级与扩展，以适应档案自动化管理水平的不断提高，满足更为大型的应用需求。

｛项目名称｝详细设计说明书

4．功能设计

4.1 ……功能设计

4.1.1业务流程设计

4.1.2功能概述

4.1.3主要功能模块设计

5．非功能性设计

5.1系统接口设计

5.1系统集成设计

5.2系统配置设计

5.3 系统安全设计

5.4系统部署方案设计