CN105049256B - 一种通用自定义接口报文实现方法及系统 - Google Patents

Abstract

本发明涉及一种通用自定义接口报文实现方法，包括如下步骤：步骤1，协定报文协议，确定报文内容；步骤2，根据报文协议配置查询类报文模板和更新类报文模板；步骤3，根据报文内容所属的类型，选择相应类型的报文模板，将报文内容按照选择的报文模板进行组装，得到通用自定义接口报文。本发明所述报文通用性强、复用度高，轻量级，不依赖特殊的API，大大降低接口制定的复杂度和开发工作量，便于统一化管理，便于工作量精准评估。

Description

一种通用自定义接口报文实现方法及系统

技术领域

本发明涉及通信技术领域，尤其涉及一种通用自定义接口报文实现方法及系统。

背景技术

对于综合资源管理系统，需要提供大量的资源查询接口给外围系统，如营业系统选号接口、资源能力查询接口等；但是经过分析发现，大部分接口基本可划分为两类：查询类和更新类(包括删除，可看作是一种特殊的更新操作)；而通常在定义接口报文的时候都是以业务动作为基本单元，一个业务动作对应一套接口报文，并且每一个报文节点都是双方协定接口交互方式后预定义好的，一旦有变化就需要修改程序，非常麻烦。

报文片段：

从上述的报文片段可以看出，传统的报文组装方式中，每一个节点都是预定义好的，每一个节点即对应一个实际的业务元素，如果业务需求发生变化新增或修改某个节点，则需要相应的修改服务端解析程序，可移植性和扩展性很差。传统的组装方式的，服务端的解析是和报文强关联的，报文变更服务端的解析也要跟着修改。

Sun公司提供了一套利用注解方式解析xml文件的API(javax.xml.bind..annotation)很好的支持了报文节点的属性配置管理，但是考虑到在有些情况下，由于业务的变更可能需要对报文内容进行修改，如果采用注解方式则需要修改java源码并重新发布程序，在一定程度上不够灵活。

发明内容

本发明所要解决的技术问题是针对现有技术的不足，提供一种通用自定义接口报文实现方法及系统。

本发明解决上述技术问题的技术方案如下：一种通用自定义接口报文实现方法，包括如下步骤：

步骤1，协定报文协议，确定报文内容；

步骤2，根据报文协议配置查询类报文模板和更新类报文模板；

步骤3，根据报文内容所属的类型，选择相应类型的报文模板，将报文内容按照选择的报文模板进行组装，得到通用自定义接口报文。

本发明的有益效果是：本发明所述报文通用性强、复用度高，轻量级，不依赖特殊的API，大大降低接口制定的复杂度和开发工作量，便于统一化管理，便于工作量精准评估。

在上述技术方案的基础上，本发明还可以做如下改进。

进一步，步骤2中所述查询类报文模板和更新类报文模板为包括报文头xmlHeader和报文体xmlBody的XML报文模板，所述报文头xmlHeader定义鉴权信息，所述报文体xmlBody定义根节点信息、业务节点信息和节点属性信息。

进一步，所述报文头xmlHeader定义的鉴权信息包括服务端应用编码、客户端应用编码、调用方式及调用方身份标识。

进一步，所述报文体xmlBody定义的根节点信息用于区分所述报文模板的类型，所述业务节点信息用于定义业务节点的内容，所述节点属性信息用于定义业务节点的属性。

进一步，上述技术方案还包括当接口参数有变更时，根据变更的内容直接修改报文的业务节点信息和/或节点属性信息。

进一步，所述查询类请求报文的报文体xmlBody定义如下：

a、输出属性节点output_field，是0或多个；

b、查询条件节点query_condition，是0或多个，该节点存在时必须包含两个子节点，分别为操作符operator和属性值value；

c、排序条件节点sort_condition，是0或多个；

d、分页节点page_condition，必须，该节点下包含三个子节点，分别是page_size、current_page和total_record；

所述查询类响应报文的报文体xmlBody定义如下：

a、响应编码resp_code，必填；实际项目中可能会定义统一的响应编码；

b、响应消息描述resp_desc，必填；

c、每页的数据量；

d、当前页码；

e、返回的数据总量；

f、总页数；

g、输出的属性集合，根据output_field节点自动拼装。

