Biz-SIP业务中台支持多种报文类型的格式转换器,包括XML、JSON、定长、有分隔符、ISO-8583等报文类型的解包和打包,格式转换器可以在Source模块和Sink服务中进行配置和使用,实现打包(平台标准报文格式转换成外部报文格式)和解包(外部报文格式转换成平台标准报文格式)。
velocity-json类型的格式转换器,能支持基于velocity模板的JSON格式消息适配,直接把Biz-SIP内部标准消息,根据配置velocity模板,打包成外部的JSON格式报文;同时也直接把外部的JSON格式报文,快速直接解包成Biz-SIP内部标准消息。
本节案例中是在Sink服务模块中,配置velocity-json格式转换器,以实现基于velocity模板的JSON格式报文(velocity-json)的打包和解包:
其中,App层是通过Sink透传App服务,直接让调用方通过OpenAPI接口调用Sink服务(velocity-json-sink),Sink服务会把平台内部标准格式(JSONObject对象,内部即JSON报文)进行打包,传给通讯连接器Connector,返回后再解包成平台内部标准格式,返回给调用方。
一、Sink层Sink服务的开发和配置
首先,我们需要为Sink服务配置一个通讯连接器Connector,为了简单起见,直接配置了一个Spring Service Connector,并绑定了直接把请求报文报包返回的档板类(EchoConnectorService.java),详细代码请参见“Biz-SIP业务中台案例实战(6)——简单XML格式转换器(simple-xml)”一节)。
然后,在在Biz-SIP配置目录的sink.yml中,配置对应的Sink服务:
- id: velocity-json-sink
type: rest
url: http://bizsip-sample-sink/velocity-json-sink
converter:
type: velocity-json
pack-rules:
- predicate: '#{#data[sex]=="0"}'
rule: velocity-json-sink/woman.vm
- predicate: '#{#data[sex]=="1"}'
rule: velocity-json-sink/man.vm
- predicate:
rule: velocity-json-sink/error.vm
unpack-rules:
connector:
type: service
class-name: com.bizmda.bizsip.sample.sink.service.EchoConnectorService
可以看到velocity-json-sink这个Sink服务,connector关联了上面编写的EchoConnectorService类。而格式转换器converter,则直接设置“type: velocity-json”,表示采用基于velocity模板的JSON格式转换器,作为当前Sink服务的格式转换器。
Sink服务的converter项下配置了pack-rules参数,表示会根据报文中条件来决定采用什么velocity模板,上面配置中,是根据报文中的sex域值来决定的。
这个Sink服务没有设置processor属性,即为缺省default类型,采用默认的缺省Sink服务流程来处理的,处理步骤依次为:
- 调用格式转换器converter对传入报文进行打包;
- 对上步打包后的报文作为调用请求报文,调用通讯适配器connector进行处理,并收到并返回响应报文;
- 调用格式转换器converter对响应报文进行解包,并返回解包后的报文。
最后,还需要在SampleSinkApplication的应用配置文件application-local.yml中,在bizsip.sink-id配置项中,增加velocity-json-sink以便启动Sink服务:
bizsip:
config-path: /var/bizsip/config
sink-id: hello-sink,echo-sink,simple-xml-sink,velocity-json-sink
二、App层App服务的开发和配置
对于Sink透传App服务,只需要在app.yml中配置即可:
- app-service-id: /sink/velocity-json-sink
type: sink-service
sink-id: velocity-json-sink
可以看到在app.yml中,配置了App服务“/sink/velocity-json-sink”,类型为Sink透传App服务(sink-service),透传调用的Sink服务为“velocity-json-sink”。
三、启动应用进行测试
启动SampleSinkApplication、SampleAppApplication应用,通过OpenAPI接口进行测试。
首先,请求报文中将sex域设置为"0",应该会调用velocity-json-sink/woman.vm模板:
$ curl -H "Content-Type:application/json" -H "Biz-Service-Id:/sink/velocity-json-sink" -X POST --data '{"accountName": "王五","sex": "0","accountNo":"005"}' http://lalhost:8888/api|jq
{
"code": 0,
"message": "success",
"extMessage": null,
"appServiceId": "/sink/velocity-json-sink",
"traceId": "a01c500f69964d5b8b37b54e59822be7",
"parentTraceId": null,
"timestamp": 1647176026507,
"data": {
"sex": "女",
"account_no": "005",
"account_name": "王五"
}
}
EchoConnectorService打印日志:
收到报文:
====+ 01-02-03-04-05-06-07-08-09-10-11-12-13-14-15-16-17-18-19-20 + ====== ASCII ====== +
0000: 7B 73 65 78 3A 22 E5 A5 B3 22 2C 61 63 63 6F 75 6E 74 5F 6E | {sex:"女.",account_n |
0020: 6F 3A 22 30 30 35 22 2C 61 63 63 6F 75 6E 74 5F 6E 61 6D 65 | o:"005",account_name |
0040: 3A 22 E7 8E 8B E4 BA 94 22 7D | :"王.五."}.......... |
其次,请求报文中将sex域设置为"1",应该会调用velocity-json-sink/man.vm模板:
$ curl -H "Content-Type:application/json" -H "Biz-Service-Id:/sink/velocity-json-sink" -X POST --data '{"accountName": "王五","sex": "1","accountNo":"005"}' http://lalhost:8888/api|jq
{
"code": 0,
"message": "success",
"extMessage": null,
"appServiceId": "/sink/velocity-json-sink",
"traceId": "f0861bfc07c64048ae2499c12030878a",
"parentTraceId": null,
"timestamp": 1647176026608,
"data": {
"sex": "男",
"account_no": "005",
"account_name": "王五"
}
}
EchoConnectorService打印日志:
收到报文:
====+ 01-02-03-04-05-06-07-08-09-10-11-12-13-14-15-16-17-18-19-20 + ====== ASCII ====== +
0000: 7B 73 65 78 3A 22 E7 94 B7 22 2C 61 63 63 6F 75 6E 74 5F 6E | {sex:"男.",account_n |
0020: 6F 3A 22 30 30 35 22 2C 61 63 63 6F 75 6E 74 5F 6E 61 6D 65 | o:"005",account_name |
0040: 3A 22 E7 8E 8B E4 BA 94 22 7D | :"王.五."}.......... |
最后,请求报文中将sex域设置为"2",应该会调用velocity-json-sink/error.vm模板:
$ curl -H "Content-Type:application/json" -H "Biz-Service-Id:/sink/velocity-json-sink" -X POST --data '{"accountName": "王五","sex": "2","accountNo":"005"}' http://lalhost:8888/api|jq
{
"code": 0,
"message": "success",
"extMessage": null,
"appServiceId": "/sink/velocity-json-sink",
"traceId": "3c9f4c9207ae4875b05ef682f7882a2d",
"parentTraceId": null,
"timestamp": 1647176026756,
"data": {
"sex": "?",
"account_no": "005",
"account_name": "王五"
}
}
EchoConnectorService打印日志:
收到报文:
====+ 01-02-03-04-05-06-07-08-09-10-11-12-13-14-15-16-17-18-19-20 + ====== ASCII ====== +
0000: 7B 73 65 78 3A 22 3F 22 2C 61 63 63 6F 75 6E 74 5F 6E 6F 3A | {sex:"?",account_no: |
0020: 22 30 30 35 22 2C 61 63 63 6F 75 6E 74 5F 6E 61 6D 65 3A 22 | "005",account_name:" |
0040: E7 8E 8B E4 BA 94 22 7D | 王.五."}............ |