CN102833357A

CN102833357A - 一种与第三方通信的接口平台

Info

Publication number: CN102833357A
Application number: CN2011101638675A
Authority: CN
Inventors: 肖湘
Original assignee: SHANGHAI CHENLAN DATA TECHNOLOGY CO LTD
Current assignee: SHANGHAI CHENLAN DATA TECHNOLOGY CO LTD
Priority date: 2011-06-17
Filing date: 2011-06-17
Publication date: 2012-12-19

Abstract

本发明实现了一种与第三方通信的接口平台，它应用于快速构建不同系统间的数据交互接口。通过预先实现并封装接口的部分功能，以预定义参数的方式实现不同的接口的整合，使接口开发可以更着重于业务功能的实现，而无需关心与第三方系统通信时的传输细节，从而提高了接口的开发效率。以异步处理的方式隔离第三方系统与内部系统方法，以队列处理的方式，实现高效稳定的接口，同时增强了系统稳定性。

Description

一种与第三方通信的接口平台

技术领域

本发明属于通信领域，涉及一种与第三方通信的接口平台。

背景技术

随着计算机技术的发展，信息化管理被越来越多的应用到各行业各领域。信息系统之间的数据交互不可避免，因此实现数据共享，是一个完备系统不可或缺的重要环节。

一个信息系统，自身的业务数据一般都具有复杂的逻辑关系。从数据准确性及安全性方面考虑，通过直接公开数据库的方式实现数据共享，存在不小的安全隐患及业务逻辑上的功能缺陷。通过调用公开的系统接口传递数据, 可以根据业务要求实现复杂的逻辑，对不同的数据做出针对性处理，数据准确性得以保障。通过接口方法将第三方系统与本系统数据库之间隔离，降低了系统间耦合。因此，通过接口传递数据是实现系统间数据共享的较好方式。

系统间接口调用，能满足复杂的业务逻辑要求，但同时在实现上存在不少需要考虑的问题。不同的第三方系统对接口通讯协议、数据压缩及传输编码方式的要求各不相同。为满足不同业务需求，其对应的接口方法需要承载不同的复杂数据。出于以上两点，接口的应用一般在系统间，根据业务要求实现点对点的连接，即一个接口仅实现一个业务功能点。为了保证接口的稳定，相关保障措施不可缺少。例如：考虑到传入数据源来自第三方，因此对于传入数据的格式校验必不可少；为便于问题排查，记录接口调用的详尽日志必不可少；考虑到网络传输等环境因素，如何保证业务的流畅，接口应具备基本的出错处理、出错通知功能。

以上可见，一个稳定的系统接口，除了基本的业务需求，还需要其他的功能来保障。而往往由于系统开发周期或其他条件的限制，接口开发更注重于业务，以严格的第三方调用规范来保证接口的正常运行，以事后人工处理来解决所有出错情况。随着业务发展，客户系统增多，如此点对点的接口数量呈复合增长趋势。接口管理与出错处理愈加困难，接口的稳定对整个系统的影响也越来越大。实现接口稳定与其对应的高开发成本，形成一种博弈状态。

发明内容

本发明的目的在于提供与第三方通信的接口平台，通过该平台实现系统间接口的快速搭建，增加系统间接口的可用性、重用性，同时保证接口的稳定高效。

为了实现上述目的，本发明采用如下技术方案：一种与第三方通信的接口平台，设置在第三方和内部系统之间，其特征在于，所述接口平台包含有:

Ⅰ、调度接口模块，该调度接口模块包含以下参数：ⅰ、来源标记，指明该请求来自于哪个授权的第三方；ⅱ、调用标记，该标记为该次调用的唯一标识；ⅲ、业务接口，指定要调用的业务接口函数名；ⅳ、数据参数，与业务接口函数所绑定的数据；ⅴ、调用结果，该参数是一个输出参数，如果该调度成功，则该参数是该次调用的跟踪ID，如果该调度失败，则该参数的值为错误信息；

Ⅱ、基础数据验证模块，该模块根据来源标记及接口平台的预定义参数，定位对应第三方相关调度配置，对调度请求进行基本验证，验证项包含以下几部分ⅰ、来源标记是否在授权范围内；ⅱ、业务接口是否为公开的可调用的接口方法；ⅲ、数据参数是否使用约定的压缩、编码方式处理；ⅳ、数据参数是否使用约定的承载格式；ⅴ、数据参数的具体内容是否符合对应的业务接口要求；

Ⅲ、数据转换模块，根据与第三方约定的数据承载格式，转换数据参数处理为内部系统方法所能理解的格式；

