企业服务总线管理系统概要设计说明书

文件名称 企业服务总线管理系统文件名称 企业服务总线管理系统 上海市鞍山路 5 号杨浦商城 1205 室 电话 021 传真 021 2001 邮编 页码 0 14 企业服务总线管理系统 概概 要要 设设 计计 说说 明明 书 书 1 01 0 文件状态 文件标识 FM3001 GT EZ SSR TS008 当前版本 0 1 草稿 正在修改 作 者 范坚 文件名称 企业服务总线管理系统概要设计文件名称 企业服务总线管理系统概要设计 上海市鞍山路 5 号杨浦商城 1205 室 电话 021 传真 021 2001 邮编 页码 1 14 审 核 正式发布 完成日期 2014 9 24 变更记录 日期日期作者作者版本版本变更说明变更说明 2014 7 5范坚0 1创建文档 目录 1引言引言 4 1 1 编写目的 4 文件名称 企业服务总线管理系统概要设计文件名称 企业服务总线管理系统概要设计 上海市鞍山路 5 号杨浦商城 1205 室 电话 021 传真 021 2001 邮编 页码 2 14 1 2 背景 4 1 3 运行环境 4 1 3 1 硬件设备 5 1 3 2 软件运行环境 5 1 4 术语定义 5 2总体设计总体设计 5 2 1 总体结构 5 3接口设计接口设计 8 3 1 用户接口 8 3 2外部接口 8 3 3 内部接口 9 4系统数据结构设计系统数据结构设计 9 4 1 数据结构设计要点 10 4 2 数据结构与程序的关系 10 5各软件子模块的概要描述各软件子模块的概要描述 11 6系统出错处理设计系统出错处理设计 11 6 1 出错信息 11 6 2 补救措施 11 6 3 系统维护设计 12 7参考资料参考资料 12 文件名称 企业服务总线管理系统概要设计文件名称 企业服务总线管理系统概要设计 上海市鞍山路 5 号杨浦商城 1205 室 电话 021 传真 021 2001 邮编 页码 3 14 文件名称 企业服务总线管理系统概要设计文件名称 企业服务总线管理系统概要设计 上海市鞍山路 5 号杨浦商城 1205 室 电话 021 传真 021 2001 邮编 页码 4 14 1 1引言引言 1 1 编写目的编写目的 本设计书是企业管理总线管理系统程序的研发概要设计 将项目开发进程中或者项目结束后提供给 双方人员使用 同时也可以作为实施后期的维护人员使用 软件概要设计是从总体上把握系统设计框架 他包括模块划分 处理流程和接口设计 概要设计说 明书对 内容作了总体描述 体现了用户需求与应用系统实现之间的关系 在设计过程中起到了提 纲挈领的作用 1 2 背景背景 待开发的软件系统的名称 企业服务总线管理系统 项目名称 企业服务总线管理系统 项目的任务提出者 上海沪正软件工程有限公司 项目的任务开发者 上海沪正软件工程有限公司软件部 项目的用户 质量保证部 本文档的阅读者 上海沪正软件工程有限公司软件部开发人员 1 3 运行环境运行环境 文件名称 企业服务总线管理系统概要设计文件名称 企业服务总线管理系统概要设计 上海市鞍山路 5 号杨浦商城 1205 室 电话 021 传真 021 2001 邮编 页码 5 14 1 3 1 硬件设备硬件设备 客户程序硬件要求客户程序硬件要求 无特殊要求 服务器硬件需求服务器硬件需求 处理器 Xeon E5620 四核 内存 4G DDR3 REG ECC 硬盘 500G 其它无特殊要求 1 3 2 软件运行环境软件运行环境 参见 企业服务总线管理管理系统用户需求说明书 1 4 术语定义术语定义 无 2 2总体设计总体设计 2 1 总体结构总体结构 原来的各应用的通信关系 文件名称 企业服务总线管理系统概要设计文件名称 企业服务总线管理系统概要设计 上海市鞍山路 5 号杨浦商城 1205 室 电话 021 传真 021 2001 邮编 页码 6 14 Application Application ApplicationApplication ApplicationApplication 使用 企业服务总线 各系统通信图 Application Application ApplicationApplication ApplicationApplication Enterprise service bus 文件名称 企业服务总线管理系统概要设计文件名称 企业服务总线管理系统概要设计 上海市鞍山路 5 号杨浦商城 1205 室 电话 021 传真 021 2001 邮编 页码 7 14 Mule ESB 是一个基于 Java 的轻量级企业服务总线和集成平台 允许开发人员快速便利地连接 多个应用 并支持应用间的数据交换 Mule ESB 支持集成现有系统而无论其底层采用何种技术 如 JMS Web Services JDBC HTTP 以及其他技术 文件名称 企业服务总线管理系统概要设计文件名称 企业服务总线管理系统概要设计 上海市鞍山路 5 号杨浦商城 1205 室 电话 021 传真 021 2001 邮编 页码 8 14 系统调用流程系统调用流程 其它系统 ESB 路由表 是否存在路由表提示相关信息不存在 调用相关服务 存在 记录日志 Webservice 调用 企业服务总线系统 Response 文件名称 企业服务总线管理系统概要设计文件名称 企业服务总线管理系统概要设计 上海市鞍山路 5 号杨浦商城 1205 室 电话 021 传真 021 2001 邮编 页码 9 14 3 3接口设计接口设计 3 1 用户接口用户接口 采用窗口化 菜单式进行设计 3 2 外部接口外部接口 3 2 1发送邮件 sendMail WSDL http 192 168 0 79 5678 WebService sendMail wsdl 参数 json 字符串 格式参考 mailServerHost from Address fj userName fj password Abcd 12345 subject test content testContent sendAddress 返回 json 字符串 处理逻辑 代理调用 通信共用组件 发送邮件 webservice 接口 让其返回结果 参数文档 FM3001 沪正 CommunicationModule TS001 独立邮件发送系统详细设计说明书 doc x 流程图 文件名称 企业服务总线管理系统概要设计文件名称 企业服务总线管理系统概要设计 上海市鞍山路 5 号杨浦商城 1205 室 电话 021 传真 021 2001 邮编 页码 10 14 发送邮件soap 通信共用组件 发送邮件 Mule EBS 3 3 内部接口内部接口 4 4系统数据结构设计系统数据结构设计 数据库设计参考 企业服务总线管理系统数据库设计说明书 文档 4 1 数据结构设计要点数据结构设计要点 4 1 1 表名规范 表类型 系统表 加上 SYS 数据表 加上 DATA 日志表 加上 LOG 配置表 加上 CFG 之后用多个单词间以下划线 进行连接 表示功能 可适当简化 长度不能超过 30 个字符 文件名称 企业服务总线管理系统概要设计文件名称 企业服务总线管理系统概要设计 上海市鞍山路 5 号杨浦商城 1205 室 电话 021 传真 021 2001 邮编 页码 11 14 4 2 字段命名规则 4 2 1 字段规范 数据库字段名全部采用英文单词 单词之间用下划线 进行连接 可适当简化 长度不能超过 3 0 个字符 如果该字段是代码 则使用 code 为后缀 如果该字段表示的是时间 精确到日的 用 date 为后缀 精确到秒或毫秒的 用 time 为后缀 字段表示某个实体的名字时 加 name 后缀 4 2 数据结构与程序的关系数据结构与程序的关系 数据结构为关系型数据库 所以在程序中可以用标准的 SQL 语句或 HQL 语句与数据结构进行 交互 交互过程中采用通用的数据访问接口 为了保持良好的程序架构 对数据库访问采用 DAO 设 计模式实现 提高维护性和扩张性 5 5各软件子模块的概要描述各软件子模块的概要描述 文件名称 企业服务总线管理系统概要设计文件名称 企业服务总线管理系统概要设计 上海市鞍山路 5 号杨浦商城 1205 室 电话 021 传真 021 2001 邮编 页码 12 14 6 6系统出错处理设计系统出错处理设计 6 1 出错信息出错信息 本程序多采用了异常处理机制 当遇到异常时不但能够及时处理 保证程序的安全性和稳定性 而且各种出错信息能够通过弹出对话框的形式 及时的告诉用户出错的原因和解决的方法 是用 户以后能够减少错误的发生 程序的发现部分还采取了出错保护 如输入内容的长度和类型自动纠 正减少了用户出错的可能 6 2 补救措施补救措施 说明故障出现后可能采取的变通措施 包括 A 输入错误 用户输入不规范造成的 应在尽量减少用户出错的条件的情况下 主要通过对话框 提醒用户 然后再次操作 B 其他操作错误 对于用户的不正当操作 有可能是程序发生错误 主要是中止 操作 并提醒用户中止的原因和操作的规范 C 其他不可预知的错误 对于程序不可预知的错误 不可能作出完全的异常处理 这时主要保证数据的安全 所以要经常进行数据库备份 并及时联系维修人员 以逐步完善程序 6 3