《项目案例2-概要设计说明书》由会员分享，可在线阅读，更多相关《项目案例2-概要设计说明书（41页珍藏版）》请在金锄头文库上搜索。
1、*有限公司*XXXX2.0*XXXX2.0概要设计说明书XXXXXX2007 年 12 月编制部门编制部门EPGTEEXI批准日期批准日期2007/9/12 版本修订人修订说明批准人发布日期2.0.1.0XXX初稿，20080118 通过同行评审。XXX20080131说说 明明本文档中所包含的信息属于商业机密信息，如无本文档中所包含的信息属于商业机密信息，如无*有限公司的书面许可，任何人都无有限公司的书面许可，任何人都无权复制或利用。权复制或利用。编制部门编制部门EPGTEEXI批准日期批准日期2007/9/12 I目录1引言.11.1编写目的.11.2背景.11.3定义.11.4法律法规和
2、参考资料.12总体设计.12.1需求概述.12.2系统分析.12.3模块的层次结构图.12.4模块与需求对应表.23运行设计.23.1运行模块组合.23.2运行控制.24接口设计.24.1用户界面.24.2外部接口.24.3内部接口.25系统数据结构设计.35.1设计要点.35.2详细设计.35.3数据结构和模块的关系.3编制部门编制部门EPGTEEXI批准日期批准日期2007/9/12 受控 第 1 页 共 39 页 （机密）1引言1.1编写目的编写目的在完成需求分析的基础上，为了更好的明确平台需求、以及指导程序员的开发工作，编写了这份概要设计说明书，该说明书主要对需求进行分析、设计、框架的
3、整体设计，以及部分实现方案，接近详细设计，程序员通过该设计便可以进行开发工作。预期读者：编码人员、测试人员、设计人员，上级领导，各产品部技术同行等。1.2背景背景产品名称*XXXX2.0产品简称XXXX2.0英文缩写XXXX项目编号P20070035版本号2.0任务提出者XXXX开发者XXXX 等用户金融内部 J2EE 相关项目开发人员同其他系统的关系各个产品的 J2EE 二次开发平台1.3定义定义列出本文中用到的术语及其定义。版本声明：版本声明： Spring 版本：2.5 Hibernate 版本：3.2.2 Jdk 版本：1.4x Ireport：2.0.2 JaspReport：2.0
4、.21.4法律法规和参考资料法律法规和参考资料XXXX2.0 需求说明书 J2EE 设计模式2总体设计2.1需求概述需求概述整合各产品部现有的框架和组件，形成统一规范的二次开发平台，适合各产品部开发需求；提供统一的权限定制平台、业务逻辑控制、底层组件等。编制部门编制部门EPGTEEXI批准日期批准日期2007/9/12 受控 第 2 页 共 39 页 （机密）2.2系统分析系统分析XXXX 系统功能图：系统功能图：管理平台功能框架图业务管理框架产产品品升升级级管管理理业业务务基基础础框框架架管管理理数数据据字字典典维维护护监监控控管管理理权权限限管管理理报报表表管管理理用用户户登登录录安安全全
5、管管理理组组织织机机构构管管理理日日志志管管理理系系统统参参数数管管理理 业业务务产产品品（实实际际业业务务开开发发的的项项目目）技术框架控控制制/业业务务逻逻辑辑层层MainServlet封封装装业业务务逻逻辑辑基基类类封封装装Spring封封装装公公用用组组件件通通讯讯组组件件展展现现层层Js函函数数组组件件标标签签类类库库持持久久层层JDBC封封装装Hibernate封封装装持持久久层层基基类类封封装装 XXXX 框架分为业务框架和技术框架，业务框架给开发项目提供公用业务支持如权限管理、报表管理等；技术框架为开发人员提供技术开发模版，并在开发过程中提供相关类库、组件；整个框架提高了代码的
6、复用性、技术框架和业务框架的复用性，提高了开发效率和产品的整体性能，也便于统一版本管理。XXXX 系统架构图：系统架构图：系统框架以基本的 MVC 为基础、根据公司的实际情况进行扩展，前台以 Jap/html或者 Applet 的形式展现业务数据，通过 Servlet 服务入口和中间业务逻辑框架交互；业务逻辑框架采用模版框架设计模式，以封装基本业务为基类，有子类根据实际情况分别继承和扩展；在业务层如果涉及到银行核心数据，则通过 Socket 和通讯机交互；一般的业务逻辑处理通过 Spring 的 Ioc 原理和持久层交互；开发人员根据实际情况可分别采用 hibernate 或 jdbc 框架开
7、发，这两个框架 XXXX 自动封装成类库；XXXX 和具体业务的框架通用。编制部门编制部门EPGTEEXI批准日期批准日期2007/9/12 受控 第 3 页 共 39 页 （机密）业务逻辑框架Http协协议议Jsp/html/ajaxAppletServlet（包括业务MainServlet、监控Servlet、缓存监听Servlet等）其它Spring持久层（hibernate框架/jdbc框架）通讯机（gaps或其它）Tcp协议银行核心帐务系统 DB 系统设计框架图2.3模块的层次结构图模块的层次结构图采用面向结构的设计方法：用一系列图表标出本系统内的每个程序（包括每个模块和子程序或重要
8、函数）的名称、标识符和它们之间的层次结构关系。采用面向对象的设计方法：使用对象模型图及功能模型图表示整个系统的对象结构。2.3.8业务基础框架管理模块设计说明（模块编号：业务基础框架管理模块设计说明（模块编号：M001）包：包：com.teexi.tamcx.systemcom.teexi.tamcx.system2.3.8.12.3.8.1业务功能菜单定义模块设计说明（模块编号：业务功能菜单定义模块设计说明（模块编号：M00101M00101）模块描述模块描述:定义 XXXX 框架的业务菜单，菜单以功能树的方式展现，在界面的左方，分为一级菜单和向下扩展菜单。一级菜单可展开，合拢，向下可下挂多
9、级子菜单。菜单可为分两大类，即根菜单和功能菜单。只有根菜单下才可再挂叶子菜单（功能菜单） ，根菜单不对应具体的操作，只可做打开叶子菜单和收起叶子菜单操作。叶子菜单与具体的功能 URL 对应，点击，进入具体的业务功能界面。模块结构图（流程图）：模块结构图（流程图）：编制部门编制部门EPGTEEXI批准日期批准日期2007/9/12 受控 第 4 页 共 39 页 （机密）进入菜单配置增加菜单配置以树形展现菜单结构修改菜单配置删除菜单及子菜单配置刷新，初始化装载菜单菜单定义结束模块设计图（相关类图）：模块设计图（相关类图）：模块接口说明：模块接口说明：TreeMenu:getAllMenu():获
10、得所有菜单信息。以层的方式获得所有配置的菜单信息。即根菜单下面下挂子菜单，子菜单下再下挂子菜单，以此类推。getShowMenu():获得用户应显示的全部菜单的信息；getRoleMenu():获得此角色拥有的菜单权限信息；getUserMenu():获得用户单独分配的菜单权限信息；getSubMenu():获得传入菜单节点下的子菜单的权限信息。对应的数据表：对应的数据表：功能菜单配置表：t_ywty_menu2.3.8.22.3.8.2业务交易配置模块设计说明（模块编号：业务交易配置模块设计说明（模块编号：M00102M00102）模块描述模块描述:定义交易基本配置，业务流程的主交易码。主交
11、易码与业务菜单挂勾，一个业务菜单对应一个主交易码，主交易码下可挂多个子交易码。模块结构图（或流程图）：模块结构图（或流程图）：编制部门编制部门EPGTEEXI批准日期批准日期2007/9/12 受控 第 5 页 共 39 页 （机密）开始配置交易信息增加交易配置信息结束交易配置修改交易配置信息删除交易配置信息查询交易配置信息初始化/刷新交易配置信息增加子交易配置信息修改子交易配置信息删除子交易配置信息查询子交易配置信息模块设计图（相关类图）：模块设计图（相关类图）：编制部门编制部门EPGTEEXI批准日期批准日期2007/9/12 受控 第 6 页 共 39 页 （机密）模块接口说明：模块接口
12、说明：Trans:Init():初始化交易配置和子交易配置信息。将初始化的交易配置信息，放置在HashMap 信息中，并保证数据的同步安全。getCtlClass():传入交易码，子交易码，得到此交易的控制类（CTL）信息；getTranName():传入交易码，子交易码，得到此交易的交易名称；getSubTranName():传入交易码，子交易码，得到此交易的子交易名称；getReturnPage():传入交易码，子交易码，得到此交易的成功返回页面；isTranExist():传入交易码，子交易码，判断此交易是否存在配置中。TranCtl:doControl():判断子交易码，调用不同的子交
13、易方法处理；addTran():增加交易配置信息；edtTran():修改交易配置信息；uptTran():更新交易配置信息；delTran():删除交易配置信息；对应的数据表：对应的数据表：交易信息配置表：t_ywty_tran2.3.8.32.3.8.3业务子交易信息配置模块设计说明（模块编号：业务子交易信息配置模块设计说明（模块编号：M00103M00103）模块描述模块描述:主交易流程必需和子交易流程结合起来用，方为有效。业务提交必须既有主交易码，也有子交易码，由此定位此交易的：交易名、交易类型、交易装载类(CTL)、交易返回页面。选中主交易信息，增加、修改、删除、查询此主交易信息对应
14、的子交易信息。编制部门编制部门EPGTEEXI批准日期批准日期2007/9/12 受控 第 7 页 共 39 页 （机密）模块结构图（或流程图）：模块结构图（或流程图）：同 2.3.1.2 流程图模块设计图（相关类图）：模块设计图（相关类图）：同 2.3.1.2 类图模块接口说明：模块接口说明：addSubTran():增加子交易配置信息；edtSubTran():修改子交易配置信息；uptSubTran():更新子交易配置信息；delSubTran():删除子交易配置信息；对应的数据表：对应的数据表：子交易信息表 T_ywty_sub_tran 交易与子交易关系表 t_ywty_tran_r
15、elation2.3.8.42.3.8.4子流程公共返回信息配置模块设计说明（模块编号：子流程公共返回信息配置模块设计说明（模块编号：M00104M00104）模块描述模块描述:子流程执行完成，默认有一个返回页面，这在子流程参数中配置。子流程还可以根据程序执行的情况不同，选择不同的返回页面，选择主交易配置，子流程返回页面配置，可对子流程的返回页进行，增加、修改、删除等配置。模块结构图（或流程图）：模块结构图（或流程图）：选中交易信息增加返回页面增加返回页面配置修改返回页面配置删除返回页面配置查找返回页面结束配置模块设计图（相关类图）：模块设计图（相关类图）：同 2.3.1.2模块接口说明：模块
16、接口说明：同 2.3.1.2对应的数据表：对应的数据表：子交易信息表 T_ywty_sub_tran 交易与子交易关系表 t_ywty_tran_relation2.3.9组织机构管理模块设计说明（模块编号：组织机构管理模块设计说明（模块编号：M002）包：包：com.teexi.tamcx.system.orgcom.teexi.tamcx.system.org编制部门编制部门EPGTEEXI批准日期批准日期2007/9/12 受控 第 8 页 共 39 页 （机密）2.3.9.12.3.9.1机构管理模块设计说明（模块编号：机构管理模块设计说明（模块编号：M00201M00201）模块描述模块描述:XXXX 管理的的机构有上下级关系，总级机构下挂一级机构，一级机构下挂 N 级机构，以此类推。设计上可考虑 9 级以内的机构，对机构进行树形展示，设置一个虚拟机构供开发时 admin 使用，虚拟机构下挂总级机构。选择机构信息，可修改、删除、查询此机构相关信息，同时可以以此机构为根，增加其下属机构信息。模块结构图（或流程图）：模块结构图（或流程图）：开始机构维扩展示机构树显示/修改机构信息