Ⅳ、调度数据存储模块，将验证通过的调度数据（包括调度的来源标记、对应的接口方法信息、经过转换后的数据参数），存储至接口方法函数指定的处理队列，处理队列可以根据配置选择对应的存储方式，可采用数据库方式存储或本地文件存储方式；

Ⅴ、接口平台数据库，与调度数据存储模块数据连接，用于存储所属处理队列；

Ⅵ、接口平台运行日志模块，所述调度接口模块、基础数据验证模块、数据转换模块均与接口平台运行日志模块数据连接；

所述的调度接口模块、基础数据验证模块、数据转换模块、调度数据存储模块依次串联。

本发明的另一目的在于提供一种与第三方通信的接口平台的处理流程，实现系统间接口的快速搭建，增加系统间接口的可用性、重用性，同时保证接口的稳定高效。

为了实现上述目的，本发明采用如下技术方案：一种与第三方通信的接口平台的处理流程，其特征在于该流程包括以下步骤：A、对请求进行基本的验证，对于验证通过的调度请求，依据请求的数据参数来进行转换，将其转化为内部系统方法所能理解的格式，然后将该请求放入处理队列，存储在接口平台数据库内；B、从接口平台数据库抽取调用请求；C、判断是否外发调度项，如否则调用内部系统指定方法，如是则实现对第三方接口的调用，即转换格式并向第三方发送调度请求；D、标记调度项执行情况，将调度信息回写至接口平台数据库，并调用第三方公开的回执方法，将调度执行情况回传；E、判断调度是否成功，如失败则进行队列出错处理，并将错误信息发送至接口平台运行日志；如成功则判断是否需要外发数据，如是则生成外发调度项，并将调度信息回写至接口平台数据库，如否则直接结束。

本发明实现了一种与第三方通信的接口平台，它应用于快速构建不同系统间的数据交互接口。以异步处理的方式隔离第三方系统与内部系统方法，以队列处理的方式，实现高效稳定的接口，同时增强了系统稳定性。本发明通过该平台实现系统间接口的快速搭建，增加系统间接口的可用性、重用性，同时保证接口的稳定高效。本发明还可通过预先实现并封装接口的部分功能，以预定义参数的方式实现不同的接口的整合，使接口开发可以更着重于业务功能的实现，而无需关心与第三方系统通信时的传输细节，包括通信方式、数据格式转换、错误处理等，减少开发时间与缺陷率，从而提高了接口的开发效率。

附图说明

图1为接口平台、第三方系统、内部系统之间基本的调用关系。

图2为接口平台内部接收调度请求的处理流程。

图3为本发明一实施例的接口平台队列处理流程。

具体实施方式

下面对本发明进行进一步描述。

图1显示了接口平台、第三方系统、内部系统之间基本的调用关系。第三方系统与内部系统隔离，第三方请求，通过接口平台转发至内部系统；内部系统的外发请求，同样通过接口平台转发。

所述接口平台包含有：

Ⅰ、调度接口模块，该调度接口模块包含的参数由以下几部分组成ⅰ、来源标记，指明该请求来自于哪个授权的第三方；ⅱ、调用标记，该标记作为该次调用的唯一标识，不同的调用，标识应当不同，如果出现同一个调用请求需要多次调用，标识应当相同；ⅲ、业务接口，指定要调用的业务接口函数名，该名称由双方业务人员预先约定；ⅳ、数据参数，与业务接口函数所绑定的数据，该参数是业务数据，经过双方约定的压缩算法压缩后，以约定编码进行处理后的字符串；ⅴ、调用结果，该参数是一个输出参数，如果该调度成功，则该参数是该次调用的跟踪ID，第三方可用其查询本次调度状态，如果该调度失败，则该参数的值为错误信息；

Ⅱ、基础数据验证模块，该模块根据来源标记及接口平台的预定义参数，定位对应第三方相关调度配置，对调度请求进行基本验证，验证项包含以下几部分ⅰ、来源标记是否在授权范围内；ⅱ、业务接口是否为公开的可调用的接口方法；ⅲ、数据参数是否使用约定的压缩、编码方式处理；ⅳ、数据参数是否使用约定的承载格式；ⅴ、数据内容是否符合对应的业务接口要求；

Ⅳ、调度数据存储模块，将验证通过的调度数据，存储至接口方法函数指定的处理队列，处理队列可以根据配置选择对应的存储方式可采用数据库方式存储或本地文件存储方式；

图2显示了接口平台内部接收调度请求的处理流程。在本实施例，对外接口基于SOAP协议，并以WebService的形式对外公开；调度处理队列采用数据库方式存储，存储在接口平台数据库内。

