南车电机ESB项目开发规范.docVIP

南车电机ESB建设项目开发规范 文档信息 文档版本号 起草人 陈波 起草日期审核人 审核日期 批准人 批准日期 预期接收人 甲方： 乙方： 监理方： 修订记录 版本 日期 作者 说明 1.0陈波  目录 TOC \o 1-1 \h \z \t 标题 2,2,标题 3,3 1 前言 8 1.1 背景 8 1.2 目的 8 1.3 范围 8 1.4 定义 8 1.5 参考资料 8 1.6 文档约定 8 2 系统概述 9 2.1 技术总体架构 9 3 功能性需求 10 3.1 功能概述 10 3.2 逻辑架构 11 3.3 数据存储方式 11 3.3.1 数据高速缓存 12 3.3.2 DataPower缓存 12 3.3.3 数据缓存 12 3.3.4 持久化数据存储区 12 3.4 渠道发布 12 3.5 数据校验 12 3.6 数据转换 13 3.7 错误代码转换 13 3.8 通道资源 13 3.9 报文解析器 13 3.10 系统日志打印 17 3.11 交易流程 17 3.11.1 事务控制 17 3.11.2 并发执行 17 3.11.3 异常处理 17 3.11.4 公共流程 18 3.12 技术构件 19 3.12.1 基本构件 19 3.12.2 数据处理 20 3.12.3 通讯处理构件 24 3.12.4 文件处理构件 25 3.12.5 安全处理构件 29 3.12.6 数据库构件 30 3.12.7 数据缓存构件(需要与缓存平台厂商及普元确定方案) 47 3.12.8 任务管理构件(需要整合业务需要进一步确定方案) 49 3.12.9 业务交易构件 54 3.13 单元测试 54 3.14 运行管理 55 3.15 版本发布 55 3.16 交易平台新增及优化范围 55 3.16.1 渠道服务 55 3.16.2 交易流程 55 3.16.3 技术构件 55 3.16.4 通道资源 57 3.16.5 报文解析器 58 3.17 ESB IDE优化 58 3.17.1 业务字典 58 3.17.2 数据模型导入 58 3.17.3 报文导入 59 3.17.4 增量版本发布 60 4 非功能性需求 60 4.1 交易平台 60 4.1.1 测试需求 60 4.1.2 性能需求 61 4.1.3 安全性需求 61 4.1.4 扩展性需求 61 5 运行环境 62 5.1 设备 62 5.2 支持软件 62 前言 背景 南车株洲电机接口整合在基于Primeton ESB平台的基础上进行开发，整合南车电机多个外围系统和核心系统。为了便于在后期的开发及维护，必须制定一整套符合框架的的开发规范。 文档目的 本文试图提供一套开发高效可靠ESB程序的标准、约定和指导。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强。通过遵循和改进这些程序设计标准，使各项目产生的代码有更好的一致性，并提高软件开发团队的生产效率。 本规范适用于采用J2EE规范的项目，所有项目中的命名、渠道、渠道服务、交易服务、通道、通道服务、业务字典、数据模型及Java代码（含JAVABEAN，开发工具生成的代码框架等）均应遵守这个规范。同时， 也可作为其它项目的参考。 要求项目都要遵循， 并作为项目评审与验收依据。 规范原则： 遵循业界标准 可读性强，意义清楚 整洁严谨、风格统一 文档预期读者 本文档的预期读者包括ESB建设项目开发组全体成员：技术管理人员、系统设计人员、系统开发人员、系统测试人员、系统维护人员、推广培训人员及其他相关人员。 文档适用范围 本文档适用于所有与南车电机ESB建设项目的相关的开发 ESB开发详解 ESB开发工具调整 Primeton ESB设置 作者：设置为开发人员姓名 部门：南车电机信息技术管理部 默认Module名称：设置为com.南车电机 Java代码样式 新建南车电机(南车电机信息技术部)代码样式。 空白行(N): 第一个声明前面(F)：设为1。 其余默认。 新行： 在空的枚举声明中(E)不选中。 其余默认。 自动换行： 最大行宽设为200。 其余默认。 Java代码开发过程中使用Ctrl+Shift+F进行代码格式化。 服务定制包（平台组建立） 创建原则 按业务域划分，如：任