CN109976924A - 接口调用方法及装置 - Google Patents

Abstract

本发明提供了接口调用方法及装置，该方法获取客户端发起的接口调用请求，并将该接口调用请求发送至相应的接口服务提供系统；如果接收到接口服务提供系统返回的响应数据，确认请求成功，向发起该接口调用请求的客户端返回该响应数据；并存储该响应数据。如果接收到请求失败消息，则从已存储的响应数据中查找与所述接口调用请求所携带的接口请求参数相匹配的数据作为响应数据返回给客户端。当接口请求失败时不是反复地重新调用接口而是从已存储的响应数据中查询与本地接口调用请求相匹配的响应数据，因此，避免了接口服务提供系统负载压力大的问题。而且，该接口调用方法每次接口调用都先尝试获取最新数据，能够满足用户对数据的实时性要求。

Description

接口调用方法及装置

技术领域

本发明属于计算机技术领域，尤其涉及接口调用方法及装置。

背景技术

不同系统之间交互需要调用对方系统提供的接口，例如，很多业务通过调用第三方接口，请求第三方接口实时返回请求数据。但是由于网络不稳定、业务系统存在问题，或者，调用超时等原因会导致请求第三方接口失败，即接口调用失败。

传统技术中，若接口调用失败，通常通过多次重新调用该接口的机制来处理。消除导致接口调用失败的因素需要的时间不确定(例如，网络不稳定的持续时间不确定)，这种重新调用接口的机制不能获取请求数据，相反会增大接口提供系统的负载压力，最终导致接口提供系统长时间无法响应接口调用请求。

发明内容

有鉴于此，本发明的目的在于提供了接口调用方法及装置，以解决接口调用失败时，无法及时获得请求数据的技术问题。其中，具体技术方案如下：

第一方面，本发明提供了一种接口调用方法，包括：

获取接口调用请求并发送至与该接口调用请求相匹配的接口服务提供系统，该接口调用请求携带接口请求参数；

当接收到所述接口服务提供系统返回的响应数据后，向发起所述接口调用请求的应用程序返回该响应数据，以及存储该响应数据；

当接收到请求失败消息后，从已存储的响应数据中查找与所述接口请求参数相匹配的数据作为所述接口调用请求的响应数据。

可选地，存储该响应数据的过程包括：

基于预设定义规则依据所述接口请求参数生成该响应数据对应的唯一标识，所述预设定义规则用于规定响应数据被存储时所对应的唯一标识的生成规则；

将该响应数据及对应的唯一标识对应存储。

可选地，所述当接收到所述接口服务提供系统返回的请求失败消息后，从已存储的响应数据中查找与所述接口请求参数相匹配的数据作为所述接口调用请求的响应数据，包括：

当接收到所述接口服务提供系统返回的请求失败消息后，基于所述预设定义规则依据所述接口请求参数生成查询标识；

从已存储的响应数据中查找与所述查询标识相匹配的数据，作为所述接口调用请求的响应数据。

可选地，所述当接收到所述接口服务提供系统返回的响应数据后，向发起所述接口调用请求的应用程序返回该响应数据，以及存储该响应数据，包括：

当接收到所述接口服务提供系统返回的响应数据后，实现接口调用的主线程将该响应数据发送至发起所述接口调用请求的应用程序；

新建更新线程并由该更新线程存储该响应数据。

可选地，所述方法还包括：

按照指定时间从已存储的响应数据中删除过期数据，该过期数据是存储时间超过预设时长的响应数据。

可选地，所述方法还包括：

当已存储的响应数据中不存在与所述接口请求参数相匹配的数据时，向发起所述接口调用请求的应用程序返回请求失败的消息。

第二方面，本发明还提供了一种接口调用装置，包括：

接口调用模块，用于获取接口调用请求并发送至与该接口调用请求相匹配的接口服务提供系统，该接口调用请求携带接口请求参数；

响应数据存储模块，用于当接收到所述接口服务提供系统返回的响应数据后，向发起所述接口调用请求的应用程序返回该响应数据，以及存储该响应数据；

