XX系统概要设计说明模板.doc

XX管理系统概要设计说明书

XX系统
概要设计说明书

OD-OUTLINE /TY20130801/ TY-YJGL-1.00

作者

文件状态：
[√ ] 草稿
[ ] 正式发布
[ ] 正在修改
文件标识：

当前版本：
1.0
作 者：

完成日期：
2016-08-26

9

项目名称
XX管理系统
文件名称
XX管理系统概要设计说明书
项目编号
TY-JWGL-201308
总页数
15
完成单位
计科1003 第1开发小组
拟 制
签名与日期
职务或技术职称
鲁路通
组员
校 对
杨芳
副组长
审 核
肖静
副副组长
批 准
任鹏远
组长

摘要：XX管理系统,是一个方便服务于广大教职工的软件系统。教职工可以通过此软件，能够随时掌握自己的工作业绩，并进行业绩申报、业绩评比以及信息反馈等功能。最后由管理员审核，评审小组打分，根据各项分数来对教职工该时间段内的业绩进行分析评比。
各个教职工都可以在软件系统中对各项信息进行详细查看，但是每个人的修改权限有限 ，可以做到公平透明化。目前来说很少有针对教职工工作业绩管理的软件系统，所以设计XX管理系统十分有必要。

主题词：XX管理系统 概要设计

目 录

1 概述 4
1.1 编写目的 4
1.2 术语和缩写 4
1.3 参考资料 4
2 系统构架设计 4
2.1 系统总体结构图及其约束和假定 4
2.2 技术构架设计 5
2.3 软件功能结构设计 6
3 应用系统设计 7
3.1 设计原则 7
3.2 逻辑结构分析 8
3.3 公共的功能模块设计接口及实现 8
3.4 功能模块设计 10
4 接口设计 10
4.1 外部接口 10
4.2 内部接口 10
5 开发环境的设计 11
5.1 开发环境设计 11
5.2 编码规范 11
6 运行环境设计 12
6.1 软件环境 12
6.2 硬件环境 12

1 概述
1.1 编写目的
广大教职工可通过XX管理系统，随时掌握自己的工作业绩，并进行业绩申报、业绩评比以及信息反馈等功能，能够充分且及时的了解自己的工作状态。不但提高了绩效管理的科学性与高效性，减少了管理过程中的人工干预，而且实现了绩效管理的公正、公平、公开以及数据共享和管理的透明化

1.2 术语和缩写
缩写、术语
解 释
System Server
系统服务器
DB Server
数据库服务器
PC
教师工作业绩管理系统客户端PC

1.3 参考资料
序号
文件名
发表日期
出版单位或作者
1
《软件工程导论》
1997
张海藩 清华大学出版社
2
《软件工程和导论》
2011
张海藩 清华大学出版社
3
《数据库原理与应用》
1999
李昭原 科学出版社
4
《JAVA软件开发》
2000
窦巍人民邮电出版社

2 系统构架设计
2.1 技术构架设计
系统主要采用MVC的架构模式。系统分成五层：控制层(Controller)、业务逻辑层(Service)、数据访问层(DAO)、数据模型层（Model）、展现层(View)。数据访问层主要对数据库数据进行操作，包括增加数据，修改数据和删除数据。业务逻辑层基于数据访问层之上，它主要针对业务流程来实现系统的功能。控制层又基于业务逻辑层之上，它主要控制请求流转，并处理业务层通过数据访问层得到的数据在View表现层进行展现，以完成选课管理系统所要完成的功能。
2.2 软件功能结构设计

在这里的Model是领域模型的实体即数据模型，它与Database中的实体是一一对应的关系。Dao就是采用Model的形式来存取数据，采用Model或集合的形式来呈现或存储数据的。
Service所处理的是业务流程中所要实现的功能，通过业务分析来定义，其根据可结合View来设计。

3 应用系统设计
3.1 设计原则
一个对象的基本要素包括四大要素
对象标识：给对象一个可以辨识的名称，要求具有唯一性。对象的标识符全为自增并且名为id。
主实体：对象主要操作的数据库表结构。
动作过程：即对象的输入输出和对数据的处理过程。
I/O关系：即对象的动作过程中所牵涉到的其他数据实体。

