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

技术编号:12298168 阅读:108 留言:0更新日期:2015-11-11 09:17
本发明专利技术涉及一种通用自定义接口报文实现方法,包括如下步骤:步骤1,协定报文协议,确定报文内容;步骤2,根据报文协议配置查询类报文模板和更新类报文模板;步骤3,根据报文内容所属的类型,选择相应类型的报文模板,将报文内容按照选择的报文模板进行组装,得到通用自定义接口报文。本发明专利技术所述报文通用性强、复用度高,轻量级,不依赖特殊的API,大大降低接口制定的复杂度和开发工作量,便于统一化管理,便于工作量精准评估。

【技术实现步骤摘要】

本专利技术涉及通信
,尤其涉及一种通用自定义接口报文实现方法及系统
技术介绍
对于综合资源管理系统,需要提供大量的资源查询接口给外围系统,如营业系统 选号接口、资源能力查询接口等;但是经过分析发现,大部分接口基本可划分为两类:查询 类和更新类(包括删除,可看作是一种特殊的更新操作);而通常在定义接口报文的时候都 是以业务动作为基本单元,一个业务动作对应一套接口报文,并且每一个报文节点都是双 方协定接口交互方式后预定义好的,一旦有变化就需要修改程序,非常麻烦。 报文片段: 从上述的报文片段可以看出,传统的报文组装方式中,每一个节点都是预定义好 的,每一个节点即对应一个实际的业务元素,如果业务需求发生变化新增或修改某个节点, 则需要相应的修改服务端解析程序,可移植性和扩展性很差。传统的组装方式的,服务端的 解析是和报文强关联的,报文变更服务端的解析也要跟着修改。 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」tem,为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所示,一种通用自定义接口报文实现方法,包括如下步骤: 步骤I,协定报文协议,确定报文内容; 步骤2,根据报文协议配置查询类报文模板和更新类报文模板; 步骤3,根据报文内容所属的类型,选择相应类型的报文模板,将报文内容按照选 择的报文模板进行组装,得到通用自定义接口报文。 其中,步骤2中所述查询类报文模板和更新类报文模板为包括报文头xmlHeader 和报文体xmlBody的XML报文模板,所述报文头xmlHeader定义鉴权信息,所述报文体 xmlBody定义根节点信息、业务节点信息和节点属性信息。所述报文头xmlHeader定义的 鉴权信息包括服务端应用编码、客户端应用编码、调用方式及调用方身份标识等等。业务 调用时通过该部分信息进行应用匹配和身份识别等操作。报文头xmlHeader,主要定义一 些鉴权信息,而且相对比较固定一般不会有太大变化,所以采用传统的预定本文档来自技高网...
一种通用自定义接口报文实现方法及系统

【技术保护点】
一种通用自定义接口报文实现方法,其特征在于,包括如下步骤:步骤1,协定报文协议,确定报文内容;步骤2,根据报文协议配置查询类报文模板和更新类报文模板;步骤3,根据报文内容所属的类型,选择相应类型的报文模板,将报文内容按照选择的报文模板进行组装,得到通用自定义接口报文。

【技术特征摘要】

【专利技术属性】
技术研发人员:高建星
申请(专利权)人:北京思特奇信息技术股份有限公司
类型:发明
国别省市:北京;11

网友询问留言 已有0条评论
  • 还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。

1