该接口平台的实现方法，包括以下步骤：A、对请求进行基本的验证，对于验证通过的调度请求，依据请求的数据参数来进行转换，将其转化为内部系统方法所能理解的格式，然后将该请求放入处理队列，存储在接口平台数据库内；B、从接口平台数据库抽取调用请求；C、判断是否外发调度项，如否则调用内部系统指定方法，如是则实现对第三方接口的调用，即转换格式并向第三方发送调度请求；D、标记调度项执行情况，并将调度信息回写至接口平台数据库；E、判断调度是否成功，如失败则进行队列出错处理；如成功则判断是否需要外发数据，如是则生成外发调度项，并将调度信息回写至接口平台数据库，如否则直接结束。在该实现方法中，还将接口平台本身的执行情况及调度项的执行情况，包括状态、执行结果、错误信息等；以及从调用第三方对应的回执接口得到的回执（包括主动获取和被动接收两种方式）写入接口平台运行日志。

在步骤A中，验证包括以下几部分：ⅰ、来源标记是否在授权范围内；ⅱ、业务接口是否为公开的可调用的接口方法；ⅲ、数据参数是否使用约定的压缩、编码方式处理；ⅳ、数据参数是否使用约定的承载格式；ⅴ、数据参数的具体内容是否符合对应的业务接口要求。

l 数据参数压缩编码处理方式可以有多种选择，例如：

数据参数传输是否需要采用base64编码、数据是否需要压缩、采用何种压缩方式（例如Zlib压缩、GZip压缩、Zip压缩）、字符编码采用何种方式（例如Utf-8、GBK）

l 数据承载格式，一般采用标准的Xml格式，例如：

</detail>

</Item>

</detail>

</Item>

</Data>

l 也可以由双方约定，采用双方认同的自定义格式，例如：

<Entry> 单条记录标示

<ID>...</ID> 具体业务数据字段

</Entry>

<Entry>

</Entry>

</Interface>

<Bill> 主从单据记录标示

<BillHeader> 主单标示

</BillHeader>

<BillBody> 从单标示

<Entry>

</Entry>

<Entry>

</Entry>

</BillBody>

</Bill>

</Interface>

l 数据参数具体内容的检查，则是针对接口的具体业务而定，是对数据字段的具体要求

例如：参数中是否存在重复的数据字段，是否包含方法必须的数据字段、是否存在多余的数据字段、数据字段是否需要非空检查、主从单据的清单是否允许为空等。

本发明的内部系统方法执行，由处理队列控制。处理队列依据预先设置的规则，定期按顺序抽取队列中的请求，将其发送给内部系统方法，并获取执行结果。队列规则包括执行时间段、时间频率等。如果处理发生了异常，则依据队列设置，自动尝试进行重新执行，或挂起队列并通知人工处理。如果调度正常，则将内部系统方法所返回的数据传递给第三方。

接口平台支持多队列处理，以实现不同接口方法的并行处理，灵活应对不同业务要求，提高处理效率。

向第三方传递数据的外发请求，同样通过对请求来源标记的判断，将对应数据转换处理为第三方认同的格式，并以对应的传输协议发送至第三方公开的接口

除了以上所描述的，被动接受第三方请求的功能，接口平台还具有主动调用的机制。通过队列设置，模拟第三方调度，定期生成调度请求，实现内部系统主动发送数据的功能。

接口平台支持回执功能。回执的作用是用于在第三方请求一次调用后，可在任意时刻得知该调用的执行情况。回执的传递形式分为两种：主动获取以及被动接收。主动获取为第三方主动查询某次调用的情况；被动接收为接口平台，在调度结束后主动将执行结果发往第三方。

图3显示了接口平台队列处理流程，单个队列，单次处理的流程。

步骤301为从队列中抽取请求，本实施例，调度处理队列采用数据库方式存储，队列从接口平台对应的数据库抽取调度请求。

接口平台根据调度请求类型不同，作对应处理。

步骤302为调用内部系统方法。接口平台根据调度请求的接口方法函数名，及预定义参数，定位内部系统的目标方法，将数据发送给指定的内部系统方法，由内部系统方法完成对应的业务逻辑处理

当调度请求为外发请求时，通过步骤303、304实现对第三方接口的调用

步骤303为数据格式转换，由预定义参数，获取与第三方约定的数据承载格式，对待发送数据作对应转换处理

步骤304为针对不同第三方接口的调用模块，将步骤303得到的数据，以与第三方约定的方式发送至指定接口

步骤305为接口平台根据调度执行结果，标记调度项状态及相关信息，例如：错误信息，执行时间等。标记过程分为两种：

1. 更新处理队列，本实施例，调度处理队列采用数据库方式存储，因此将调度项信息回写至接口平台对应的数据库；

2. 调用第三方对应回执接口，实现数据的执行情况时时反馈。

步骤306、307为调用执行失败的处理