响应数据查找模块，用于当接收到请求失败消息后，从已存储的响应数据中查找与所述接口请求参数相匹配的数据作为所述接口调用请求的响应数据。

可选地，所述响应数据存储模块用于存储该响应数据时，具体用于：

基于预设定义规则依据所述接口请求参数生成该响应数据对应的唯一标识，所述预设定义规则用于规定响应数据被存储时所对应的唯一标识的生成规则；

将该响应数据及对应的唯一标识对应存储。

可选地，所述响应数据查找模块，包括：

查询标识生成子模块，用于当接收到所述接口服务提供系统返回的请求失败消息后，基于所述预设定义规则依据所述接口请求参数生成查询标识；

查询子模块，用于从已存储的响应数据中查找与所述查询标识相匹配的数据，作为所述接口调用请求的响应数据。

可选地，所述装置还包括：

删除模块，用于按照指定时间从已存储的响应数据中删除过期数据，该过期数据是存储时间超过预设时长的响应数据。

本发明提供的接口调用方法，获取客户端发起的接口调用请求，并将该接口调用请求发送至相应的接口服务提供系统；如果接收到所述接口服务提供系统返回的响应数据，确认请求成功，向发起该接口调用请求的客户端返回该响应数据；并存储该响应数据。如果接收到请求失败消息，则从已存储的响应数据中查找与所述接口调用请求所携带的接口请求参数相匹配的数据作为响应数据返回给客户端。与传统的重新调用接口的机制相比，当接口请求失败时，该方法不会反复地重新调用接口，因此，避免了接口服务提供系统负载压力大的问题。而且，该接口调用方法先从接口服务提供系统请求数据，如果请求失败，再从本地已存储的响应数据中查找相匹配的数据，即每次接口调用都先尝试获取最新数据，能够满足用户对数据的实时性要求。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1是本发明实施例提供的一种接口调用方法的流程图；

图2是本发明实施例提供的另一种接口调用方法的流程图；

图3是本发明实施例提供的一种接口调用装置的结构示意图；

图4是本发明实施例提供的一种响应数据查询模块的结构示意图；

图5是本发明实施例提供的另一种接口调用装置的结构示意图。

具体实施方式

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

请参见图1，示出了本发明实施例提供的一种接口调用方法的流程图，该方法应用于服务端，如图1所示，该方法包括以下步骤：

S110，获取接口调用请求，并发送至与该接口调用请求相匹配的接口服务提供系统。

客户端发起某类请求时，可能会触发服务端产生接口调用请求，服务端将该接口调用请求发送至相匹配的接口服务提供系统，请求该接口服务提供系统返回响应数据。

例如，服务系统A需要使用第三方服务系统B提供的某项服务，当服务系统A中的客户端a请求获取系统B所提供服务的数据时，服务系统A中的客户端a会向服务端aa发起数据获取请求，服务端aa接收到该数据获取请求后产生相应的接口调用请求并发送给系统B。

接口调用请求携带接口请求参数，其中，接口请求参数表征该接口调用请求所要请求的数据的参数信息。例如，对于具有支付功能的社交平台中的某个用户想要查看自己账户余额，此种情况下，接口请求参数中至少包括该用户在该社交平台的账号UID和当前请求的时间date。

S120，当接收到接口服务提供系统返回的响应数据后，向发起接口调用请求的客户端返回该响应数据，以及存储该响应数据。

如果接收到接口服务提供系统返回的响应数据，表明请求成功，将接收到的响应数据返回给客户端；同时，将该响应数据存储到本地存储空间内。

S130，当接收到请求失败消息后，从已存储的响应数据中查找与该接口请求参数相匹配的数据作为该接口调用请求的响应数据。

如果接收到接口服务提供系统返回的的请求失败消息，表明本次接口请求失败。此种情况下，从本地存储的响应数据中查找出与该接口请求参数相匹配的响应数据作为本次接口调用的结果返回给客户端。

