Biz-SIP金融级业务中台(http://bizsip.bizmda.com))是一套基于领域驱动设计(DDD)架构,能快速构建金融级云原生架构的服务整合中间件,整合了在金融场景里锤炼出来的最佳实践。
Biz-SIP业务中台支持多种报文类型的格式转换器,包括XML、JSON、定长、有分隔符、ISO-8583等报文类型的解包和打包,格式转换器可以在Source模块和Sink服务中进行配置和使用,实现打包(平台标准报文格式转换成外部报文格式)和解包(外部报文格式转换成平台标准报文格式)。
fixed-length类型的格式转换器,能把Biz-SIP内部标准消息报文,根据配置打包成外部的定长格式报文;同时也直接把外部的定长格式报文,解包成Biz-SIP内部标准消息报文。
本节案例中是在Sink服务模块中,配置fixed-length格式转换器,以实现定长格式报文(fixed-length)的打包和解包:
其中,App层是通过Sink透传App服务,直接让调用方通过OpenAPI接口调用Sink服务(fixed-length-sink),Sink服务会把平台内部标准格式(JSONObject对象,内部即JSON报文)进行打包成定长格式报文,传给通讯连接器Connector,原包返回后再解包成平台内部标准格式,响应给调用方。
具体代码和配置可以查看Biz-SIP源代码中的Sample相关测试案例(https://gitee.com/szhengye/biz-sip)
一、Sink层Sink服务的开发和配置
同样,在Biz-SIP配置目录的sink.yml中,配置对应的Sink服务:
- id: fixed-length-sink
type: rest
url: http://bizsip-sample-sink/fixed-length-sink
converter:
type: fixed-length
pre-unpack:
- name: sex
length: 1
functions:
- name: trim
pack-rules:
- predicate: '#{#data[sex]=="0"}'
rule: fixed-length-sink/woman.yml
- predicate: '#{#data[sex]=="1"}'
rule: fixed-length-sink/man.yml
- predicate:
rule: fixed-length-sink/error.yml
unpack-rules:
- predicate: '#{#data[sex]=="0"}'
rule: fixed-length-sink/woman.yml
- predicate: '#{#data[sex]=="1"}'
rule: fixed-length-sink/man.yml
- predicate:
rule: fixed-length-sink/error.yml
connector:
type: service
class-name: com.bizmda.bizsip.sample.sink.service.EchoConnectorService
可以看到fixed-length-sink这个Sink服务,connector关联了能把请求报文直接原包响应返回的EchoConnectorService类。而格式转换器converter,则直接设置“type: fixed-length”,表示采用定长格式转换器,作为当前Sink服务的格式转换器。
Sink服务的converter项下配置了pre-unpack参数,说明在对定长报文进行解包时,会首先用pre-unpack规则进行预解包,根据预解包的域值,以及unpack-rules断言规则,选择指定的解包规则配置文件,进行解包操作,上面配置中,是根据报文中的sex域值来决定的。pack-rules参数,表示会根据pack-rules断言规则,选择指定的打包规则配置文件,进行打包操作,上面配置中,也是根据报文中的sex域值来决定的。
相关打解包规则配置文件,内容如下:
fixed-length-sink/woman.yml
- name: sex
length: 1
- name: accountNo
length: 8
- name: accountName
length: 10
- name: balance
length: 10
fixed-length-sink/man.yml
- name: sex
length: 1
- name: accountNo
length: 8
unpack-functions:
- name: trim
- name: accountName
length: 10
unpack-functions:
- name: trim
- name: balance
length: 10
pack-functions:
- name: decimalFormat
args:
- "###,###.00"
fixed-length-sink/error.yml
- name: sex
length: 1
- name: accountNo
length: 8
- name: accountName
length: 10
这个Sink服务没有设置processor属性,即为缺省default类型,采用默认的缺省Sink服务流程来处理的,处理步骤依次为:
- 调用格式转换器converter对传入报文进行打包;
- 对上步打包后的报文作为调用请求报文,调用通讯适配器connector进行处理,并收到并返回响应报文;
- 调用格式转换器converter对响应报文进行解包,并返回解包后的报文。
最后,还需要在SampleSinkApplication的应用配置文件application-local.yml中,在bizsip.sink-id配置项中,增加fixed-length-sink以便启动Sink服务:
bizsip:
config-path: /var/bizsip/config
sink-id: hello-sink,echo-sink,simple-xml-sink,velocity-json-sink,velocity-xml-sink,fixed-length-sink
二、App层App服务的开发和配置
对于Sink透传App服务,只需要在app.yml中配置即可:
- app-service-id: /sink/fixed-length-sink
type: sink-service
sink-id: fixed-length-sink
可以看到在app.yml中,配置了App服务“/sink/fixed-length-sink”,类型为Sink透传App服务(sink-service),透传调用的Sink服务为“fixed-length-sink”。
三、启动应用进行测试
启动SampleSinkApplication、SampleAppApplication应用,通过OpenAPI接口进行测试:
$ curl -H "Content-Type:application/json" -H "Biz-Service-Id:/sink/fixed-length-sink" -X POST --data '{"accountName": "王五","balance": 500,"accountNo":"005","sex":"0"}' http://localhost:8888/api|jq
{
"code": 0,
"message": "success",
"extMessage": null,
"appServiceId": "/sink/fixed-length-sink",
"traceId": "78b51f246e20451291713beda492ace8",
"parentTraceId": null,
"timestamp": 1647176027111,
"data": {
"accountName": "王五 ",
"sex": "0",
"balance": "500 ",
"accountNo": "005 "
}
}
EchoConnectorService打印日志:
收到报文:
====+ 01-02-03-04-05-06-07-08-09-10-11-12-13-14-15-16-17-18-19-20 + ====== ASCII ====== +
0000: 30 30 30 35 20 20 20 20 20 E7 8E 8B E4 BA 94 20 20 20 20 20 | 0005 王.五. |
0020: 20 20 20 35 30 30 20 20 20 20 20 20 20 | 500 ....... |
Biz-SIP网站:http://bizsip.bizmda.com
Gitee代码库:https://gitee.com/szhengye/biz-sip