XX系统概要设计说明模板

XX系统
概要设计说明书
OD-OUTLINE /TY20130801/ TY-YJGL-1.00
作者
目录
1 概述................................. 错误!未定义书签。

1.1 编写目的 ........................ 错误!未定义书签。

1.2 术语和缩写 ...................... 错误!未定义书签。

1.3 参考资料 ........................ 错误!未定义书签。

2 系统构架设计......................... 错误!未定义书签。

2.1 系统总体结构图及其约束和假定..... 错误!未定义书签。

2.2 技术构架设计 (5)
2.3 软件功能结构设计 (5)
3 应用系统设计......................... 错误!未定义书签。

3.1 设计原则 ........................ 错误!未定义书签。

3.2 逻辑结构分析..................... 错误!未定义书签。

3.3 公共的功能模块设计接口及实现..... 错误!未定义书签。

3.4 功能模块设计..................... 错误!未定义书签。

4 接口设计............................. 错误!未定义书签。

4.1 外部接口 ........................ 错误!未定义书签。

4.2 内部接口 ........................ 错误!未定义书签。

5 开发环境的设计....................... 错误!未定义书签。

5.1 开发环境设计..................... 错误!未定义书签。

5.2 编码规范 ........................ 错误!未定义书签。

6 运行环境设计......................... 错误!未定义书签。

6.1 软件环境 (11)
6.2 硬件环境 12
概述
编写目的
广大教职工可通过XX管理系统，随时掌握自己的工作业绩，并进行业绩申报、业绩评比以及信息反馈等功能，能够充分且及时的了解自己的工作状态。

不但提高了绩效管理的科学性及高效性，减少了管理过程中的人工干预，而且实现了绩效管理的公正、公平、公开以及数据共享和管理的透明化
术语和缩写
参考资料
系统构架设计
技术构架设计
系统主要采用MVC的架构模式。

系统分成五层：控制层(Controller)、业务逻辑层(Service)、数据访问层(DAO)、数据模型层（Model）、展现层(View)。

数据访问层主要对数据库数据进行操作，包括增加数据，修改数据和删除数据。

业务逻辑层基于数据访问层之上，它主要针对业务流程来实现系统的功能。

控制层又基于业务逻辑层之上，它主要控制请求流转，并处理业务层通过数据访问层得到的数据在View表现层进行展现，以完成选课管理系统所要完成的功能。

软件功能结构设计
在这里的Model是领域模型的实体即数据模型，它及Database 中的实体是一一对应的关系。

Dao就是采用Model的形式来存取数据，采用Model或集合的形式来呈现或存储数据的。

Service所处理的是业务流程中所要实现的功能，通过业务分析来定义，其根据可结合View来设计。

应用系统设计
设计原则
一个对象的基本要素包括四大要素
对象标识：给对象一个可以辨识的名称，要求具有唯一性。

对
象的标识符全为自增并且名为id。

主实体：对象主要操作的数据库表结构。

动作过程：即对象的输入输出和对数据的处理过程。

I/O关系：即对象的动作过程中所牵涉到的其他数据实体。

逻辑结构分析
本系统采用SSH进行开发。

模型结构如下图所示，Spring接收来自表示层的请求“xxxAction.do”请求参数封装在model中，Struts根据配置信息调用控制层xxxAction的相关方法，该方法从model中获取参数，并从Spring容器中获取业务层接口xxxService的一个实例xxxServiceImpl。

在Spring容器初始化xxxServiceImpl实例时，会获取BaseDaoImpl的一个实例（此实例继承了Hibernate的实现类）xxxServiceImpl实例会调用持久层BaseDaoImpl实例的方法（传入获取的model参数）来完成具体的操作。

模型
公共的功能模块设计接口及实现 接口包名：cn.rjtraining.base 实现包名：cn.rjtraining.base
1、业务层接口及实现的对应关系
业务层需调用持久层提供的接口进行数据存取，而业务层又是在控制层之下的，因而业务层即要调用持久层DAO的接口，又要提供接口给控制层来进行调用。

接口包名：cn.rjtraining.service
实现包名：cn.rjtraining.service.impl
2、常用工具类的实现
Encryptor加密工具（MD5）、GenericsUtils泛型工具功能模块设计
接口设计
外部接口
无接口
内部接口
无
开发环境的设计
开发工具：
MyEclipse 8.5+ SqlSever+Tomcat+SSH （Struts2.2+Spring3.0+Hibernate3.6.7）
运行环境设计
软件环境
教职工工作业绩管理系统的设计及运行基于采用C/S网络应用环境运行于校园网上。

后台操作系统为Microsoft Windows 2007，数据库为Microsoft SQL Server 2005 ；Web服务器运行环境为Windows NT Server（SP6），浏览器为IE4.0以上版本。

数据查询服务部分采用B/S网络应用环境。

硬件环境
服务器端包括一台标准服务器(也可用性能较好的普通PC服务器，数据库服务器、WEB服务器也可运行在同一台服务器上)。

PC服务器要求CPU： PIII 600MHZ以上，内存容量大于或等于512M，硬盘容量大于或等于20G。

客户端包括多媒体电脑、PC 客户机，要求多媒体电脑和PC客户机及上述PC服务器物理上连接畅通；系科业务工作站桌面到校园网带宽要求至少为10M，保证连接畅快，最好有100M带宽。