例如，用户A当前时刻请求查询自己账户余额信息，但该接口服务提供系统返回请求失败消息，查询服务端本地已存储的请求成功的响应数据查找到用户A在一小时前刚查询了自己账户的余额信息且请求成功，则将一小时前请求成功的响应数据作为当前时刻的响应数据返回给客户端。

在本发明一种可能的实现方式中，存储请求成功的响应数据时，会按照预设定义规则为每一条响应数据产生一个唯一标识，将该响应数据及对应的唯一标识对应存储下来。后续查找响应数据时，依据该预设定义规则生成该接口请求参数对应的查询标识，从已存储的响应数据中查找与该查询标识对应的数据，确定为与该接口请求参数相匹配的数据，然后，返回给客户端。即，存储响应数据时生成唯一标识的预设定义规则与接口调用请求失败后生成查询标识的预设定义规则相同。

本发明提供的接口调用方法，与传统的重新调用接口的机制相比，当接口请求失败时，该方法不会反复地重新调用接口，因此，避免了接口服务提供系统负载压力大的问题。而且，该接口调用方法先从接口服务提供系统请求数据，如果请求失败，再从本地已存储的响应数据中查找相匹配的数据，即每次接口调用都先尝试获取最新数据，能够满足用户对数据的实时性要求。

请参见图2，示出了本发明实施例提供的另一种接口调用方法的流程图，该方法应用于服务端，本实施例将着重介绍从已存储的响应数据中查找与当前接口调用请求相匹配的数据。如图2所示，该方法包括以下步骤：

S210，获取接口调用请求，并发送至与该接口调用请求相匹配的接口服务提供系统。

其中，该接口调用请求携带接口请求参数，该接口请求参数表明该接口调用请求所要请求的数据的参数信息。

S220，当接收到所述接口服务提供系统返回的响应数据后，向发起该接口调用请求的应用程序返回该响应数据。

在接收到接口服务提供系统返回的响应数据之后，需要将该响应数据存储下来，以便接口调用失败时直接从存储的请求成功的数据中查找与本次接口调用对应的数据。存储请求成功的响应数据时，以key-value形式存储，该响应数据即value，该响应数据对应的key按照一定的规则生成。如下的S230即生成key的过程。

S230，基于预设定义规则以及接口请求参数，生成该响应数据对应的唯一标识。

该预设定义规则表征生成响应数据对应的唯一标识的规则。该预设定义规则可以写入实现该接口调用方法的程序代码中。

该预设定义规则可以由程序开发人员根据实际业务需求自行设定，例如，预设定义规则可以规定必须包括用户(即，用户的UID)，或者，用户+时间(UID+Date)等。例如，预设定义规则是利用用户UID+时间生成唯一标识，则在接收到响应数据后，自动将发起该接口调用请求的UID+Date作为该响应数据的唯一标识。

根据预设定义规则中规定的内容从接口调用请求中获取生成响应数据的唯一标识所需的指定接口请求参数，按照预设定义规则利用该指定接口请求参数生成该响应数据对应的唯一标识，该唯一标识即该响应数据对应的索引，后续查找时，可以利用该唯一标识查找对应的响应数据。

S240，将响应数据及对应的唯一标识对应存储到本地存储空间内。

将接收到的响应数据及其对应的唯一标识对应存储到本地存储空间内，如本地缓存，将响应数据存储缓存空间中，提高查找效率，减少系统开销。当然，在本发明的其它实施例中，还可以将响应数据及对应的唯一标识存储到其它存储空间内。

为了减少大量响应数据占用有限的存储空间，可以定期删除过期数据。其中，该过期数据是指已存储的响应数据中存储时间超过预设时长的响应数据。预设时长可以根据业务需求自行设定，例如，12小时、24小时等。

在本发明的其它实施例中，当接口请求成功，即接收到接口服务提供系统返回的响应数据后，实现该接口调用方法的主线程将该响应数据返回给发起该接口调用请求的应用程序，例如，客户端；同时，新建一个更新线程(即，任务)，由该更新线程将该响应数据及其唯一标识存储到本地存储空间内，即更新本地存储空间内存储的响应数据。

