TalkingBird - 报文转换框架(SOP)


Apache
跨平台
Java

软件简介

本框架的是为了解决Java语言和SOP通信报文之间转换的实际问题而产生。设计的思想是高度屏蔽报文的底层实现,提供灵活配置可能。整个框架的设计思路是,编排、反编排作业实现与配置信息加载进行解耦。目前配置信息加载仅实现读取xml配置文件。针对编排动作抽象出编排接口,反编排动作抽象出反编排接口。对于配置文件加载抽象出元信息加载器体系结构。在实际使用中使用者对以上细节是不会接触到的。
只要对核心接口和抽象类有基本的掌握即可完成开发。

作者邮箱,woate@qq.com。群:413606667

欢迎来信提供您宝贵的建议。

为何取此名?

为什么取名TalkingBird呢?主要是报文转换就是从一种语言编码转换为另外一种语言编码,这让我想到了鹦鹉,她即会说人话,但却不是人,有能理解鸟的语言。于是就想到了说话的鸟。再加上在Talking
in Action的封面的鸟,即可知道,此鸟精细,但却是机械的,也有说话的能力。因此取此名即赋予该框架精细之意。

    1 交易接口文件和头信息文件分开存放







    交易接口文件是对接口主体的描述,其中涉及头信息和交易数据信息。而头信息通常不变,为了提高复用,所以将头信息抽象出来单独存放为头信息文件。他们之间使用内联特性进行引用。







    2 边解析边创建元信息







    目前加载器实现基于边解析边创建元信息,在实际开发接口中很有用处,可以准确发现配置错误的地方。







    3 内联特性







    交易接口在系统信息,公共信息,交易数据均可以使用 inline属性进行内联头信息文件。







    4 多种取值模式







    段提供三种取值模式,分别为常量模式,默认模式,用户模式。常量模式——通常一个字段会涉及常量值的情况,那样设置为constant,则编排时就是固定值,就不需要在使用时对固定值的字段设置值。默认模式——对于有初始值的字段,可以设置为default,这样如果使用时,没有设置值,则使用配置时的默认值,如果设置了值就是用户希望的值。用户模式——在配置时,如果没有设置取值模式或者设置为user,则编排时使用用户提供的值,如果没有提供值,则会提示异常。







    5 字段间接定义







    间接定义是指交易接口文件和头信息文件中的元信息池一次定义字段信息,在使用时可以多次使用 ref 属性进行引用。







    6 别名映射







    交易接口文件和头信息文件都支持别名映射,在 class 和 wrap-class 属性可以使用别名。别名在别名映射节点中集中定义。别且提供作用域domain 属性,该属性设置的不同,作用的范围不一样。







    7 字符集继承







    当接口文件中的Object节点定义了字符集,而Object节点下的字段节点未定义字符集,则可继承Object的字符集。







    8 对Map的支持







    支持反编排为Map,编排数据来源可以是Map。默认构建的是基于HashMap的实例。

一个头文件结构

<?xml version="1.0" encoding="UTF-8"?>
<interfaces xmlns="http://www.woate.com/talkingbird/header"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.woate.com/talkingbird/header">
<!-- 别名映射,提供对别名和类全限定名之间的映射 -->
<alias-mappings>
</alias-mappings>
<!-- 元信息池 -->
<metadatas-pool>
</metadatas-pool>
<!-- 元信息池,提供对字段集中的定义 -->
<request>
</request>
<response>
</response>
<exception>
</exception>
</interfaces>

一个接口文件结构

<?xml version="1.0" encoding="UTF-8"?>
<interfaces xmlns="http://www.woate.com/talkingbird"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.woate.com/talkingbird">
<!-- 别名映射,提供对别名和类全限定名之间的映射 -->
<alias-mappings>
</alias-mappings>
<!-- 元信息池,提供对字段集中的定义 -->
<metadatas-pool>
</metadatas-pool>
<!-- 交易定义 name不一定是交易码,可能是组合交易的别名-->
<interface name="YYYY">
<!-- 请求节点 -->
<request>
<!-- 系统信息头 -->
<sys inline="headers/sys.xml"/>
<!-- 公共信息头 -->
<com inline="headers/com.xml"/>
<busis>
<!-- 交易数据 name是交易码 -->
<busi name="XXXX">
<!-- 交易数据头 -->
<header inline="headers/busi.xml"/>
</busi>
</busis>
</request>
<!-- 应答节点 -->
<response>
<!-- 系统信息头 -->
<sys inline="headers/sys.xml"/>
<!-- 公共信息头 -->
<com inline="headers/com.xml"/>
<busis>
<!-- 交易数据 name是交易码 -->
<busi name="XXXX">
<!-- 交易数据头 -->
<header inline="headers/busi.xml"/>
</busi>
</busis>
</response>
<!--异常节点-->
<exception>
<!-- 系统信息头 -->
<sys inline="headers/sys.xml"/>
<!-- 公共信息头 -->
<com inline="headers/com.xml"/>
<busis>
<!-- 交易数据 name是交易码 -->
<busi name="XXXX">
<!-- 交易数据头 -->
<header inline="headers/busi.xml"/>
</busi>
</busis>
</exception>
</interface>
</interfaces>

编排代码

SOPFactory factory = SOPFactory.getDefaultFactory().load();
SOPPacket packet = factory.getSOPPacketS("YYYY");
SOPSession session = SOPSession.getSession();
session.setAttribute(Dictionary.YNGYJG, "1001");
session.setAttribute(Dictionary.JIO1GY, "901328");
SOPBusiWrapper busiWrapper = session.createBusiData();
busiWrapper.setBusidata("TASKID","XXXXXXXXXXXXXXX");
busiWrapper.setBusidata("ZHJGNO", Integer.toString(i));
busiWrapper.setBusidata("YYJGNO", "351801");
busiWrapper.setBusidata("GUIYDH", "E01100");
busiWrapper.setBusidata("CLASID", "1103");
busiWrapper.setBusidata("APPLID", "E01100");
busiWrapper.setBusidata("SHOJHM", "1581111111");
busiWrapper.setBusidata("DXINLX", "0");
busiWrapper.setBusidata("DXINBM", "15");
busiWrapper.setBusidata("DXINNR", "尊敬的客户:XXXXXXX");
busiWrapper.setBusidata("WAPURL", "");
ByteBuffer buffer = packet.format();
System.out.println(Hex.toHexString(buffer.array()));

反编排代码

SOPFactory factory = SOPFactory.getDefaultFactory().load();
SOPPacket packet = factory.getSOPPacketS("YYYY");
byte[] array = Hex.read(new FileInputStream("test2.hex"));
Hex.write(array);
ByteBuffer buffer = ByteBuffer.wrap(array);
buffer.rewind();
packet.parse(buffer);
SOPSession session = SOPSession.getSession();
System.out.println(session.attributes());
System.out.println(session.peekFirstBusiData().attributes());
System.out.println(session.pollFirstBusiData().busidatas());