基于ESB系统的服务接口规范

Q/TXN南车株洲电机有限公司企业标准Q/TXN**-***.*-2015基于ESB系统的服务接口规范2015-11–**发布2015-11–**实施南车株洲电机有限公司发布Q/TXN**-***.*-2015I前言本标准按照GB/T1.1-2009给出的规则起草。目前公司内部上线应用的系统较多（例如ERP、PDM、HCM、AD域等），各系统间接口集成技术不统一，交换信息格式差异大，接口集成欠缺规范化和标准化，在业务系统接口需求不断增加的情况下，系统集成更趋复杂化，将造成大量的系统开发及维护工作，也很难确保数据的一致性。因此，无论从管理或技术角度考虑，都必须建立公司的服务接口规范，从而按照规范要求进行现有系统集成接口的改造及统一管理，严格要求新的接口必须按照规范要求进行开发及管理，从而使各业务系统接口集成趋于规范化。本标准由信息技术部提出。本标准由技术中心（研究院）技术管理部归口。本标准由信息技术部负责起草。本标准主要起草人：何小红、王浩亮、张凯。Q/TXN**-***.*-20151基于ESB系统的服务接口规范1范围本规范规定了公司信息系统间数据交互的技术要求，确保信息系统间数据交互的安全与稳定。本规范适用于株洲电机及其下属业务单元信息业务系统间数据的交互、共享。2规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。3术语及定义3.1ESBEnterpriseServiceBus企业服务总线3.2ESBSERVER提供多协议的支持以及为服务运行提供了高性能、高可靠的运行环境和方便的扩展机制，为PrimetonESB融入企业IT环境提供了有效支撑及管控手段，不依赖于J2EE容器的特性大大提升了性能。3.3ESBSAMESB软件资产管理模块，提供服务注册、服务查找、SLA管理等功能。3.4ESBSSMESB服务监控模块，提供ESBServer运行时数据的存储、分析能力，增强客户感知度。3.5ESBConsoleESB控制台，对独立和集群环境中的ESBServer进行管理，同时对于服务全生命周期进行管理。3.6WebserviceWebservice是一套标准，它定义了应用程序如何在Web上实现互操作性。可以使用任何语言，在任何平台上编写Webservice。可以通过Webservice标准对这些服务进行查询和访问。3.7ESB服务提供方是指ESB服务接口的开发提供方，为调用方提供接口服务。3.8ESB服务调用方是指ESB服务接口的调用方，调用注册在ESB平台上的服务接口。Q/TXN**-***.*-201523.9ESB服务管理方是指ESB服务接口的集中管理方，负责ESB服务的注册、发布、监控等。4基于ESB的服务接口规范4.1核心业务系统范围公司核心业务系统如下：——ERP：企业资源计划EnterpriseResourcePlanning——PLM：产品生命周期管理ProductLifeCycleManagement——OA：办公自动化OfficeAutomation——HCM：人力资本管理系统HumanCapitalManagement——ITSM：IT服务管理系统ITServiceManagement——TDM：试验数据管理系统TestDataManagement——RTX：腾讯通（企业实时通讯平台）RealTimeeXpert——AD：域活动目录ActiveDirectory4.2信息系统接口开发原则信息系统之间的接口开发应采用ESB总线集成方式。4.3基于ESB的应用集成架构基于ESB的信息系统集成总体架构见下图。架构模式图4.4ESB总线服务接口工作原理基于ESB的信息系统服务接口工作原理见下图。Q/TXN**-***.*-20153统一服务工作原理图服务提供方负责处理本系统的业务逻辑，将业务处理进行封装，以webservice形式对外发布。服务管理方负责将服务接口在ESB总线服务管理平台中进行集中管理。服务调用方负责调用统一服务注册中心中的服务。“服务调用方”和“服务提供方”是一对抽象的逻辑概念。对于一个具体的应用系统来说，它既可能是服务调用方，也可能是服务提供方，或者同时具备两种角色。4.5ESB服务规范4.5.1服务描述规范服务描述规范主要说明接口服务的描述形式，服务使用者就可以根据服务描述了解服务的技术实现形式、功能和输入/输出等信息。业务系统向外暴露的服务和ESB向外暴露的服务都需要通过WSDL的方式进行描述，这样使得相关人员可以根据WSDL开发服务调用客户端，WSDL需遵循如下相关标准：a标准b版本cWSDLdWSDL1.1eWS-IfWS-IBasicProfile1.1g1)soap-)xsi-)xsd-)soapenc-)wsdl-)soapbind-备注：对于业务系统如何规划WSDL文件不在本规范讨论范围内。4.5.2请求报文规范4.5.2.1相关标准：服务消费者[服务客户端]运行时需要使用SOAP报文与ESB上暴露的服务进行交互，需遵循如下相关标准：Q/TXN**-***.*-20154m标准n版本oSOAPpSOAP1.1qWS-IrWS-IBasicProfile1.1s1)soap-)xsi-)xsd-)soapenc-)wsdl-)soapbind-：服务消费者[服务客户端]调用服务的还需设置SOAPHeader内容，具体如下：属性名称数据类型说明Version版本字符型1)被调用服务操作的版本标识；2)关于版本编码详见“5.5版本编码规范”章节；RequestID-BIZ1)RequestID-ESB请求编码字符型2)服务调用客户端提交的请求的唯一标识；3)应用系统和服务总线任何一方发现SOAPHeader中没有RequestID或RequestID为空，都要生成有效的RequestID；4)RequestID作为端到端全路径跟踪的基础，所以需要在其产生之后，端到端服务调用结束之前在相关的应用系统之间传递；5)关于请求编码详见“5.4请求编码规范”章节；AppID应用编码字符型1)应用编码，即发起请求的应用系统的编码；2)关于应用编码详见“5.6应用编码规范”章节；4.5.2.3HTTPHeader：服务消费者[服务客户端]调用服务的还需设置HTTPHeader内容，具体如下：属性名称数据类型说明Version版本字符型1)被调用服务操作的版本标识；2)关于版本编码详见“5.5版本编码规范”章节；Q/TXN**-***.*-20155RequestID请求编码字符型1)服务调用客户端提交的请求的唯一标识；2)应用系统和服务总线任何一方发现HTTPHeader中没有RequestID或RequestID为空，都要生成有效的RequestID；3)RequestID作为端到端全路径跟踪的基础，所以需要在其产生之后，端到端服务调用结束之前在相关的应用系统之间传递；4)关于请求编码详见“5.4请求编码规范”章节；AppID应用编码字符型1)应用编码，即发起请求的应用系统的编码；2)关于应用编码详见“5.6应用编码规范”章节；4.5.2.4SOAPBody：请求报文的SOAPBody内容由具体的服务描述文件WSDL来定义。4.5.3响应报文规范4.5.3.1相关标准：服务提供者运行时需要使用SOAP报文与ESB进行交互，并遵循如下相关标准：y标准z版本aaSOAPbbSOAP1.1ccWS-IddWS-IBasicProfile1.1ee1)soap-)xsi-)xsd-)soapenc-)wsdl-)soapbind-：服务提供者返回结果时还需设置SOAPHeader内容，具体如下：属性名称数据类型说明RequestID-BIZRequestID-ESB请求编码字符型1)服务调用客户端提交的请求的唯一标识；2)应用系统和服务总线任何一方发现SOAPHeader中没有RequestID或RequestID为空，都要生成有效的RequestID；3)RequestID作为端到端全路径跟踪的基础，所以需要在其产生之后，端到端服务调用结束之前在相关的应用系统之间传递；4)关于请求编码详见“5.4请求编码规范”章节；Q/TXN**-***.*-201564.5.3.3HTTPHeader：服务提供者返回结果时还需设置HTTPHeader内容，具体如下：属性名称数据类型说明RequestID请求编码字符型1)服务调用客户端提交的请求的唯一标识；2)应用系统和服务总线任何一方发现HTTPHeader中没有RequestID或RequestID为空，都要生成有效的RequestID；3)RequestID作为端到端全路径跟踪的基础，所以需要在其产生之后，端到端服务调用结束之前在相关的应用系统之间传递；4)关于请求编码详见“5.4请求编码规范”章节；4.5.3.4SOAPBody：响应报文的SOAPBody内容由具体的服务描述文件WSDL来定义。4.5.4确认报文规范确认报文主要使用在异步调用场景，有请求报文的接受方向报文的发送方确认已经正确收到报文。4.5.4.1相关标准：服务提供者运行时需要使用SOAP报文与ESB进行交互，并遵循如下相关标准：标准版本SOAPSOAP1.1WS-IWS-IBasicProfile1.11)soap-)xsi-)xsd-)soapenc-)wsdl-)soapbind-：服务提供者返回结果时还需设置SOAPHeader内容，具体如下：属性名称数据类型说明Q/TXN**-***.*-20157RequestI