S250，当接收到请求失败消息后，基于所述预设定义规则依据该接口调用请求携带的接口请求参数生成查询标识。

此处的预设定义规则即S230中的预设定义规则。

S260，查找已存储的响应数据中是否存在与该目标唯一标识相匹配的响应数据；如果存在，则执行S270；如果不存在，则执行S280。

S270，将与该查询标识相匹配的数据作为该接口调用请求的响应数据发送给发起该接口调用请求的应用程序。

S280，向发起该接口调用请求的应用程序返回请求失败的消息。

本实施例提供的接口调用方法，在接收到接口服务提供系统返回的响应数据后，按照预设定义规则生成该响应数据对应的唯一标识，并将该响应数据及唯一标识对应存储下来；当调用该接口失败时，按照预设定义规则生成对应的查询标识，并依据该查询标识从已存储的响应数据中查找之前请求成功的响应数据，如果查找到则返回查找到的响应数据。从而，避免了重新调用接口的机制导致接口服务提供系统负载压力大的问题。而且，该接口调用方法先从接口服务提供系统请求数据，如果请求失败，再从本地已存储的响应数据中查找相匹配的数据，即每次接口调用都先尝试获取最新数据，能够满足用户对数据的实时性要求。

相应于上述的接口调用方法实施例，本发明还提供了接口调用装置实施例，请参见图3，示出了本发明实施例一种接口调用装置的结构示意图，该装置应用于服务端，如图3所示，该装置包括接口调用模块110、响应数据存储模块120和响应数据查找模块130。

接口调用模块110，用于获取接口调用请求并发送至与该接口调用请求相匹配的接口服务提供系统，该接口调用请求携带接口请求参数。

客户端发起某类请求时，可能会触发服务端产生接口调用请求，服务端将该接口调用请求发送至相匹配的接口服务提供系统，请求该接口服务提供系统返回响应数据。

响应数据存储模块120，用于当接收到接口服务提供系统返回的响应数据后，向发起接口调用请求的应用程序返回该响应数据，以及存储该响应数据。

该响应数据存储模块120在存储该响应数据时具体用于：

基于预设定义规则并依据接口请求参数生成该响应数据对应的唯一标识，然后，将该响应数据及对应的唯一标识对应存储。

例如，可以将响应数据和对应的唯一标识存储到本地缓存空间内，以提高查找效率，减少系统开销。当然，在本发明的其它实施例中，还可以将响应数据及对应的唯一标识存储到其它存储空间内。

其中，所述预设定义规则用于规定响应数据被存储时所对应的唯一标识的生成规则。例如，预设定义规则为接口请求参数(如，用户UID)+时间，则在接收到响应数据后，自动将发起该接口调用请求的UID+Date作为该响应数据的唯一标识。该唯一标识即该响应数据对应的索引，后续查找时，可以利用该唯一标识查找对应的响应数据。

响应数据查找模块130，用于当接收到请求失败消息后，从已存储的响应数据中查找与接口请求参数相匹配的数据作为接口调用请求的响应数据。

如果接收到接口服务提供系统返回的的请求失败消息，表明本次接口请求失败。此种情况下，从本地存储的响应数据中查找出与该接口请求参数相匹配的数据作为本次接口调用的结果返回给客户端。

如图4所示，该响应数据查找模块130，包括：查询标识生成子模块131和查询子模块132；

查询标识生成子模块131，用于当接收到接口服务提供系统返回的请求失败消息后，基于预设定义规则依据接口请求参数生成查询标识。

每一个响应数据都有一个唯一标识，通过该唯一标识能够查找本地是否存储有与当前请求失败的接口调用请求对应的响应数据。需要根据接口调用请求中的接口请求参数及预设定义规则生成当前请求失败的接口调用请求对应的查询标识。其中生成查询标识的预设定义规则就是生成响应数据的唯一标识的预设定义规则。

