详细设计说明书-模板.doc

. 精选 word，可编辑！ 项目名称项目名称 编 号 当前版本 拟 制 人 审 核 人 批 准 人 文件状态 征求意见稿 正式发布 完成日期 详细设计说明书详细设计说明书 . 精选 word，可编辑！ 版版 本本 历历 史史 版本作 者参与者起止时间备 注 . 精选 word，可编辑！ 目 录 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 . 精选 word，可编辑！ 1.1. 引言引言 1.1 编写目的编写目的 本文档描述了维护审批程序设计人员对该程序总体框架的设计方案，用于 指导程序开发人员进行编码设计开发，并且帮助后续升级维护人员了解掌握该 程序的设计思路。用户也可以通过该文档更深一步的了解该程序。 1.2 项目背景项目背景 1.3 参考资料参考资料 项目项目任务书2014-06-01 项目任务书-1.0 版2013-11-18 . 精选 word，可编辑！ 2. 项目概述 2.12.1 项目现状项目现状 2.2 建设目标建设目标 2.3 建设内容建设内容 2.4 功能需求功能需求 2.5 非功能需求非功能需求 (1) 可用性：系统应操作简单、实用高效、好记易学、少错和令人满意，具备 较高的可用性； (2) 可靠性：系统应经过完善的设计和充分的测试运行，具备在较长时间内连 续无故障的运行能力； (3) 健壮性：系统应具备较强的容错、数据恢复与稳定运行的能力。 (4) 扩展性：。 . 精选 word，可编辑！ 3.3. 总体设计总体设计 3.1 体系结构体系结构 3.2 逻辑架构逻辑架构 本系统核心架构为 FreeMarker+hibernate+Spirng 的 mvc 分层架构。 .1 分层架构模型分层架构模型 .2 组件架构模型组件架构模型 业业务务层层 （含含持持久久层层） 基基础础设设施施层层 JTA EhCache Quartz 展展现现层层 FreeMarker JSON Hibernate3 客客户户层层 Log4J SpringMVC JavaMail JDBC DriverXfire TAG Commons- fileupload Commons- io HttpClientSLF4J JQuery HTML5 CSS3 Spring3 DWR Lucene Dom4J JUnit Ant Commons- net C3P0 Jmagickhtmlparser . 精选 word，可编辑！ .3 数据流转模型数据流转模型 3.3 包结构设计包结构设计 .1包介绍包介绍 具体包名相关功能描述 comjeecmscms 常量包 comjeecmscmsaction 通用 action 抽象类包 comjeecmscmsactionadmin 后台欢迎页的 action comjeecmscmsactionadminassist 后台辅助包 comjeecmscmsactionadminmain 后台核心功能包 comjeecmscmsactiondirective cms 自定义标签包,公用部分继承于 abs 包 comjeecmscmsactiondirectiveabs 公用部分自定义标签的抽象包 comjeecmscmsactionfront 前台 action 包 comjeecmscmsaction.member 会员中心包 comjeecmscmsdaoassist 辅助 dao 的接口层 comjeecmscmsdaoassistimpl 辅助 dao 的接口实现层 comjeecmscmsdaomain 核心的 dao 接口层 comjeecmscmsdaomainimpl 核心的 dao 接口实现层 comjeecmscmsentityassist cms 辅助实体类子类 comjeecmscmsentityassistbase cms 辅助实体类基类 . 精选 word，可编辑！ comjeecmscmsentityassisthbm hibernate 辅助实体类的关系映射文件 comjeecmscmsentityback cms 备份实体类子类 comjeecmscmsentitybackbase cms 备份实体类基类 comjeecmscmsentitybackhbm hibernate 备份实体类类的关系映射文件 comjeecmscmsentitymain cms 核心实体类子类 comjeecmscmsentitymainbase cms 核心实体类基类 comjeecmscmsentitymainhbm hibernate 核心实体类的关系映射文件 comjeecmscmslucene 搜索引擎封装包 comjeecmscmsmanagerassist 辅助的 service 接口层 comjeecmscmsmanagerassistimpl 辅助的 service 接口实现层 comjeecmscmsmanagermain 核心的 service 接口层 comjeecmscmsmanagermainimpl 核心的 service 接口实现层 comjeecmscmsservice service 封装层 comjeecmscmsstaticpage 静态页的封装包包 comjeecmscmsstaticpageexception 静态页的异常处理类型 comjeecmscmsstatistic 内容发布统计包 comjeecmscmsstatisticworkload 流量统计包 comjeecmscmsweb 拦截器包 comjeecmscmstask 任务包 comjeecmscmstaskjob 具体任务包 .2包介绍包介绍 具体包名相关功能描述 comjeecmscommoncaptcha 验证码封装包 comjeecmscommondic 分词 comjeecmscommonemail 邮件包 comjeecmscommonfck fck 编辑器封装包 comjeecmscommonfile 文件操作封装包 comjeecmscommonhibernate3 hibeinate 封装包 comjeecmscommonimage 图片的封装包 comjeecmscommonipseek ip 地址库封装 comjeecmscommonlucene 收索引擎的基础包 comjeecmscommonoffice 文档转换相关工具类 comjeecmscommonpage jeecms 分页封装包 comjeecmscommonsecurity comjeecmscommonsecurityannotation comjeecmscommonsecurityencoder comjeecmscommonsecurityrememberme comjeecmscommonsecurityuserdetails 安全认证相关的包 comjeecmscommonupload 上传封装包 . 精选 word，可编辑！ comjeecmscommonutil 工具包 comjeecmscommonweb 常量包 comjeecmscommonwebfreemarker freemarker 视图封装包 comjeecmscommonwebsession session 包 comjeecmscommonwebsessioncache session 缓存包 comjeecmscommonwebspringmvc springMVC 的简单封装 comjeecmscmsmanagermain 核心的 service 接口层 comjeecmscmsmanagermainimpl 核心的 service 接口实现层 comjeecmscmsservice service 封装层 comjeecmscmsstaticpage 静态页的封装包 comjeecmscmsstaticpageexception 静态页的异常处理类型 comjeecmscmsstatistic 流量统计包 comjeecmscmsstatisticworkload 内容发布统计包 comjeecmscmsweb 拦截器包 .3包介绍包介绍 具体包名相关功能描述 comjeecmscore 一般常量和异常处理 comjeecmscoreactionfront 核心前台的 action comjeecmscoredao 核心 dao 的接口 comjeecmscoredaoimpl 核心 dao 的接口实现类 comjeecmscoreentity 登录认证和核心用户的实体子类 comjeecmscoreentitybase 登录认证和核心用户的实体基类 comjeecmscoreentityhbm 相关的 hibernate 的映射文件 comjeecmscoremanager 核心的 service 接口层 comjeecmscoremanagerimpl 核心的 service 接口实现层 comjeecmscoresecurity 认证登录、退出相关 comjeecmscoretpl 模板接口和相关 service 层 comjeecmscoreweb 定义内容显示的接口，工具类，和错误页 面的指定 comjeecmscorewebutil uri 帮助类 .4 页面资源介绍页面资源介绍 具体包名相关功能描述 WebContent r 前台资源文件，如 css、img、js 等 res 后台资源文件 thirdparty 第三方插件（ckeditor 编辑器、swf 上传、My97DatePicker 日 . 精选 word，可编辑！ 期选择） u 默认的用户上传资源目录 WebContent/WEB-INF cache 缓存文件 common 通用页面 config 核心的配置文件，如果 action，service,manager,dao,bean 等 directive 标签向导模板文件 error 错误页面 ftl 自定义的 freemark 宏文件 ispeek ip 地址库 jeecms_sys 后台管理页面 account 账号绑定列表 acquisition 采集 admin 管理员 advertising 广告 advertising_space 广告版位 channel 栏目 comment 评论 common 公用错误页面 config 系统配置 content 内容 content_reuse 内容复用 data 数据备份 department 部门 dictionary 字典 directive 向导标签 file 文件 frame 框架集 friendlink 友情链接 friendlink_ctg 友情链接分类 ftpftp group 用户组 guestbook 留言 guestbook_ctg 留言分类 item 模型字段 keyword 关键词 log 日志 lucene 全文检索 member 会员 menu 自定义菜单 message 短消息 model 模型 . 精选 word，可编辑！ origin 来源 personal 个人中心 plug 插件 resource 资源 role 角色 scoregroup 评分组 scoreitem 评分项 searchwords 搜索词 sensitivity 敏感词 site 站点 site_config 站点配置 static 静态化 statistic 浏览统计 tag Tag 关键词 template 模版 topic 专题 type 内容类型 visual 可视化编辑 unified_user 用户 vote_topic 投票 workflow 工作流 workflowRecord 工作流记录 languages 国际化配置 jeecms/admin 后台 jeecms/front 前台 jeecms/tpl 模版 jeecore/admin 公用国际化 lucene lucene 文件夹 t/cms 前台模板页面 t/cms/www 站点资源目录 t/cms/www/plan 站点方案 3.3 软件功能结构设计软件功能结构设计 的功能描述如下表所示，其详细功能介绍请参见后面几章内容介绍。 子系统功能描述 . 精选 word，可编辑！ 模块 1(1) 项目组公告通知及工作动态 (2) 项目成果展示 (3) 各农村人居环境改善标准化试点单位的 宣传与展示 (4) 其它媒体、部门与本项目相关的信息整 理与发布 (5) 相关新闻资讯发布 模板 2(1) 内部讨论、互动交流 (2) 文件共享 (3) 网站视频会议 项 目名 称 模板 3(1) 农村人居环境改善标准化试点单位运转 情况上报 (2) 用农村人居环境改善标准化试点单位上 报数据指标提取 (3) 各类地方标准分类上传共享 (4) 试点单位工作动态、年终考核与项目验 收上报 (5) 上报数据统计分析为决策服务 (6) 国家标准委管理、跟踪各试点单位工作 情况 3.4 系统运行环境系统运行环境 服务器操作系统Windows 2008 Server 数据库管理系统 （DBMS） MYSQL 5.6 Web 服务器Apache Tomcat 7.X 客户端操作系统 Windows 9X/2000/NT Workstation 系列 客户端 Web 浏览器IE7.0 以上或 firefox 等主流浏览器 网络传输协议 TCP/IP、HTTP、FTP 3.5 标准性与扩展性标准性与扩展性 操作系统支持要求操作系统支持要求 . 精选 word，可编辑！ Windows 2008(x86,x64,EM64T,AMD64,Itanium) 数据库支持要求数据库支持要求 Mysql 5.6 应用服务器支持要求应用服务器支持要求 支持 JDK1.6 以上