进一步，所述更新类报文的报文体xmlBody定义为二级节点update_item，为1个或多个，所述二级节点update_item定义五个节点，分别为：

a、变更目标target_field，目标属性，是0或多个，如果是数据同步更新或插入操作时使用该节点；

b、查询条件节点query_condition，是0或多个，该节点存在时必须包含两个子节点，分别为操作符operator和属性值value；

c、操作类型operate_type，非空，定义操作类型是修改、删除或其它业务动作；

d、操作原因或备注operate_note,可空，填写操作原因或备注信息；

e、是否指定操作目标intended_target，非空，如果指定操作目标则target_field节点不能为空；1为是，0为否。

进一步，所述更新类报文的报文体xmlBody还包括一个扩展节点，所述扩展节点与二级节点update_item并列。

本发明解决上述技术问题的另一技术方案如下：一种通用自定义接口报文实现系统，包括协议商定模块、模板配置模块和报文组装模块；

所述协议商定模块，其用于协定报文协议，确定报文内容；

所述模板配置模块，其用于根据报文协议配置查询类报文模板和更新类报文模板；

所述报文组装模块，其用于根据报文内容所属的类型，选择相应类型的报文模板，将报文内容按照选择的报文模板进行组装，得到通用自定义接口报文。

在上述技术方案的基础上，本发明还可以做如下改进

进一步，所述查询类报文模板和更新类报文模板为包括报文头xmlHeader和报文体xmlBody的XML报文模板，所述报文头xmlHeader定义鉴权信息，所述报文体xmlBody定义节点信息和节点属性信息。

附图说明

图1为本发明所述一种通用自定义接口报文实现方法流程图；

图2为本发明所述一种通用自定义接口报文实现系统框图；

图3为本发明实施例中所述查询类报文模板结构示意图；

图4为本发明实施例中所述更新类报文模板结构示意图。

附图中，各标号所代表的部件列表如下：

1、协议商定模块，2、模板配置模块，3、报文组装模块。

具体实施方式

以下结合附图对本发明的原理和特征进行描述，所举实例只用于解释本发明，并非用于限定本发明的范围。

Xml是一种可扩展的标记语言，有着良好的自定义特性和自我描述特性，本发明对传统报文进行了改进，设计了两种通用性的报文模板(查询类报文模板和更新类报文模板)，节点+属性的组装方式。

如图1所示，一种通用自定义接口报文实现方法，包括如下步骤：

步骤1，协定报文协议，确定报文内容；

步骤2，根据报文协议配置查询类报文模板和更新类报文模板；

步骤3，根据报文内容所属的类型，选择相应类型的报文模板，将报文内容按照选择的报文模板进行组装，得到通用自定义接口报文。

其中，步骤2中所述查询类报文模板和更新类报文模板为包括报文头xmlHeader和报文体xmlBody的XML报文模板，所述报文头xmlHeader定义鉴权信息，所述报文体xmlBody定义根节点信息、业务节点信息和节点属性信息。所述报文头xmlHeader定义的鉴权信息包括服务端应用编码、客户端应用编码、调用方式及调用方身份标识等等。业务调用时通过该部分信息进行应用匹配和身份识别等操作。报文头xmlHeader，主要定义一些鉴权信息，而且相对比较固定一般不会有太大变化，所以采用传统的预定义方式，指定元素节点即业务节点，节点添加required属性标识是否为必填项；例如：<server_app_code required＝"true">100001</server_app_code>；为了便于业务扩展，在节点头部分增加了扩展参数节点；<extends_paramsname＝"xxx"required＝"true">xxx</extends_params>；

所述报文体xmlBody定义的根节点信息用于区分所述报文模板的类型，所述业务节点信息用于定义业务节点的内容，所述节点属性信息用于定义业务节点的属性。所述节点属性信息包括属性名称、数据类型、是否必填等。

本发明将报文节点进行抽象化定义，每个报文节点增加相应的属性信息，来标识属性名称、属性值或其它约束条件。例如：<output_field name＝"column"required＝"true"/>。上述技术方案还包括当接口参数有变更时，根据变更的内容直接修改报文的业务节点信息和/或节点属性信息。

下面详细介绍几种报文的报文体定义。

图3为本发明实施例中所述查询类报文模板结构示意图。表1为本发明实施例中所述查询类报文结构表。

表1

1.所述查询类请求报文在报文体body部分定义四类节点，分别是：