查询子模块132，用于从已存储的响应数据中查找与查询标识相匹配的数据，作为接口调用请求的响应数据。

生成请求失败的接口调用请求对应的查询标识后，从本地存储的响应数据中查找是否存在与查询标识相匹配的响应数据，如果存在，则将查找到的响应数据作为该接口调用请求的响应数据返回给客户端。

本实施例提供的接口调用装置，与传统的重新调用接口的机制相比，当接口请求失败时，该装置不会反复地重新调用接口，因此，避免了接口服务提供系统负载压力大的问题。而且，该接口调用方法先从接口服务提供系统请求数据，如果请求失败，再从本地已存储的响应数据中查找相匹配的数据，即每次接口调用都先尝试获取最新数据，能够满足用户对数据的实时性要求。

请参见图5，示出了本发明实施例提供的另一种接口调用装置的结构示意图，为了减少大量响应数据占用有限的存储空间，如图5所示，该接口调用装置还可以包括删除模块210。

删除模块210，用于按照指定时间从已存储的响应数据中删除过期数据。其中，该过期数据是指已存储的响应数据中存储时间超过预设时长的响应数据。预设时长可以根据业务需求自行设定，例如，12小时、24小时等。

本实施例提供的接口调用装置，将请求成功的响应数据存储到服务端本地，为了减少大量响应数据占用有限存储空间，可以通过删除模块按照指定时间删除过期数据，从而节省更多的存储空间来存储新的响应数据，提高了存储空间的使用效率。对于前述的各方法实施例，为了简单描述，故将其都表述为一系列的动作组合，但是本领域技术人员应该知悉，本发明并不受所描述的动作顺序的限制，因为依据本发明，某些步骤可以采用其他顺序或者同时进行。其次，本领域技术人员也应该知悉，说明书中所描述的实施例均属于优选实施例，所涉及的动作和模块并不一定是本发明所必须的。

需要说明的是，本说明书中的各个实施例均采用递进的方式描述，每个实施例重点说明的都是与其他实施例的不同之处，各个实施例之间相同相似的部分互相参见即可。对于装置类实施例而言，由于其与方法实施例基本相似，所以描述的比较简单，相关之处参见方法实施例的部分说明即可。

本申请各实施例方法中的步骤可以根据实际需要进行顺序调整、合并和删减。

本申请各实施例中的装置及终端中的模块和子模块可以根据实际需要进行合并、划分和删减。

本申请所提供的几个实施例中，应该理解到，所揭露的终端，装置和方法，可以通过其它的方式实现。例如，以上所描述的终端实施例仅仅是示意性的，例如，模块或子模块的划分，仅仅为一种逻辑功能划分，实际实现时可以有另外的划分方式，例如多个子模块或模块可以结合或者可以集成到另一个模块，或一些特征可以忽略，或不执行。另一点，所显示或讨论的相互之间的耦合或直接耦合或通信连接可以是通过一些接口，装置或模块的间接耦合或通信连接，可以是电性，机械或其它的形式。

作为分离部件说明的模块或子模块可以是或者也可以不是物理上分开的，作为模块或子模块的部件可以是或者也可以不是物理模块或子模块，即可以位于一个地方，或者也可以分布到多个网络模块或子模块上。可以根据实际的需要选择其中的部分或者全部模块或子模块来实现本实施例方案的目的。

另外，在本申请各个实施例中的各功能模块或子模块可以集成在一个处理模块中，也可以是各个模块或子模块单独物理存在，也可以两个或两个以上模块或子模块集成在一个模块中。上述集成的模块或子模块既可以采用硬件的形式实现，也可以采用软件功能模块或子模块的形式实现。

最后，还需要说明的是，在本文中，诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括所述要素的过程、方法、物品或者设备中还存在另外的相同要素。

对所公开的实施例的上述说明，使本领域技术人员能够实现或使用本发明。对这些实施例的多种修改对本领域技术人员来说将是显而易见的，本文中所定义的一般原理可以在不脱离本发明的精神或范围的情况下，在其它实施例中实现。因此，本发明将不会被限制于本文所示的这些实施例，而是要符合与本文所公开的原理和新颖特点相一致的最宽的范围。