步骤306为队列出错处理模块。如果调度执行发生异常，则依据预定义参数选择是自动处理还是人工处理。自动处理表明接口平台会自动尝试重新执行若干次，如果皆失败则放弃该调度。而人工处理则是在系统自动尝试重新执行若干次后，如果皆失败则处理流程挂起，待人工来处理问题，解决后通知该问题重试，或者抛弃。

步骤307为错误主动发送模块，根据预定义参数判断是否需要发送错误信息，例如：报错立即发送错误信息、调度请求抛弃发送错误信息、队列挂起发送错误信息。如需要发送错误信息，则根据具体的错误类型，决定信息发送方式、信息接收人等

步骤308为外发调度请求的生成，由预定义参数决定，当前接口方法函数是否存在外发调度要求，由系统内部方法执行结果决定，当前调度请求是否存在外发调度数据。如果存在外法调度要求，并且存在外发调度数据，则生成对应的外发调度请求，存储至外发方法指定的处理队列。本实施例，调度处理队列采用数据库方式存储，因此将调度项信息回写至接口平台对应的数据库。

根据本发明的实施例，本发明的接口平台预先实现并封装接口的部分功能，包括：

i. 第三方通讯协议、传输数据的压缩编码处理；

ii. 数据格式转换、数据完整性校验；

iii. 调度项异步处理机制、定时主动调度功能、调度项处理结果回执功能；

iv. 调度项执行日志记录、异常处理机制。

本发明的接口平台使用单一的方法接口，根据方法传入参数，通过预定义参数在运行期间决定调度请求的处理规范，包括以下预定义参数：

ⅰ第三方接口服务（选择，接口平台预实现）、通讯地址；

ⅱ第三方传输数据压缩、编码方式；

ⅲ接口平台处理队列数据存储方式；

ⅳ处理队列执行时间段、时间频率、错误处理机制，其中

对于接口平台运行异常包括：

可恢复异常：使用本地文件日志记录；

灾难性故障：使用windows日志记录；

对于调度项执行异常（包括数据编码、格式错误，以及业务逻辑上的错误）；

记录调度项执行日志的同时，依据请求所在队列设置，自动尝试进行重新执行、抛弃、或挂起队列并通知人工处理；

ⅴ接口方法函数与内部系统方法对应关系包括：

接口方法函数与内部系统方法，采用多对一的对应关系；

即：一个接口方法必须有一个对应的内部系统方法、不同的接口方法可以对应同一个内部系统方法；

ⅵ接口方法数据参数格式；

ⅶ接口方法所在处理队列、外发请求所在处理队列；

ⅷ接口方法请求重试次数等；

ⅸ接口平台错误主动通知功能。

本发明采用异步处理调度请求，调度项接收与调度项执行隔离，调度项接收于第三方调用为同步完成，与调度项执行时间点没有关系。本发明以队列处理的方式实现调度请求的执行，调度项执行时间与调度方法本身无关，调度项按对列分组，以所在对列的时间规则执行，按照先到先执行的原则处理；支持多对列并行处理，对列与对列之间隔离，互不干涉。

以上所述，为本发明较常应用的实施方式，并不用于限定本发明的保护范围。本领域技术人员根据本发明的技术方案得出的其他实施方式，同样属于本发明的技术创新范围。

Claims

1.一种与第三方通信的接口平台，设置在第三方和内部系统之间，其特征在于，所述接口平台包含有:

2.该接口平台的实现方法，包括以下步骤：A、对请求进行基本的验证，对于验证通过的调度请求，依据请求的数据参数来进行转换，将其转化为内部系统方法所能理解的格式，然后将该请求放入处理队列，存储在接口平台数据库内；B、从接口平台数据库抽取调用请求；C、判断是否外发调度项，如否则调用内部系统指定方法，如是则实现对第三方接口的调用，即转换格式并向第三方发送调度请求；D、标记调度项执行情况，并将调度信息回写至接口平台数据库；E、判断调度是否成功，如失败则进行队列出错处理；如成功则判断是否需要外发数据，如是则生成外发调度项，并将调度信息回写至接口平台数据库，如否则直接结束。

3.如权利要求2所述的实现方法，其特征在于在步骤A中，验证包括以下几部分：ⅰ、来源标记是否在授权范围内；ⅱ、业务接口是否为公开的可调用的接口方法；ⅲ、数据参数是否使用约定的压缩、编码方式处理；ⅳ、数据参数是否使用约定的承载格式；ⅴ、数据参数的具体内容是否符合对应的业务接口要求。

4.如权利要求2或3所述的实现方法，其特征在于在该实现方法中，还将接口平台本身的执行情况及调度项的执行情况，包括状态、执行结果、错误信息等；以及从调用第三方对应的回执接口得到的回执写入接口平台运行日志。