XX系统概要设计说明模板

XX管理系统概要设计说明书1XX系统概要设计说明书OD-OUTLINE/TY20130801/TY-YJGL-1.00作者文件状态：[√]草稿[]正式发布[]正在修改文件标识：当前版本：1.0作者：完成日期：2016-08-26XX管理系统概要设计说明书2项目名称XX管理系统文件名称XX管理系统概要设计说明书项目编号TY-JWGL-201308总页数15完成单位计科1003第1开发小组拟制签名与日期职务或技术职称鲁路通组员校对杨芳副组长审核肖静副副组长批准任鹏远组长摘要：XX管理系统,是一个方便服务于广大教职工的软件系统。教职工可以通过此软件，能够随时掌握自己的工作业绩，并进行业绩申报、业绩评比以及信息反馈等功能。最后由管理员审核，评审小组打分，根据各项分数来对教职工该时间段内的业绩进行分析评比。各个教职工都可以在软件系统中对各项信息进行详细查看，但是每个人的修改权限有限，可以做到公平透明化。目前来说很少有针对教职工工作业绩管理的软件系统，所以设计XX管理系统十分有必要。主题词：XX管理系统概要设计XX管理系统概要设计说明书3目录1概述...........................................................................................................错误!未定义书签。1.1编写目的.......................................................................................错误!未定义书签。1.2术语和缩写...................................................................................错误!未定义书签。1.3参考资料.......................................................................................错误!未定义书签。2系统构架设计...........................................................................................错误!未定义书签。2.1系统总体结构图及其约束和假定...............................................错误!未定义书签。2.2技术构架设计...............................................................................................................42.3软件功能结构设计.......................................................................................................53应用系统设计...........................................................................................错误!未定义书签。3.1设计原则.......................................................................................错误!未定义书签。3.2逻辑结构分析...............................................................................错误!未定义书签。3.3公共的功能模块设计接口及实现...............................................错误!未定义书签。3.4功能模块设计...............................................................................错误!未定义书签。4接口设计...................................................................................................错误!未定义书签。4.1外部接口.......................................................................................错误!未定义书签。4.2内部接口.......................................................................................错误!未定义书签。5开发环境的设计.......................................................................................错误!未定义书签。5.1开发环境设计...............................................................................错误!未定义书签。5.2编码规范.......................................................................................错误!未定义书签。6运行环境设计...........................................................................................错误!未定义书签。6.1软件环境.....................................................................................................................106.2硬件环境10XX管理系统概要设计说明书41概述1.1编写目的广大教职工可通过XX管理系统，随时掌握自己的工作业绩，并进行业绩申报、业绩评比以及信息反馈等功能，能够充分且及时的了解自己的工作状态。不但提高了绩效管理的科学性与高效性，减少了管理过程中的人工干预，而且实现了绩效管理的公正、公平、公开以及数据共享和管理的透明化1.2术语和缩写缩写、术语解释SystemServer系统服务器DBServer数据库服务器PC教师工作业绩管理系统客户端PC1.3参考资料序号文件名发表日期出版单位或作者1《软件工程导论》1997张海藩清华大学出版社2《软件工程和导论》2011张海藩清华大学出版社3《数据库原理与应用》1999李昭原科学出版社4《JAVA软件开发》2000窦巍人民邮电出版社2系统构架设计2.1技术构架设计系统主要采用MVC的架构模式。系统分成五层：控制层(Controller)、业务逻辑层(Service)、数据访问层(DAO)、数据模型层（Model）、展现层(View)。数据访问层主要对数据库数据进行操作，包括增加数据，修改数据和删除数据。业务逻辑层基于数据访问层之上，它主要针XX管理系统概要设计说明书5对业务流程来实现系统的功能。控制层又基于业务逻辑层之上，它主要控制请求流转，并处理业务层通过数据访问层得到的数据在View表现层进行展现，以完成选课管理系统所要完成的功能。2.2软件功能结构设计在这里的Model是领域模型的实体即数据模型，它与Database中的实体是一一对应的关系。Dao就是采用Model的形式来存取数据，采用Model或集合的形式来呈现或存储数据的。Service所处理的是业务流程中所要实现的功能，通过业务分析来定义，其根据可结合View来设计。XX管理系统概要设计说明书63应用系统设计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参数）来完成具体的操作。模型3.3公共的功能模块设计接口及实现接口包名：cn.rjtraining.baseStruts框架Struts.xml(xxxAction)表示层（表单数据model）xxx.Action控制层（xxxAction）xxxService()Spring框架beans.xml(xxxService,xxxServiceImpl)(DAO,BaseDaoImpl)业务层（xxxServiceImpl）Dao()持久层（BaseDaoImpl）XX管理系统概要设计说明书7实现包名：cn.rjtraining.base编号DAO接口DAO接口实现DAO父类Hibernate1DaoEBaseDaoImplEHibernateDaoSupport1、业务层接口与实现的对应关系业务层需调用持久层提供的接口进行数据存取，而业务层又是在控制层之下的，因而业务层即要调用持久层DAO的接口，又要提供接口给控制层来进行调用。接口包名：cn.rjtraining.service实现包名：cn.rjtraining.service.impl编号业务层接口业务层接口实现业务层实现BaseDaoImpl1UserServiceUserServiceImplBaseDaoImplUser2RoleServiceRoleServiceImplBaseDaoImplRole3UserRoleServiceUserRoleServiceImplBaseDaoImplUserRole4ModuleServiceModuleServiceImplBaseDaoImplModule5ClassTypeServiceClassTypeServiceImplBaseDaoImplClassType6ClassesServiceClassesServiceImplBaseDaoImplClasses7RoleAuthServiceRoleAuthServiceImplBaseDaoImplRoleAuth8StudentServiceStudentServiceImplBaseDaoImplStudent9CourseServiceCourseServiceImplBaseDaoImplCourseXX管理系统概要设计说明书810DeptServiceDeptServiceImplBaseDaoImplDept11TeacherServiceTeacherServiceImplBaseDaoImplTeacher2、常用工具类的实现Encryptor加密工具（MD5）、GenericsUtils泛型工具3.4功能模块设计4接口设计4.1外部接口无接口4