Adtec_ESB服务规范_报文规范-V302.doc

ESB服务规范报文规范北京先进数通信息技术有限公司2010-7-26编写说明中文标题：报文规范文档类型：设计版本历史：版本作者修改日期修改内容审核批准V1.02010-07-26初稿V3.0.0王小兵2011-12-2修改，请求报文头，响应报文头遵循FIX缩写规范V3.0.1王小兵2011-12-5修改RspSysCd-RespSysCdRspSecCd-RespSecCdTxnSatus-TxnStat北京先进数通信息技术有限公司- 50报文规范目 录编写说明2目 录11. 引言31.1. 编写目的31.2. 项目背景31.3. 定义31.4. 参考资料42. ESB系统架构图52.1. 原子交易-无需DB-系统架构图52.2. 原子交易-需要DB-系统架构图62.3. 组合交易系统架构图62.4. ESB本地交易系统架构图73. ESB报文规范83.1. ESB请求报文规范83.1.1. 请求报文实例规范83.1.2. 服务地址结构wsa-Addressing103.1.3. 服务安全结构wssec:Security103.1.4. 服务识别信息结构wsrm:ReliableMessaging103.1.5. 通用报文头结构RequestHeader113.2. ESB响应报文规范123.2.1. 响应报文实例规范133.2.2. 服务安全结构wssec:Security143.2.3. 服务地址结构wsa-Addressing153.2.4. 服务识别信息结构wsrm:ReliableMessaging153.2.5. 通用报文头结构ResponseHeader163.2.6. 错误体结构Fault171.1. XML标记名规范181.2. ESB分页处理181.3. ESB多记录规范191.4. XML报文格式检查191.5. 典型服务的WSDL定义示例191.5.1. 账户信息查询服务003001010000871202.2. 冲正处理342.3. 重报文检查343. ESB文件传输规范363.1. ESB与行内其他系统交换363.2. 文件目录规范364. ESB安全规范384.1. 数据机密性384.2. 数据完整性384.3. 数据防抵赖385. ESB通讯协议395.1. ESB over HTTP395.1.1. 请求报文：395.1.2. 响应报文：395.2. ESB over JMS395.3. ESB over MQ405.4. ESB over Tuxedo405.5. ESB over TCP406. ESB公用处理417. ESB接口版本变更规范427.1. 版本变更流程427.1.1. 接口变更发起方，填写接口变更单427.1.2. 提交变更单给ESB组版本管理员427.1.3. ESB分配变更工作（文档变更，ESB定制库变更）427.1.4. ESB根据变内容更涉及小组发送给关联小组负责人427.1.5. ESB生效变更接口到测试环境427.2. 版本变更频度427.3. 版本发布427.4. 版本控制438. ESB服务码编码规则449. ESB接入系统代码表4510. ESB交易分类代码表4711. ESB错误码定义表4812. ESB服务端端口列表491. 引言1.1. 编写目的为了规范ESB服务总线对外发布的服务接口。描述使用的通讯协议、报文格式等。特编此文档，指导其它系统与ESB进行互联。1.2. 项目背景企业在信息化建设方面投入了很大的力度，各家企业基本都建设了服务于各方面的计算机处理系统和信息管理系统，为企业的生产和管理带来了很大的帮助。但随着企业业务的发展，各种业务系统相继建立起来，形成了企业复杂的应用环境，大量异构的系统、应用、业务流程以及数据源，系统之间没有统一的规范和标准，系统间互联是点对点建设的，成网状结构分布，比较混乱，给企业应用系统管理和进一步业务发展带来了诸多不便，维护成本也非常的昂贵。另一方面，企业为了拓展业务范围，需要发展大量的B2C、B2B、B2B2B、B2B2C的业务，业务流程越来越复杂，很多业务需要内部、外部多方系统的协同参与和信息共享来完成，并需要对它们在业务流程上进行无缝集成，原来的点对点的系统架构和开发方式已经很不适应企业业务发展的需要，制约了业务应用的快速推出。针对上面的企业困境，需要找到一个好的解决方案，将各自独立的系统，互联起来，这种互联不应是点到点的互联，而是需要引入企业服务总线ESB，各个系统只需要和ESB进行互联。从而降低了系统间的复杂度，形成了统一的对外服务发布平台。1.3. 定义缩写全称描述与解释SOAService-Oriented Architecture，面向服务架构是一种架构模型、设计的理念。一切即是“服务”，以服务为最小单位，根据需求通过网络对松散耦合的粗粒度应用组件进行分布式部署、组合和使用。ESBEnterprise Service Bus ，企业服务总线其功能定位于“服务集成”而不是“服务实现”。功能主要有：服务定义、服务发布、服务级别、服务路由、服务代理、各种通讯协议的接入、各种通讯报文的转换、服务质量管理、服务流量控制。SOAPSimpleObjectAccessProtocal，简单对象访问协议WSDLWeb Services Description Language Web 服务描述语言1.4. 参考资料2. ESB系统架构图2.1. 原子交易-无需DB-系统架构图功能说明：2.2. 原子交易-需要DB-系统架构图功能说明：2.3. 组合交易系统架构图功能说明：2.4. ESB本地交易系统架构图3. ESB报文规范报文类型父标记属性父标记子标记标记请求报文soapenv:Envelopsoapenv:BodyNs:16位服务码RequestHeaderRequestBody响应报文soapenv:Envelopsoapenv:BodyNs:ResponseResponseHeaderResponseBodysoapenv：Fault名字空间：xmlns:soapenv=”/soap/envelope/” xmlns:esb=http:/localhost/service/esb3.1. ESB请求报文规范主标记名是16服务码如:S002001990CC0003请求报文分成两部分，如下：u 报文头(Header)u 报文体(Body)报文头又分成两部分：u 通用报文头(ResquestHeader)u 扩展报文头(ResquestEHeader)，扩展报文头主要用于一些接入系统的特有报文头数据存放。3.1.1. 请求报文实例规范ESB请求报文使用XML报文格式。报文结构如下： /User12 /Traffic /Traffic/Status ADBCH1234EFD2345EFGIJK /seq1234 10 3.1.2. 服务地址结构wsa-Addressing /User12 /Traffic /Traffic/Statusu ReplayTo：为返回http地址；u To：为请求http地址；u Action: 为请求的动作；3.1.3. 服务安全结构wssec:Security ADBCH1234EFD2345EFGIJK u BinarySecurityToken：为安全令牌，服务端根据安全令牌，通过对数据的验证，来确保数据没有被更改过。3.1.4. 服务识别信息结构wsrm:ReliableMessaging /seq1234 10 u Identifier：为服务标识号；u MessageNumber：为请求消处号；u Identifier和MessageNumber可以唯一确定一笔请求服务；3.1.5. 通用报文头结构RequestHeader序号域名称类型最大长度中文名称必输备注1VerNostring20版本号M8位日期+2位顺序号2ReqSysCdstring6请求方系统代码M3ReqSecCdString20请求方安全节点号O6位的系统代码+14位的安全节点序号4TxnTypString2交易类型MRQ5TxnModString1交易模式M0-正常 1-冲销2-冲正 3-重发6TxnCdString15交易码M7ReqDtString8请求方交易日期M8ReqTmString26请求方交易时间戳MYyyymmddhhnnssuuuuuu9ReqSeqNoString30请求方流水号M本字段保证当日唯一（渠道号+交易日期+流水号）10ChnlNoString3渠道号M11BrchNoString20机构号M12TrmNoString8终端号OTlrNoString10柜员号M13SndFileNmeString255发送文件名O+号分割文件名,文件名使用字母和数字14BgnRecInt开始记录数O15MaxRecInt一次查询最大记录数O16FileHMacString32文件MAC值O17HMacString32报文MAC值M. 通用报文头范例 1.0100000100000123456RQ17000001201009151534258000002334100000003D3121DE740471C1570C6297FF4AAEEF3.2. ESB响应报文规范响应主标记名Response返回报文分成三部分，如下：u 报文头(Header)u 报文体(Body)u 在Body中包含错误体(Fault)报文头又分成两部分：u 通用报文头(ResponseHeader)扩展报文头(ResponseEHeader)，扩展报文头主要用于一些接入系统的特有报文头数据存放。3.2.1. 响应报文实例规范soapenv响应报文使用XML报文格式。报文结构如下： /User12 /Traffic /Traffic/Status ADBCH1234EFD2345EFGIJK /seq1234 10 000000000100帐户余额不足FAIL 3.2.2. 服务安全结构wssec:Security ADBCH1234EFD2345EFGIJK u BinarySecurityToken：为安全令牌，服务端根据安全令牌，通过对数据的验证，来确保数据没有被更改过。3.2.3. 服务地址结构wsa-Addressing /User12 /Traffic /Traffic/Statusu ReplayTo：为返回http地址；u To：为请求http地址；u Action: 为请求的动作；3.2.4. 服务识别信息结构wsrm:ReliableMessaging /seq1234 10 u Identifier：为服务标识号；u MessageNumber：为请求消处号；u Identifier和MessageNumber可以唯一确定一笔请求服务；3.2.5. 通用报文头结构ResponseHeader序号域名称类型最大长度中文名称必输备注1VerNoString20版本号M2RespSysCdString6响应方系统代码M3RespSecCdString20响应方安全节点号O6位的系统代码+14位的安全节点序号4TxnCdString15交易码M5ReqDtString8请求方交易日期M6ReqTmString26请求方交易时间戳M7ReqSeqNoString30请求方流水号M8SvrDtString8服务方交易日期O9SvrTmstring26服务方交易时间戳O10SvrSeqNostring20服务方交易流水号O11RcvFileNmestring255接收文件名O+号分隔多个文件名12TotNumInt总记录数O13CurrRecNumInt当前记录数O14FileHMacString32文件MAC值O15HMacString32报文MAC值M. 通用报文头范例1.01000001000001234RP17000001201009151538028000023420100915153804800000235003D3121DE740471C1570C6297FF4AAEEF3.2.6. 错误体结构Fault序号域名称类型最大长度中文名称备注1TxnStatstring10交易状态FAIL为失败SUCCESS为成功2FaultCodestring12错误码SOAP保留名称3FaultStringstring80错误信息SOAP保留名称错误报文体范例 01500100005 验印不通过 SUCCESS 1.1. XML标记名规范验印系统、集中作业处理中心、支付系统等新增服务系统和ESB通讯作为服务端时，编写的XML通讯接口过程中，除了公共报文头的标记名必须符合本规范，对于报文体中标记名命名必须遵循ESB的Adtec_ESB数据字典-缩写规范V1.0.2.xls文档。关于XML标记名选择有两种情况，一种是服务系统自有的数据如验印系统中图片相关的名称，在ESB提出的数据字典CRCB-综合大前置-ESB服务规范_数据字典V1.0.xls中没有。服务系统需要采用数据字典中缩写规范新增这部分数据字典，并提交给新增数据字典给ESB。一种是服务系统和其他系统可以公用的如帐号，服务系统必须采用CRCB-综合大前置-ESB服务规范_数据字典V1.0.xls中对应的标记名。1.2. ESB分页处理第一页由前端控制，上送BgnRec=1、MaxRec=n(n为每次显示的记录数，由前端确定)的报文，表示从第一条记录开始，查询n条记录，后台返回CurrRecNum=10、TotNum=49的结果，表示当前返回10条记录，共49条记录，前端控制可以向下翻页，向下翻页则上送BgnRec=11、MaxRec=10的报文，表示从第十一条记录开始，查询10条记录，如此类推，前端判断下翻到最后一页的情况是BgnRec+MaxRecTotNum，判断上翻到第一页的情况是Bgn