Biz-SIP业务中台案例实战（8）——模板XML格式转换器（velocity-xml）

本文主要是介绍Biz-SIP业务中台案例实战（8）——模板XML格式转换器（velocity-xml），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

Biz-SIP金融级业务中台(http://bizsip.bizmda.com))是一套基于领域驱动设计（DDD）架构，能快速构建金融级云原生架构的服务整合中间件，整合了在金融场景里锤炼出来的最佳实践。

Biz-SIP业务中台支持多种报文类型的格式转换器，包括XML、JSON、定长、有分隔符、ISO-8583等报文类型的解包和打包，格式转换器可以在Source模块和Sink服务中进行配置和使用，实现打包（平台标准报文格式转换成外部报文格式）和解包（外部报文格式转换成平台标准报文格式）。
velocity-xml类型的格式转换器，和前面介绍的velocity-json格式转换器类似，能支持基于velocity模板的XML格式消息适配，直接把Biz-SIP内部标准消息，根据配置velocity模板，打包成外部的XML格式报文；同时也直接把外部的XML格式报文，快速直接解包成Biz-SIP内部标准消息。
本节案例中是在Sink服务模块中，配置velocity-xml格式转换器，以实现基于velocity模板的XML格式报文（velocity-xml）的打包和解包：

其中，App层是通过Sink透传App服务，直接让调用方通过OpenAPI接口调用Sink服务（velocity-xml-sink），Sink服务会把平台内部标准格式（JSONObject对象，内部即JSON报文）进行打包成XML报文，传给通讯连接器Connector，原包返回后再解包成平台内部标准格式，响应给调用方。

具体代码和配置可以查看Biz-SIP源代码中的Sample相关测试案例（https://gitee.com/szhengye/biz-sip）

一、Sink层Sink服务的开发和配置

同样，在Biz-SIP配置目录的sink.yml中，配置对应的Sink服务：

- id: velocity-xml-sinktype: resturl: http://bizsip-sample-sink/elocity-xml-sinkconverter:type: velocity-xmlpack-rules:- predicate: '#{#data[sex]=="0"}'rule: velocity-xml-sink/woman.vm- predicate: '#{#data[sex]=="1"}'rule: velocity-xml-sink/man.vm- predicate:rule: velocity-xml-sink/error.vmunpack-rules:connector:type: serviceclass-name: com.bizmda.bizsip.sample.sink.service.EchoConnectorService

可以看到velocity-xml-sink这个Sink服务，connector关联了能把请求报文直接原包响应返回的EchoConnectorService类。而格式转换器converter，则直接设置“type: velocity-xml”，表示采用基于velocity模板的XML格式转换器，作为当前Sink服务的格式转换器。
Sink服务的converter项下配置了pack-rules参数，表示会根据报文中条件来决定采用什么velocity模板，上面配置中，是根据报文中的sex域值来决定的。
相关打解包规则配置文件，配置如下：

velocity-xml-sink/woman.vm
<account><name>${data.accountName}</name><balance>${data.balance}</balance><no>${data.accountNo}</no><sex>女人</sex>
</account>velocity-xml-sink/man.vm
<account><name>${data.accountName}</name><balance>${data.balance}</balance><no>${data.accountNo}</no><sex>男人</sex>
</account>velocity-xml-sink/error.vm
<account><name>${data.accountName}</name><balance>${data.balance}</balance><no>${data.accountNo}</no><sex>不知道</sex>
</account>

这个Sink服务没有设置processor属性，即为缺省default类型，采用默认的缺省Sink服务流程来处理的，处理步骤依次为：

1. 调用格式转换器converter对传入报文进行打包；
2. 对上步打包后的报文作为调用请求报文，调用通讯适配器connector进行处理，并收到并返回响应报文；
3. 调用格式转换器converter对响应报文进行解包，并返回解包后的报文。

最后，还需要在SampleSinkApplication的应用配置文件application-local.yml中，在bizsip.sink-id配置项中，增加velocity-json-sink以便启动Sink服务：

bizsip:config-path: /var/bizsip/configsink-id: hello-sink,echo-sink,simple-xml-sink,velocity-json-sink,velocity-xml-sink

二、App层App服务的开发和配置

对于Sink透传App服务，只需要在app.yml中配置即可：

- app-service-id: /sink/velocity-xml-sinktype: sink-servicesink-id: velocity-xml-sink

可以看到在app.yml中，配置了App服务“/sink/velocity-xml-sink”，类型为Sink透传App服务（sink-service），透传调用的Sink服务为“velocity-xml-sink”。

三、启动应用进行测试

启动SampleSinkApplication、SampleAppApplication应用，通过OpenAPI接口进行测试。
首先，请求报文中将sex域设置为"0"，应该会调用velocity-xml-sink/woman.vm模板：

$ curl -H "Content-Type:application/json" -H "Biz-Service-Id:/sink/velocity-xml-sink" -X POST --data '{"accountName": "王五","sex": "0","accountNo":"005","balance":1}' http://localhost:8888/api|jq{"code": 0,"message": "success","extMessage": null,"appServiceId": "/sink/velocity-xml-sink","traceId": "2146dd16d67e42c485e94678cfc13064","parentTraceId": null,"timestamp": 1647176026824,"data": {"account": {"no": "005","sex": "女人","balance": 100,"name": "王五"}}
}

