ESB项目技术规范指引V17Word文档下载推荐.docx
《ESB项目技术规范指引V17Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《ESB项目技术规范指引V17Word文档下载推荐.docx（47页珍藏版）》请在冰豆网上搜索。
通讯方式：
ESB的通讯方式，对于JAVA语言的系统，要求采用HTTPServlet的通讯方式；
对于C语言的系统，要求通讯方式是Socket。
服务的消费者请求ESB的服务，ESB需要对服务的消费者进行安全的认证。
服务的提供者可以参考ESB系统的系统安全认证方案对ESB系统进行认证。
ESB的技术规范旨在指导企业新建系统和需要改造系统的技术实现，对于存量并且暂定不改造的系统，其与ESB的通讯方式，报文格式，报文编码和交易的接口不受此约束。
ESB系统作为开放性的一个交易平台可以实现适配的功能，实现服务规范与系统接口的转换功能。
1.3.预期使用者
ESB产品研发人员；
ESB实现项目组的架构师、系统分析员和软件开发配置人员；
ESB服务消费者的系统分析员、软件开发人员及相关人员；
ESB服务提供者的系统分析员、软件开发人员及相关人员。
1.4.相关术语
序号
术语/缩略语
全称和说明
1.
ESB
BankEnterpriseServiceBus，企业级服务总线，简称ESB。
本文中如无特殊说明为系统的简称。
2.
API
ApplicationInteraface，指ESB提供前端系统的调用接口，包括C的接口和JAVA的接口。
也指实现该接口的程序包。
3.
JAVAAPI
JAVA语言实现的ESBAPI。
4.
CompositeData
结构对象，简称CD。
是ESB系统信息传递的标准数据结构。
下级对象可以是CD、Field和Array。
5.
Array
数组对象。
多条记录并且每个记录的结构相同可以使用Array。
下级对象可以是CD、Field，一般情况是CD。
6.
Field
域对象，原子数据，包括属性有：
类型、长度、精度和值。
7.
CAPI
C语言实现的ESBAPI。
8.
stNode
C语言的数据结构，XML会转换成stNode的树形结构。
实现了CD和Array的功能。
9.
stField
C语言的原子数据，实现了Field的功能。
10.
拆包
JAVA语言，将XML报文转换成CD对象
C语言，将XML报文转换的结构stNode
11.
组包
JAVA语言，将CD对象转换成XML报文
C语言，将结构stNode转换成XML报文
12.
标准XML
ESB系统与相关外围系统进行数据交互的报文格式。
详细描述见该文档2.3报文数据结构说明和2.4标准XML报文章节，
13.
标准接入
遵行该技术规范，并采用标准XML报文接入ESB的接入方式称为标准接入。
服务消费者和服务提供者都可以是采用标准接入。
14.
非标准接入
保留原有通讯方式、报文格式、加密方式接入ESB的接入方式称为非标准接入。
15.
服务消费者
接入ESB系统，并调用ESB平台上发布服务的系统。
16.
服务提供者
接入ESB系统，并通过ESB系统发布服务的系统。
17.
存量系统
是指改造代价大或行方决定不改造的应用系统
18.
新建系统
是指新立项的系统、决定改造并采用标准报文接入的应用系统
19.
ESB挡板
ESB挡板模拟ESB接收请求和响应。
服务的消费者在开发前期没有条件请求ESB的情况下或需要进行系统内部压力测试的情况下，可以使用ESB的挡板模拟ESB系统提供服务的功能。
20.
服务规范
服务的定义和规范。
服务的定义包括服务的功能，输入要素和输出要素等。
服务的消费者根据服务规范组织数据调用ESB的服务；
服务的提供者根据服务规范实现服务。
21.
服务代码
SERVICE_CODE服务的代码，一个服务的编码，主要定义了服务的业务功能。
22.
服务场景
SERVICE_SCENE，服务的场景，一个服务场景，对服务的业务功能进一步进行细分。
服务代码和服务场景唯一确定一个原子服务。
2.ESB使用指引
2.1.接入ESB的步骤
外围系统原有架构设计中如果没有使用ESB的设计，需要走架构变更。
架构变更通过之后，才可以使用ESB，并按下面的操作使用。
一．详细的系统接入流程
见《ESB项目_系统接入规范流程及指南》
二．获取ESB服务分析的产出——SZBSD文档
ESB有严格的发布计划，如下：
发布计划说明如下：
⏹ESB_SZBSD每周只发布2次版本，周一、周四16：
00发布版本。
其间不接受紧急版本发布。
⏹每次发布说明中包含该版本的修订服务列表清单。
⏹SZBSD文档命名规则：
ESB_SZBSD（Vx.x.x）.如:
ESB_SZBSD（V1.0.0）
⏹ESB_SZBSD的版本号编码规则如下：
X.X.X如：
1.0.1
第一位X:
数字，0-9循环，当第二位逢9后进位。
第二位X:
数字，0-9循环，当第三位逢9后进位。
第三位X:
数字，0-9循环，每次发布加1。
发布内容说明，包含如下文档：
⏹ESB_SZBSD_XXXX_Version.doc
其中包含SZBSD每个模块分类服务规范详细内容。
⏹字段映射文档-XXX
SZBSD服务于后端系统接口映射说明
⏹版本发布概述
对发布的版本修改、新增或删除的内容进行描述。
三．外围系统使用ESB的API开发、测试和上线
ESB的API有两种：
⏹Java版本API
向使用Java开发的外围系统提供的API，内容包括：
commons-logging-1.0.1.jar
ESBClientAPI.jar
framework3.0.jar
log4j-1.2.8.jar
ESB-client.properties
由ESB编译后发布到公共平台，供各系统下载使用。
⏹C语言版本API:
向使用C语言开发的外围系统提供的API，可以向ESB项目组获取。
ESB的API提供文档，文档中包含配置参数的设置、说明，数据对象的构建、使用，以及示例程序。
2.2.ESB环境说明
环境
IP
端口
服务类型
联调测试前需要与ESB项目组一起沟通确认测试环境信息。
2.3.报文数据结构说明
简介:
服务接口定义将使用XML方式来传输接口数据
2.3.1.逻辑结构
服务接口的报文数据结构应当遵循以下结构：
其中CompositeData、Array、Field都是在Integrator平台下的标准数据对象：
⏹Field
值数据对象，用于存储单一数值对象
⏹Array
数组数据对象，可以是域数组或者结构数组
⏹CompositeData
组合数据，用于存储其它类型的数据
报文体的数据结构中，主要包括四大部分：
⏹应用报文头
应用头使用CompositeData存储数据，其结构名称为APP_HEAD，应用报文头结构中只包括域数据对象，如下图：
⏹系统报文头
系统头使用CompositeData存储数据，其结构名称为SYS_HEAD，系统报文头结构中对于上送主机时为域数据对象（Send），主机下送时为域数据对象和结构数组对象（Receive）。
上送如下图：
下送如下图：
⏹本地报文头
本地报文头使用CompositeData存储数据，其结构名称为LOCAL_HEAD，本地报文头中包含有一个结构数组，用以存放交易本地授权信息，如下图：
⏹报文体
报文体中可以包括域（Field）、数组（Array）、结构（CompositeData），其中域存储值数据，按名称添加或获取数据；
数组可以是域数组或者结构数组，按下标添加和获取数据（其中结构数组以行方式组织多条记录，结构嵌套域数组以列方式组织多条记录），如下图：
备注：
✓S表示发送到主机时的报文结构
✓R表示主机返回时的报文结构
✓报文中所有数据对象名称一律大写
✓所有定义的非必输对象取值可以为NULL
✓对于多条记录的组织方式提供两种方式：
按行组织（结构数组）、按列组织（域数组）
✓报文体中的数据对象名称由具体的服务接口定义
组合数据对象可以描述任意复杂的数据结构关系，因此对于报文体，以上结构是服务接口定义中常见的数据结构，对于一些特殊的数据结构关系将在具体服务接口定义中描述
2.3.2.公共报文
公共报文是指服务接口输入输出的公共信息，包括上送公共信息和下送公共信息，利用SYS_HEAD、APP_HEAD、LOCAL_HEAD三个结构来存储公共信息。
2.3.2.1.系统头（SYS_HEAD）
●交易请求
命名
数据类型
说明
约束条件
是否必输
SERVICE_CODE
STRING（15）
服务唯一标识，由ESB提供
Y
SERVICE_SCENE
STRING
（2）
描述每个服务的应用场景，由ESB提供,具体在每个服务中说明.如果该服务只有一种使用场景默认值必须为：
01
CONSUMER_ID
STRING（6）
请求系统编号（直接请求系统）
消费系统编号
类型见：
应用系统简称及编码表
CONSUMER_SEQ_NO
STRING（25）
消费者交易流水号
服务请求系统的交易流水号
需要CONSUMER上送，生成规则见：
流水号编码规则
BUSS_SEQ_NO
STRING（52）
业务流水号
必输,用来唯一标识一笔业务，适用于所有系统.可参考：
ORG_SYS_ID
原始发起方系统编号
服务原始发起方的系统编号
N
TRAN_MODE
STRING（10）
交易模式
ONLINE－联机处理
ASYNC－异步处理
SOURCE_TYPE
渠道类型
不同渠道类型的标示
渠道类型列表
TRAN_DATE
STRING（8）
发送方交易日期
交易发起的日期，格式为YYYYMMDD，无掩码
TRAN_TIMESTAMP
发送方交易时间
交易发起的时间，格式为HHMMSS，无掩码
ORG_WS_ID
STRINGS（30）
原始逻辑终端标识
原始请求系统的终端逻辑标识号，由规划部统一提供和管理
WS_ID
STRING（30）
逻辑终端标识
请求方系统的终端逻辑标识号，由规划部统一提供和管理
ORG_SVR_ID
原始发起方服务器标识
原始请求系统的终端物理标识号，（在报文中放IP地址），便于对于请求方为集群，服务方快速定位请求的机器，快速查找问题，详细的值由规划部统一提供和管理，由规划部统一提供和管理
SVR_ID
发起方服务器标识
请求系统的终端物理标识号,（在报文中放IP地址），便于对于请求方为集群，服务方快速定位请求的机器，快速查找问题，详细的值由规划部统一提供和管理
BRANCH_ID
STRING（9）
发送方机构ID
服务请求者的机构归属[服务提供者为核心时必须]（如柜员所在网点号）
SUB_BRANCH_ID
STRING（20）
发送方网点号
如柜员所在网点号
USER_ID
服务请求者身份（柜员号）
服务请求者的身份（对于ATMP等接入渠道使用核心系统分配的虚拟柜员）[服务提供者为核心时必须]（如交易柜员号）
USER_PASSWORD
服务请求者密码
服务请求者的密码（对于ATMP等接入渠道使用核心系统分配的虚拟柜员）
USER_LEVEL
服务请求者级别
服务请求者的级别
USER_TYPE
服务请求者类别
服务请求者的类别
USER_LANG
用户语言，需要服务系统支持
取值范围：
CHINESE－中文（默认）；
ENGLISH－英文
TRAN_FLAG
STRING
（1）
交易标志
‘0’－正常
‘1’－补正
’2’－冲销
说明：
服务代码共有11位，业务类别（4位）+性质（1位）+预留位（2位）+顺序号（4位）
详见4.4.1服务编码规则。
请求系统编号，指服务使用方系统统一编码。
详见应用系统编码列表。
●交易应答
服务唯一标识
服务应用场景
描述每个服务的应用场景，具体在每个服务中说明.如果该服务只有一种使用场景默认值必须为：
请求系统编号
服务请求系统的流水号
需要CONSUMER上送，以便跟踪
（原交易流水号）
服务系统返回的业务流水号，无掩码.详细参见流水号编码规则
发起方系统编号
交易日期
应答系统返回的日期，格式为YYYYMMDD，无掩码
交易时间
应答系统返回的时间，格式为HHMMSS，无掩码
ESB_SEQ_NO
ESB产生的流水号
ESB产生的流水号，对应管理、监控、跟踪、审计、冲正等用途
RET_STATUS
交易状态
S－系统处理成功
F－系统处理失败
RET
ARRAY
交易返回代码数组
后端系统可返回多个信息，如该服务同时需要复核、授权等
11.1.
RET_CODE
交易返回代码
后台系统对业务错误代码的定义.参见错误编码规则
11.2.
RET_MSG
STRING（100）
交易返回信息
后台系统对业务错误的定义
原始请求系统的终端逻辑标识号
请求方系统的终端逻辑标识号
原始请求系统的终端物理标识号，（在报文中放IP地址），便于对于请求方为集群，服务方快速定位请求的机器，快速查找问题
请求系统的终端物理标识号,（在报文中放IP地址），便于对于请求方为集群，服务方快速定位请求的机器，快速查找问题
用户语言
SERV_SEQ_NO
服务处理返回流水号
服务处理者返回流水号
服务执行状态，返回F时，需要继续根据RET_CODE和RET_MSG判断异常原因。
对于组合服务，由返回代码数组的第一条返回记录即RET_CODE（0）和RET_MSG（0）确定该服务的错误情况。
交易返回代码前面加上原系统ID
2.3.2.2.应用头（APP_HEAD）
1
APPR_FLAG
复核标志
当交易发生复核时，复核是否通过的标志，取值范围：
E－交易录入
A－交易复核
复核时必输
2
APPR_USER_ID_ARRAY
录入柜员数组
2.1
APPR_USER_ID
交易录入柜员标识
当交易发生复核时，原交易录入柜员的唯一标识，复核时必输
2.2
APPR_USER_LEVEL
交易录入柜员级别
交易录入柜员的级别
2.3
APPR_USER_TYPE
交易录入柜员类别
交易录入柜员的类别
3
AUTH_FLAG
授权标志
当交易发生授权时的取值范围如下：
1-需要授权
1-不需要授权
授权时必输
4
AUTH_USER_ID_ARRAY
授权柜员数组
4.1
AUTH_USER_ID
授权柜员标识
当前交易发生授权时，授权柜员的唯一标识，授权时必输
4.2
AUTH_PASSWORD
授权柜员密码
当前交易发生授权时，授权柜员的密码，授权时必输,保留未用
4.3
AUTH_LEVEL
授权柜员级别
授权柜员的级别
4.4
AUTH_TYPE
授权柜员类别
授权柜员的类别
无
APPR_USER_ID_ARRAY
APPR_USER_LEVEL
APPR_USER_TYPE
1－需要授权
0－不需要授权
AUTH_USER_ID_ARRAY
2.3.2.3.本地扩展头（LOCAL_HEAD）
2.4.标准XML报文
2.4.1.标准XML报文示例
请求报文
<
?
xmlversion="
1.0"
encoding="
UTF-8"
>
service>
<
SYS_HEAD>
SERVICE_CODEattr="
field"
/SERVICE_CODE>
CONSUMER_IDattr="
/CONSUMER_ID>
SERVICE_SCENEattr="
01<
/SERVICE_SCENE>
CONSUMER_SEQ_NOattr="
HVPS2C42537<
/CONSUMER_SEQ_NO>
TRAN_DATEattr="
/TRAN_DATE>
/SYS_HEAD>
APP_HEAD/>
LOCAL_HEAD/>
BODY>
CARD_NOattr="
00786<
/SYSTEM_TYPE>
/BODY>
/service>
响应报
升级会员 