a、输出属性节点output_field，是0或多个；

<output_fieldname＝"column"required＝"true"/>

b、查询条件节点query_condition，是0或多个，该节点存在时必须包含两个子节点，分别为操作符operator和属性值value；

<query_conditionname＝"num_header"required＝"true">

<operator>1</operator>1表示等于，不填时默认为1

<value>531</value>

</query_condition>

c、排序条件节点sort_condition，是0或多个；

<sort_conditionname＝"column">desc</sort_condition>

d、分页节点page_condition，不可省略，包含以下三个子节点；

<page_size></page_size>每页数据量，默认值100

<current_page></current_page>当前页码，默认值1

<total_record></total_record>每次需要返回的数据总量，默认值1000。

2.所述查询响应报文定义以下节点：

a、响应编码resp_code，必填；实际项目中可能会定义统一的响应编码，如9999代表成功等等<resp_code>9999</resp_code>；

b、响应消息描述resp_desc，必填；

<resp_desc>查询成功</resp_desc>；

c、每页的数据量；

<page_size>100<page_size>；

d、当前页码；

<current_page>1<current_page>；

e、返回的数据总量；

<total_record>300<total_record>；

f、总页数；

<total_page>3</total_page>；

g、输出的属性集合，根据output_field节点自动拼装；

<output_collection>；

<column1>zhangsan</column1>；

......；

</output_collection>。

图4为本发明实施例中所述更新类报文模板结构示意图。

表2为本发明实施例中所述更新类报文结构表。

表2

3.所述更新类报文体部分考虑到可能的批量操作，将所述更新类请求报文的报文体xmlBody定义为二级节点update_item，为1个或多个，所述二级节点update_item定义五个节点，分别为：

a、变更目标target_field，目标属性，是0或多个，如果是数据同步更新或插入操作时使用该节点；

<target_fieldname＝"user_name"required＝"true">lisi</target_field>；

b、查询条件节点query_condition，是0或多个，该节点存在时必须包含两个子节点，分别为操作符operator和属性值value；

<query_conditionname＝"user_name"required＝"true">

<operator>1</operator>1表示等于，不填时默认为1

<value>zhangsan</value>

</query_condition>；

c、操作类型operate_type，非空，定义操作类型是修改、删除或其它业务动作；

<operate_type></operate_type>；

d、是否指定操作目标intended_target，非空，指定操作目标时target_field节点必须存在，指定为1不指定则为0；

<intended_targetrequired＝"true">1</intended_target>；

e、操作原因或备注operate_note,可空，填写操作原因或备注信息；

<operate_note></operate_note>。

考虑到可能会有的一些特殊情况,所述更新类报文的报文体xmlBody还包括一个扩展节点，所述扩展节点与二级节点update_item并列,便于业务扩展。

所述通用自定义的接口报文的解析运用org.w3c.dom的相关API进行解析，采用面向对象编程的方式，进行报文解析后的信息封装，简单、直观、易懂、易维护。

如图2所示，一种通用自定义接口报文实现系统，包括协议商定模块1、模板配置模块2和报文组装模块3；所述协议商定模块1，其用于协定报文协议，确定报文内容；所述模板配置模块2，其用于根据报文协议配置查询类报文模板和更新类报文模板；所述报文组装模块3，其用于根据报文内容所属的类型，选择相应类型的报文模板，将报文内容按照选择的报文模板进行组装，得到通用自定义接口报文。

本发明采用契约式的方式约定每个节点的内容(指节点元素，取值，以及约束条件(是否必填、数据类型等))；凡是报文约定的内容均使用属性节点attr和元素节点element表示，凡是需要动态赋值的内容，均使用文本节点text通过动态配置实现。即调用方只需要关注文本节点的内容，而对于属性节点和元素节点不可以随意修改。

本发明具有以下优点：1.本发明将报文节点抽象化，属性配置化，即将传统报文的节点转化为属性进行配置化管理；2.所述报文具有良好的通用性和可扩展性，只需要修改节点信息或节点属性信息即可实现报文内容的变更，而无需修改程序；3.解析程序处理逻辑简单易于维护和二次开发；4.客户端无需组装特殊对象，只需要传入一个报文字符串即可；5.实现接口的统一化标准化管理，使相关工作可量化，工程师可以更精准的进行工作量评估。