3.2 逻辑结构分析
本系统采用SSH进行开发。
模型结构如下图所示，Spring接收来自表示层的请求“xxxAction.do”请求参数封装在model中，Struts根据配置信息调用控制层xxxAction的相关方法，该方法从model中获取参数，并从Spring容器中获取业务层接口xxxService的一个实例xxxServiceImpl。在Spring容器初始化xxxServiceImpl实例时，会获取BaseDaoImpl的一个实例（此实例继承了Hibernate的实现类）xxxServiceImpl实例会调用持久层BaseDaoImpl实例的方法（传入获取的model参数）来完成具体的操作。

Struts框架

Struts.xml(xxxAction)
表示层（表单数据model）xxx.Action

控制层（xxxAction）
xxxService()

业务层（xxxServiceImpl）
Dao()
Spring框架
beans.xml

(xxxService,xxxServiceImpl)

(DAO,BaseDaoImpl)

持久层（BaseDaoImpl）
模型

3.3 公共的功能模块设计接口及实现
接口包名：cn.rjtraining.base
实现包名：cn.rjtraining.base
编号
DAO接口
DAO接口实现
DAO父类Hibernate

1
Dao<E>
BaseDaoImpl<E>
HibernateDaoSupport

1、 业务层接口与实现的对应关系
业务层需调用持久层提供的接口进行数据存取，而业务层又是在控制层之下的，因而业务层即要调用持久层DAO的接口，又要提供接口给控制层来进行调用。
接口包名：cn.rjtraining.service
实现包名：cn.rjtraining.service.impl
编号
业务层接口
业务层接口实现
业务层实现BaseDaoImpl
1
UserService
UserServiceImpl
BaseDaoImpl <User>
2
RoleService
RoleServiceImpl
BaseDaoImpl < Role>
3
UserRoleService
UserRoleServiceImpl
BaseDaoImpl <UserRole>
4
ModuleService
ModuleServiceImpl
BaseDaoImpl <Module>
5
ClassTypeService
ClassTypeServiceImpl
BaseDaoImpl <ClassType>
6
ClassesService
ClassesServiceImpl
BaseDaoImpl <Classes>
7
RoleAuthService
RoleAuthServiceImpl
BaseDaoImpl <RoleAuth>
8
StudentService
StudentServiceImpl
BaseDaoImpl <Student>
9
CourseService
CourseServiceImpl
BaseDaoImpl <Course>
10
DeptService
DeptServiceImpl
BaseDaoImpl <Dept>
11
TeacherService
TeacherServiceImpl
BaseDaoImpl <Teacher>

2、 常用工具类的实现
Encryptor加密工具（MD5）、GenericsUtils泛型工具
3.4 功能模块设计

4 接口设计
4.1 外部接口
无接口
4.2 内部接口
无
5 开发环境的设计

开发工具：
MyEclipse 8.5+ SqlSever+Tomcat+SSH（Struts2.2+Spring3.0+Hibernate3.6.7）

6 运行环境设计
6.1 软件环境
教职工工作业绩管理系统的设计与运行基于采用C/S网络应用环境运行于校园网上。后台操作系统为Microsoft Windows 2007，数据库为Microsoft SQL Server 2005 ；Web服务器运行环境为Windows NT Server（SP6），浏览器为IE4.0以上版本。数据查询服务部分采用B/S网络应用环境。
6.2 硬件环境
服务器端包括一台标准服务器(也可用性能较好的普通PC服务器，数据库服务器、WEB服务器也可运行在同一台服务器上)。PC服务器要求CPU： PIII 600MHZ以上，内存容量大于或等于512M，硬盘容量大于或等于20G。 客户端包括多媒体电脑、PC客户机，要求多媒体电脑和PC客户机与上述PC服务器物理上连接畅通；系科业务工作站桌面到校园网带宽要求至少为10M，保证连接畅快，最好有100M带宽。