详细设计说明书-模板

1、项目名称项目名称编 号当前版本拟 制 人审 核 人批 准 人文件状态 征求意见稿 正式发布完成日期 详细设计说明书详细设计说明书项目名称详细设计说明书 版版 本本 历历 史史版本作 者参与者起止时间备 注项目名称详细设计说明书 目 录1. 引言引言 .11.1 编写目的.11.2 项目背景.11.3 参考资料.12.1 项目现状项目现状 .22.2 建设目标.22.3 建设内容.22.4 功能需求.22.5 非功能需求.23. 总体设计总体设计 .33.1 体系结构.33.2 逻辑架构.33.2.1 分层架构模型.33.2.2 组件架构模型.33.2.3 数据流转模型.43.3 包结构设计.4

2、3.3.1包介绍.43.3.2包介绍.53.3.3包介绍.63.3.4 页面资源介绍.63.3 软件功能结构设计.83.4 系统运行环境.93.5 标准性与扩展性.94功能设计功能设计 .114.1 功能设计 .114.1.1 业务流程设计.114.1.2 功能概述.114.1.3 主要功能模块设计.115非功能性设计非功能性设计 .115.1 系统接口设计.115.1 系统集成设计.115.2 系统配置设计.115.3 系统安全设计.115.4 系统部署方案设计.11项目名称详细设计说明书第 0 页 1.1. 引言引言1.1 编写目的编写目的本文档描述了维护审批程序设计人员对该程序总体框架的

3、设计方案，用于指导程序开发人员进行编码设计开发，并且帮助后续升级维护人员了解掌握该程序的设计思路。用户也可以通过该文档更深一步的了解该程序。1.2 项目背景项目背景1.3 参考资料参考资料项目项目任务书2014-06-01项目任务书-1.0 版2013-11-18项目名称详细设计说明书 2. 项目概述2.12.1 项目现状项目现状2.2 建设目标建设目标2.3 建设内容建设内容2.4 功能需求功能需求2.5 非功能需求非功能需求(1) 可用性：系统应操作简单、实用高效、好记易学、少错和令人满意，具备较高的可用性；(2) 可靠性：系统应经过完善的设计和充分的测试运行，具备在较长时间内连续无故障的

4、运行能力；(3) 健壮性：系统应具备较强的容错、数据恢复与稳定运行的能力。(4) 扩展性：。项目名称详细设计说明书 3.3. 总体设计总体设计3.1 体系结构体系结构3.2 逻辑架构逻辑架构本系统核心架构为 FreeMarker+hibernate+Spirng 的 mvc 分层架构。.1 分层架构模型分层架构模型.2 组件架构模型组件架构模型业业务务层层（含含持持久久层层）基基础础设设施施层层JTAEhCacheQuartz展展现现层层FreeMarkerJSONHibernate3客客户户层层Log4JSpringMVCJavaMailJDBC Driver

5、XfireTAGCommons-fileuploadCommons-ioHttpClientSLF4JJQueryHTML5CSS3Spring3DWRLuceneDom4JJUnitAntCommons-netC3P0Jmagickhtmlparser项目名称详细设计说明书 .3 数据流转模型数据流转模型3.3 包结构设计包结构设计.1包介绍包介绍具体包名相关功能描述comjeecmscms常量包comjeecmscmsaction通用 action 抽象类包comjeecmscmsactionadmin后台欢迎页的 actioncomjeecmscmsact

6、ionadminassist后台辅助包comjeecmscmsactionadminmain后台核心功能包comjeecmscmsactiondirectivecms 自定义标签包,公用部分继承于 abs 包comjeecmscmsactiondirectiveabs公用部分自定义标签的抽象包comjeecmscmsactionfront前台 action 包comjeecmscmsaction.member会员中心包comjeecmscmsdaoassist辅助 dao 的接口层comjeecmscmsdaoassistimpl辅助 dao 的接口实现层comjeecmscmsdaomain

7、核心的 dao 接口层comjeecmscmsdaomainimpl核心的 dao 接口实现层comjeecmscmsentityassistcms 辅助实体类子类comjeecmscmsentityassistbasecms 辅助实体类基类项目名称详细设计说明书 comjeecmscmsentityassisthbmhibernate 辅助实体类的关系映射文件comjeecmscmsentitybackcms 备份实体类子类comjeecmscmsentitybackbasecms 备份实体类基类comjeecmscmsentitybackhbmhibernate 备份实体类类的关系映射文件

8、comjeecmscmsentitymaincms 核心实体类子类comjeecmscmsentitymainbasecms 核心实体类基类comjeecmscmsentitymainhbmhibernate 核心实体类的关系映射文件comjeecmscmslucene搜索引擎封装包comjeecmscmsmanagerassist辅助的 service 接口层comjeecmscmsmanagerassistimpl辅助的 service 接口实现层comjeecmscmsmanagermain核心的 service 接口层comjeecmscmsmanagermainimpl核心的 ser

9、vice 接口实现层comjeecmscmsserviceservice 封装层comjeecmscmsstaticpage静态页的封装包包comjeecmscmsstaticpageexception静态页的异常处理类型comjeecmscmsstatistic内容发布统计包comjeecmscmsstatisticworkload流量统计包comjeecmscmsweb拦截器包comjeecmscmstask任务包comjeecmscmstaskjob具体任务包.2包介绍包介绍具体包名相关功能描述comjeecmscommoncaptcha验证码封装包comjeecmsco