以上所述仅是本发明的优选实施方式，应当指出，对于本技术领域的普通技术人员来说，在不脱离本发明原理的前提下，还可以做出若干改进和润饰，这些改进和润饰也应视为本发明的保护范围。

Claims (10)

1.一种接口调用方法，其特征在于，包括：

获取接口调用请求并发送至与该接口调用请求相匹配的接口服务提供系统，该接口调用请求携带接口请求参数；

当接收到所述接口服务提供系统返回的响应数据后，向发起所述接口调用请求的应用程序返回该响应数据，以及存储该响应数据；

当接收到请求失败消息后，从已存储的响应数据中查找与所述接口请求参数相匹配的数据作为所述接口调用请求的响应数据。

2.根据权利要求1所述的方法，其特征在于，存储该响应数据的过程包括：

基于预设定义规则依据所述接口请求参数生成该响应数据对应的唯一标识，所述预设定义规则用于规定响应数据被存储时所对应的唯一标识的生成规则；

将该响应数据及对应的唯一标识对应存储。

3.根据权利要求2所述的方法，其特征在于，所述当接收到所述接口服务提供系统返回的请求失败消息后，从已存储的响应数据中查找与所述接口请求参数相匹配的数据作为所述接口调用请求的响应数据，包括：

当接收到所述接口服务提供系统返回的请求失败消息后，基于所述预设定义规则依据所述接口请求参数生成查询标识；

从已存储的响应数据中查找与所述查询标识相匹配的数据，作为所述接口调用请求的响应数据。

4.根据权利要求1所述的方法，其特征在于，所述当接收到所述接口服务提供系统返回的响应数据后，向发起所述接口调用请求的应用程序返回该响应数据，以及存储该响应数据，包括：

当接收到所述接口服务提供系统返回的响应数据后，实现接口调用的主线程将该响应数据发送至发起所述接口调用请求的应用程序；

新建更新线程并由该更新线程存储该响应数据。

5.根据权利要求1-4任一项所述的方法，其特征在于，所述方法还包括：

按照指定时间从已存储的响应数据中删除过期数据，该过期数据是存储时间超过预设时长的响应数据。

6.根据权利要求1-4任一项所述的方法，其特征在于，所述方法还包括：

当已存储的响应数据中不存在与所述接口请求参数相匹配的数据时，向发起所述接口调用请求的应用程序返回请求失败的消息。

7.一种接口调用装置，其特征在于，包括：

接口调用模块，用于获取接口调用请求并发送至与该接口调用请求相匹配的接口服务提供系统，该接口调用请求携带接口请求参数；

响应数据存储模块，用于当接收到所述接口服务提供系统返回的响应数据后，向发起所述接口调用请求的应用程序返回该响应数据，以及存储该响应数据；

响应数据查找模块，用于当接收到请求失败消息后，从已存储的响应数据中查找与所述接口请求参数相匹配的数据作为所述接口调用请求的响应数据。

8.根据权利要求7所述的装置，其特征在于，所述响应数据存储模块用于存储该响应数据时，具体用于：

基于预设定义规则依据所述接口请求参数生成该响应数据对应的唯一标识，所述预设定义规则用于规定响应数据被存储时所对应的唯一标识的生成规则；

将该响应数据及对应的唯一标识对应存储。

9.根据权利要求8所述的装置，其特征在于，所述响应数据查找模块，包括：

查询标识生成子模块，用于当接收到所述接口服务提供系统返回的请求失败消息后，基于所述预设定义规则依据所述接口请求参数生成查询标识；

查询子模块，用于从已存储的响应数据中查找与所述查询标识相匹配的数据，作为所述接口调用请求的响应数据。

10.根据权利要求7-9任一项所述的装置，其特征在于，所述装置还包括：

删除模块，用于按照指定时间从已存储的响应数据中删除过期数据，该过期数据是存储时间超过预设时长的响应数据。