以上所述仅为本发明的较佳实施例，并不用以限制本发明，凡在本发明的精神和原则之内，所作的任何修改、等同替换、改进等，均应包含在本发明的保护范围之内。

Claims (7)

1.一种通用自定义接口报文实现方法，其特征在于，包括如下步骤：

步骤1，协定报文协议，确定报文内容；

步骤2，根据报文协议配置查询类报文模板和更新类报文模板；

步骤3，根据报文内容所属的类型，选择相应类型的报文模板，将报文内容按照选择的报文模板进行组装，得到通用自定义接口报文；

步骤2中所述查询类报文模板和更新类报文模板为包括报文头xmlHeader和报文体xmlBody的XML报文模板，所述报文头xmlHeader定义鉴权信息，所述报文体xmlBody定义根节点信息、业务节点信息和节点属性信息；

所述报文体xmlBody定义的根节点信息用于区分所述报文模板的类型，所述业务节点信息用于定义业务节点的内容，所述节点属性信息用于定义业务节点的属性。

2.根据权利要求1所述一种通用自定义接口报文实现方法，其特征在于，所述报文头xmlHeader定义的鉴权信息包括服务端应用编码、客户端应用编码、调用方式及调用方身份标识。

3.根据权利要求1所述一种通用自定义接口报文实现方法，其特征在于，还包括当接口参数有变更时，根据变更的内容直接修改报文的业务节点信息和/或节点属性信息。

4.根据权利要求1所述一种通用自定义接口报文实现方法，其特征在于，所述查询类报文模板包括查询类请求报文和查询类响应报文，所述查询类请求报文的报文体xmlBody定义如下：

a、输出属性节点output_field，是0或多个；

b、查询条件节点query_condition，是0或多个，该节点存在时必须包含两个子节点，分别为操作符operator和属性值value；

c、排序条件节点sort_condition，是0或多个；

d、分页节点page_condition，必须，该节点下包含三个子节点，分别是page_size、current_page和total_record；

所述查询类响应报文的报文体xmlBody定义如下：

a、响应编码resp_code，必填；

b、响应消息描述resp_desc，必填；

c、每页的数据量；

d、当前页码；

e、返回的数据总量；

f、总页数；

g、输出的属性集合，根据output_field节点自动拼装。

5.根据权利要求1所述一种通用自定义接口报文实现方法，其特征在于，所述更新类报文模板包括更新类请求报文和更新类响应报文，所述更新类请求报文的报文体xmlBody定义为二级节点update_item，为1个或多个，所述二级节点update_item定义五个节点，分别为：

a、变更目标target_field，目标属性，是0或多个，如果是数据同步更新或插入操作时使用该节点；

b、查询条件节点query_condition，是0或多个，该节点存在时必须包含两个子节点，分别为操作符operator和属性值value；

c、操作类型operate_type，非空，定义操作类型是修改、删除或其它业务动作；

d、操作原因或备注operate_note,可空，填写操作原因或备注信息；

e、是否指定操作目标intended_target，非空，如果指定操作目标则target_field节点不能为空；1为是，0为否；

所述更新类响应报文的报文体xmlBody定义为：

a、响应编码resp_code，必填；

b、响应消息描述resp_desc，必填。

6.根据权利要求5所述一种通用自定义接口报文实现方法，其特征在于，所述更新类请求报文的报文体xmlBody还包括一个扩展节点，所述扩展节点与二级节点update_item并列。

7.一种通用自定义接口报文实现系统，其特征在于，包括协议商定模块、模板配置模块和报文组装模块；

所述协议商定模块，其用于协定报文协议，确定报文内容；

所述模板配置模块，其用于根据报文协议配置查询类报文模板和更新类报文模板；

所述报文组装模块，其用于根据报文内容所属的类型，选择相应类型的报文模板，将报文内容按照选择的报文模块板进行组装，得到通用自定义接口报文；

所述查询类报文模板和更新类报文模板为包括报文头xmlHeader和报文体xmlBody的XML报文模板，所述报文头xmlHeader定义鉴权信息，所述报文体xmlBody定义根节点信息、业务节点信息和节点属性信息；

所述报文体xmlBody定义的根节点信息用于区分所述报文模板的类型，所述业务节点信息用于定义业务节点的内容，所述节点属性信息用于定义业务节点的属性。