10、mmondic分词comjeecmscommonemail邮件包comjeecmscommonfckfck 编辑器封装包comjeecmscommonfile文件操作封装包comjeecmscommonhibernate3hibeinate 封装包comjeecmscommonimage图片的封装包comjeecmscommonipseekip 地址库封装comjeecmscommonlucene收索引擎的基础包comjeecmscommonoffice文档转换相关工具类comjeecmscommonpagejeecms 分页封装包comjeecmscommonsecuritycomjeecm

11、scommonsecurityannotationcomjeecmscommonsecurityencodercomjeecmscommonsecurityremembermecomjeecmscommonsecurityuserdetails安全认证相关的包comjeecmscommonupload上传封装包项目名称详细设计说明书 comjeecmscommonutil工具包comjeecmscommonweb常量包comjeecmscommonwebfreemarkerfreemarker 视图封装包comjeecmscommonwebsessionsession 包comjeecmsco

12、mmonwebsessioncachesession 缓存包comjeecmscommonwebspringmvcspringMVC 的简单封装comjeecmscmsmanagermain核心的 service 接口层comjeecmscmsmanagermainimpl核心的 service 接口实现层comjeecmscmsserviceservice 封装层comjeecmscmsstaticpage静态页的封装包comjeecmscmsstaticpageexception静态页的异常处理类型comjeecmscmsstatistic流量统计包comjeecmscmsstatisti

13、cworkload内容发布统计包comjeecmscmsweb拦截器包.3包介绍包介绍具体包名相关功能描述comjeecmscore一般常量和异常处理comjeecmscoreactionfront核心前台的 actioncomjeecmscoredao核心 dao 的接口comjeecmscoredaoimpl核心 dao 的接口实现类comjeecmscoreentity登录认证和核心用户的实体子类comjeecmscoreentitybase登录认证和核心用户的实体基类comjeecmscoreentityhbm相关的 hibernate 的映射文件comjeecmsco

14、remanager核心的 service 接口层comjeecmscoremanagerimpl核心的 service 接口实现层comjeecmscoresecurity认证登录、退出相关comjeecmscoretpl模板接口和相关 service 层comjeecmscoreweb定义内容显示的接口，工具类，和错误页面的指定comjeecmscorewebutiluri 帮助类.4 页面资源介绍页面资源介绍具体包名相关功能描述WebContentr前台资源文件，如 css、img、js 等res后台资源文件thirdparty第三方插件（ckeditor 编辑器、swf

15、上传、My97DatePicker 日项目名称详细设计说明书 期选择）u默认的用户上传资源目录WebContent/WEB-INFcache缓存文件common通用页面config核心的配置文件，如果 action，service,manager,dao,bean 等directive标签向导模板文件error错误页面ftl自定义的 freemark 宏文件ispeekip 地址库jeecms_sys后台管理页面account账号绑定列表acquisition采集admin管理员advertising广告advertising_space广告版位channel栏目comment评论common

16、公用错误页面config系统配置content内容content_reuse内容复用data数据备份department部门dictionary字典directive向导标签file文件frame框架集friendlink友情链接friendlink_ctg友情链接分类ftpftpgroup用户组guestbook留言guestbook_ctg留言分类item模型字段keyword关键词log日志lucene全文检索member会员menu自定义菜单message短消息model模型项目名称详细设计说明书 origin来源personal个人中心plug插件resource资源role角色sc

17、oregroup评分组scoreitem评分项searchwords搜索词sensitivity敏感词site站点site_config站点配置static静态化statistic浏览统计tagTag 关键词template模版topic专题type内容类型visual可视化编辑unified_user用户vote_topic投票workflow工作流workflowRecord工作流记录languages国际化配置jeecms/admin后台jeecms/front前台jeecms/tpl模版jeecore/admin公用国际化lucenelucene 文件夹t/cms前台模板页面t/cms

18、/www站点资源目录t/cms/www/plan站点方案3.3 软件功能结构设计软件功能结构设计的功能描述如下表所示，其详细功能介绍请参见后面几章内容介绍。子系统功能描述项目名称详细设计说明书 模块 1(1) 项目组公告通知及工作动态(2) 项目成果展示(3) 各农村人居环境改善标准化试点单位的宣传与展示(4) 其它媒体、部门与本项目相关的信息整理与发布(5) 相关新闻资讯发布模板 2(1) 内部讨论、互动交流(2) 文件共享(3) 网站视频会议项目名称模板 3(1) 农村人居环境改善标准化试点单位运转情况上报(2) 用农村人居环境改善标准化试点单位上报数据指标提取(3) 各类地方标准分类上传

19、共享(4) 试点单位工作动态、年终考核与项目验收上报(5) 上报数据统计分析为决策服务(6) 国家标准委管理、跟踪各试点单位工作情况3.4 系统运行环境系统运行环境服务器操作系统Windows 2008 Server数据库管理系统（DBMS）MYSQL 5.6Web 服务器Apache Tomcat 7.X客户端操作系统Windows 9X/2000/NT Workstation 系列客户端 Web 浏览器IE7.0 以上或 firefox 等主流浏览器网络传输协议TCP/IP、HTTP、FTP3.5 标准性与扩展性标准性与扩展性操作系统支持要求操作系统支持要求项目名称详细设计说明书 Windows 2008(x86,x64,EM64T,AMD64,Itanium)数据库支持要求数据库支持要求Mysql 5.6应用服务器支持要求应用服务器支持要求支持 JDK1.6 以上版本和 J2EE1.2 以上版本支持 JSP1.