EchoConnectorService打印日志：

收到报文:
====+ 01-02-03-04-05-06-07-08-09-10-11-12-13-14-15-16-17-18-19-20 + ====== ASCII  ====== +
0000: 3C 61 63 63 6F 75 6E 74 3E 0A 20 20 20 20 3C 6E 61 6D 65 3E | <account>.    <name> |
0020: E7 8E 8B E4 BA 94 3C 2F 6E 61 6D 65 3E 0A 20 20 20 20 3C 62 | 王.五.</name>.    <b |
0040: 61 6C 61 6E 63 65 3E 31 30 30 3C 2F 62 61 6C 61 6E 63 65 3E | alance>100</balance> |
0060: 0A 20 20 20 20 3C 6E 6F 3E 30 30 35 3C 2F 6E 6F 3E 0A 20 20 | .    <no>005</no>.   |
0080: 20 20 3C 73 65 78 3E E5 A5 B3 E4 BA BA 3C 2F 73 65 78 3E 0A |   <sex>女.人.</sex>. |
0100: 3C 2F 61 63 63 6F 75 6E 74 3E                               | </account>.......... |

其次，请求报文中将sex域设置为"1"，应该会调用velocity-xml-sink/man.vm模板：

$ curl -H "Content-Type:application/json" -H "Biz-Service-Id:/sink/velocity-xml-sink" -X POST --data '{"accountName": "王五","sex": "1","accountNo":"005","balance":10}' http://localhost:8888/api|jq{"code": 0,"message": "success","extMessage": null,"appServiceId": "/sink/velocity-xml-sink","traceId": "8061430704b24a86953e9c8a26d1d7a4","parentTraceId": null,"timestamp": 1647176026930,"data": {"account": {"no": "005","sex": "男人","balance": 1000,"name": "王五"}}
}

EchoConnectorService打印日志：

收到报文:
====+ 01-02-03-04-05-06-07-08-09-10-11-12-13-14-15-16-17-18-19-20 + ====== ASCII  ====== +
0000: 3C 61 63 63 6F 75 6E 74 3E 0A 20 20 20 20 3C 6E 61 6D 65 3E | <account>.    <name> |
0020: E7 8E 8B E4 BA 94 3C 2F 6E 61 6D 65 3E 0A 20 20 20 20 3C 62 | 王.五.</name>.    <b |
0040: 61 6C 61 6E 63 65 3E 31 30 30 30 3C 2F 62 61 6C 61 6E 63 65 | alance>1000</balance |
0060: 3E 0A 20 20 20 20 3C 6E 6F 3E 30 30 35 3C 2F 6E 6F 3E 0A 20 | >.    <no>005</no>.  |
0080: 20 20 20 3C 73 65 78 3E E5 A5 B3 E4 BA BA 3C 2F 73 65 78 3E |    <sex>女.人.</sex> |
0100: 0A 3C 2F 61 63 63 6F 75 6E 74 3E                            | .</account>......... |

最后，请求报文中将sex域设置为"2"，应该会调用velocity-json-sink/error.vm模板：

$ curl -H "Content-Type:application/json" -H "Biz-Service-Id:/sink/velocity-xml-sink" -X POST --data '{"accountName": "王五","sex": "2","accountNo":"005","balance":10}' http://localhost:8888/api|jq{"code": 0,"message": "success","extMessage": null,"appServiceId": "/sink/velocity-xml-sink","traceId": "f778623432584b15878038e7db1d2bce","parentTraceId": null,"timestamp": 1647176027027,"data": {"account": {"no": "005","sex": "不知道","balance": 1000,"name": "王五"}}
}

EchoConnectorService打印日志：

收到报文:
====+ 01-02-03-04-05-06-07-08-09-10-11-12-13-14-15-16-17-18-19-20 + ====== ASCII  ====== +
0000: 3C 61 63 63 6F 75 6E 74 3E 0A 20 20 20 20 3C 6E 61 6D 65 3E | <account>.    <name> |
0020: E7 8E 8B E4 BA 94 3C 2F 6E 61 6D 65 3E 0A 20 20 20 20 3C 62 | 王.五.</name>.    <b |
0040: 61 6C 61 6E 63 65 3E 31 30 30 30 3C 2F 62 61 6C 61 6E 63 65 | alance>1000</balance |
0060: 3E 0A 20 20 20 20 3C 6E 6F 3E 30 30 35 3C 2F 6E 6F 3E 0A 20 | >.    <no>005</no>.  |
0080: 20 20 20 3C 73 65 78 3E E4 B8 8D E7 9F A5 E9 81 93 3C 2F 73 |    <sex>不.知.道.</s |
0100: 65 78 3E 0A 3C 2F 61 63 63 6F 75 6E 74 3E 0A                | ex>.</account>...... |

Biz-SIP网站：http://bizsip.bizmda.com
Gitee代码库：https://gitee.com/szhengye/biz-sip

这篇关于Biz-SIP业务中台案例实战（8）——模板XML格式转换器（velocity-xml）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---