CN111104191B

CN111104191B - 接口对接方法、装置、计算机设备及存储介质

Info

Publication number: CN111104191B
Application number: CN201911301279.6A
Authority: CN
Inventors: 谢滨泽; 申志彬; 谢瑶
Original assignee: Shenzhen Qianhai Huanrong Lianyi Information Technology Service Co Ltd
Current assignee: Shenzhen Qianhai Huanrong Lianyi Information Technology Service Co Ltd
Priority date: 2019-12-17
Filing date: 2019-12-17
Publication date: 2024-04-02
Anticipated expiration: 2039-12-17
Also published as: CN111104191A

Abstract

本申请涉及一种接口对接方法、装置、计算机设备及存储介质，其中该方法包括：获取商家发送的接口对接请求，所述请求中包括请求参数；根据所述接口对接请求中的请求参数查询企业信息表；根据查询结果获取对应的企业信息，所述企业信息包括请求方式、请求格式、数据文件名及请求路径；将所述商家发送的数据存储到对应的数据库表中，并将所述查询结果中获取对应的企业信息进行替换；根据替换以后的数据调用接口进行请求。本发明不仅可以节省了开发、测试、联调的人工成本，还实现了大大缩短了实现周期，为公司节省了成本和时间。

Description

接口对接方法、装置、计算机设备及存储介质

技术领域

本发明涉及计算机技术领域，特别是涉及一种接口对接方法、装置、计算机设备及存储介质。

背景技术

目前，随着科技的不断发展，信息技术的不断普及，很多企业提供的功能或者产品已经不独有，如果这些功能或者产品比较实用，很多企业也开始提供这些功能。提供的企业多了，用户的选择也多。如果是同一个功能，每个企业对外提供的接口参数不一样，请求格式和请求方式也不一样，比如请求方式有：异步和同步，参数格式有：xml和json等，字段命名更是多种多样，比如：英文、英文缩写、中文拼音、中文拼音缩写等；如果有需求要对接这些企业提供的服务，辛辛苦苦对接了A企业，接下来对接B企业的时候，前面实现的那一套代码不能复用，又要从头开始一步一步实现。这种场景还是经常遇到，比如：某商家要使用A企业的功能，辛辛苦苦的对接A企业提供功能服务，后面应为某些原因改成用B企业提供的服务，只能针对B企业再从头到尾再实现一套。像这种提供功能一样，就是提供方不一样，每对接一个提供方，就要从头写一套代码来实现。

在传统技术中，现在有很多企业都遇到类似的问题，但是大部分做法都是每对接一个接口，就写一套代码来实现，如果对接完A企业的接口，还要继续去对接B企业的接口，就从新再写一套代码才行。有些人做得比较好的，就可以把这几套代码的共同性抽离出来，比如请求方法、数据表等抽离出来，然后如果要继续对接C企业的接口，只要实现共同性之外的代码就行，可以减少工作量。无论是哪一种多多少少都要增加开发、联调、测试、上线等工作量。如果要对接几个、几十个或者更多企业，花费的人力、金钱和时间都是成倍增加，浪费了大量的人力资源，导致开发的成本失控。

发明内容

基于此，有必要针对上述技术问题，提供一种可以实现提高接口对接效率降低开发成本的接口对接方法、装置、计算机设备及存储介质。

一种接口对接方法，所述方法包括：

获取商家发送的接口对接请求，所述请求中包括请求参数；

根据所述接口对接请求中的请求参数查询企业信息表；

根据查询结果获取对应的企业信息，所述企业信息包括请求方式、请求格式、数据文件名及请求路径；

将所述商家发送的数据存储到对应的数据库表中，并将所述查询结果中获取对应的企业信息进行替换；

根据替换以后的数据调用接口进行请求。

在其中一个实施例中，在所述获取商家发送的接口对接请求，所述请求中包括请求参数的步骤之前还包括：

定义统一的对外接口，所述接口包含功能的固定要传的固定字段以及用于区分的非必填字段；

创建一张表用于存储请求参数，并创建企业信息表，所述企业信息表用于存储企业的特有字段、请求方式、请求连接、请求格式、返回结果字段名以及预留字段；

每个接口创建一个文件保存请求数据；

写四个请求方法，所述请求方法包括同步的post请求和get请求以及异步post请求和get请求。

在其中一个实施例中，在所述根据替换以后的数据调用接口进行请求的步骤之后还包括：

若所述请求为同步请求方式，则请求完马上会返回请求结果并根据返回的结果进行解析；

通过查询企业信息表得到返回状态变量名，根据变量名截取返回的数据得到状态码，并将所述状态码与企业信息表查询出来的状态码进行比较。

在其中一个实施例中，在所述将所述状态码与企业信息表查询出来的状态码进行比较的步骤之后还包括：

若比较结果不一致则表示失败，将所述请求标志为失败并记录失败原因后返回；

若比较结果一致则表示成功，根据查询企业表得到的解析字段名进行解析数据得到返回的数据，将数据进行保存并返回结果使用者。

若所述请求为异步请求方式，则请求完接口只返回请求结果成功或者失败。

在其中一个实施例中，在所述若所述请求为异步请求方式，则请求完接口只返回请求成功或者失败的步骤之后还包括：

若返回请求失败，则将所述请求标志为失败并记录失败原因后返回调用方；

若返回请求成功，则继续调用查询接口不断查询，每查询一次都会有结果返回，并对得到返回的结果进行解析。

在其中一个实施例中，所述对得到返回的结果进行解析的步骤包括：

若解析数据对比状态不一样则表示失败，结束查询并将所述请求标志为失败记录失败原因后通知调用方；

若解析数据对比状态一样则表示成功，结束查询并将所述数据进行保存后通知调用方。

一种接口对接装置，所述装置包括：

第一获取模块，所述第一获取模块用于获取商家发送的接口对接请求，所述请求中包括请求参数；

信息查询模块，所述信息查询模块用于根据所述接口对接请求中的请求参数查询企业信息表；

第二获取模块，所述第二获取模块用于根据查询结果获取对应的企业信息，所述企业信息包括请求方式、请求格式、数据文件名及请求路径；

数据替换模块，所述数据替换模块用于将所述商家发送的数据存储到对应的数据库表中，并将所述查询结果中获取对应的企业信息进行替换；

接口调用模块，所述接口调用模块用于根据替换以后的数据调用接口进行请求。

一种计算机设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现上述任意一项方法的步骤。

一种计算机可读存储介质，其上存储有计算机程序，所述计算机程序被处理器执行时实现上述任意一项方法的步骤。

上述接口对接方法、装置、计算机设备和存储介质，通过获取商家发送的接口对接请求，所述请求中包括请求参数；根据所述接口对接请求中的请求参数查询企业信息表；根据查询结果获取对应的企业信息，所述企业信息包括请求方式、请求格式、数据文件名及请求路径；将所述商家发送的数据存储到对应的数据库表中，并将所述查询结果中获取对应的企业信息进行替换；根据替换以后的数据调用接口进行请求。本发明通过配置企业信息表，并新增一个请求格式文件就可以实现对新企业的接口对接功能，提高了接口对接的灵活性及易用性。本发明不仅可以节省了开发、测试、联调的人工成本，还实现了大大缩短了实现周期，为公司节省了成本和时间。

附图说明

图1为一个实施例中接口对接方法的流程示意图；

图2为另一个实施例中接口对接方法的流程示意图；

图3为再一个实施例中接口对接方法的流程示意图；

图4为又一个实施例中接口对接方法的流程示意图；

图5为一个实施例中接口对接装置的结构框图；

图6为另一个实施例中接口对接装置的结构框图；

图7为再一个实施例中接口对接装置的结构框图；

图8为又一个实施例中接口对接装置的结构框图；

图9为一个实施例中计算机设备的内部结构图。

具体实施方式

为了使本申请的目的、技术方案及优点更加清楚明白，以下结合附图及实施例，对本申请进行进一步详细说明。应当理解，此处所描述的具体实施例仅仅用以解释本申请，并不用于限定本申请。

目前，传统技术中每对接一个接口，就写一套代码来实现，如果对接完A企业的接口，还要继续去对接B企业的接口，就从新再写一套代码才行。有些人做得比较好的，就可以把这几套代码的共同性抽离出来，比如请求方法、数据表等抽离出来，然后如果要继续对接C企业的接口，只要实现共同性之外的代码就行，可以减少工作量。无论是哪一种多多少少都要增加开发、联调、测试、上线等工作量。如果要对接几个、几十个或者更多企业，花费的人力、金钱和时间都是成倍增加。

基于此，本发明提供一种新的接口对接方案，旨在能够考虑到怎么实现代码重复利用最高、怎么实现工作量才能最小等，还要考虑如果有一个新企业的接口要对接，要怎么才能做到改动小、花时间短、不影响已经对接成功的接口，稍微配置就可以使用。

在一个实施例中，如图1所示，提供了一种接口对接方法，该方法包括：

步骤102，获取商家发送的接口对接请求，该请求中包括请求参数；

步骤104，根据接口对接请求中的请求参数查询企业信息表；

步骤106，根据查询结果获取对应的企业信息，企业信息包括请求方式、请求格式、数据文件名及请求路径；

步骤108，将商家发送的数据存储到对应的数据库表中，并将查询结果中获取对应的企业信息进行替换；

步骤110，根据替换以后的数据调用接口进行请求。

具体地，先阐述本方案的整体发明构思。如果不想每新增一个企业就要从头到尾实现一次，就要想办法进行整合，整合的时候要考虑：怎么实现代码重复利用最高、怎么实现工作量才能最小等，还要考虑如果有一个新企业的接口要对接，要怎么才能做到改动小、花时间短、不影响已经对接成功的接口，稍微配置就可以使用？

首先，分析这种功能，然后分析这种功能有什么用，客户使用这种功能是用来做什么等，然后在分析不同提供方提供的差异性。分析以后得到：请求参数、请求方式、数据格式和字段命名不一样；如果请求接口成功以后，返回的数据和格式也是不一样，但是无论使用哪一个提供方的接口，客户想要的效果都是一样的，最终的设计方案具体包括如下实施方式。

在一个实施例中，如图2所示，提供了一种接口对接方法，该方法在获取商家发送的接口对接请求，该请求中包括请求参数的步骤之前还包括：

步骤202，定义统一的对外接口，接口包含功能的固定要传的固定字段以及用于区分的非必填字段；

步骤204，创建一张表用于存储请求参数，并创建企业信息表；

步骤206，每个接口创建一个文件保存请求数据；

步骤208，写四个请求方法，请求方法包括同步的post请求和get请求以及异步post请求和get请求。

具体地，首先定义一套统一的对外接口，这个接口包含这种功能的固定要传的字段，和一些用于区分的非必填字段。

然后，创建一张表保留这些请求参数，再设置一张企业信息表，这张企业信息表主要保存企业的特有字段、比如请求方式、请求连接、请求格式、返回结果字段名等等，最后还预留五个字段，如果后续新接入某个企业，有特别的要求，可以用到这几个字段。

接着，每个接口都创建一个文件保存请求数据，比如A企业的接口请求格式是json格式，请求字段是35个字段，就把请求的json数据放到文件里面，命名为A接口数据，然后把这些文件数据每一个字段处理一下，让这些字段和上面创建的两张表进行关联起来，为了后续数据替换用到。

最后，写四个请求方法，同步的post和get请求，和异步post和get请求四个。

根据上面的准备，现在就开始功能实现了，如果A商家要对接A企业的接口，商家只要对接我这一套统一接口就行。A商家请求接口把数据传给我，我根据这些数据查询企业信息表，找到A企业的信息，然后根据这些信息，可以知道请求方式、请求格式、数据文件名、请求路径等信息。把商家传过来的数据保存到数据库表，然后把查询到的文件用这些信息替换，最后就可以拿到替换以后的数据，就可以调用接口进行请求。

在上述实施例中，通过获取商家发送的接口对接请求，所述请求中包括请求参数；根据所述接口对接请求中的请求参数查询企业信息表；根据查询结果获取对应的企业信息，所述企业信息包括请求方式、请求格式、数据文件名及请求路径；将所述商家发送的数据存储到对应的数据库表中，并将所述查询结果中获取对应的企业信息进行替换；根据替换以后的数据调用接口进行请求。上述方案通过配置企业信息表，并新增一个请求格式文件就可以实现对新企业的接口对接功能，提高了接口对接的灵活性及易用性。本方案不仅可以节省了开发、测试、联调的人工成本，还实现了大大缩短了实现周期，为公司节省了成本和时间。

在一个实施例中，如图3所示，提供了一种接口对接方法，该方法在根据替换以后的数据调用接口进行请求的步骤之后还包括：

步骤302，若请求为同步请求方式，则请求完马上会返回请求结果并根据返回的结果进行解析；

步骤304，通过查询企业信息表得到返回状态变量名，截取返回的数据得到状态码，并将返回的状态码与企业信息表查询出来的状态码进行比较；

步骤306，若比较结果不一致则表示失败，将请求标志为失败并记录失败原因后返回；

步骤308，若比较结果一致则表示成功，根据查询企业表得到的解析字段名进行解析数据得到返回的数据，将数据进行保存并返回。

具体地，在本实施例中，如果是同步请求方式，请求完马上会返回请求结果，根据返回的结果进行解析，查询企业信息表就可以的得到返回状态变量名，然后可以根据变量名截取返回的数据就得到状态码，得到了返回状态码就可以和企业表查询出来的状态码进行比较：

1、如果不一样表示失败，更新一下这条数据，标志为失败，记录失败原因然后返回。

2、如果一样表示成功，根据查询企业表得到的解析字段名，然后进行解析数据，就可以得到返回的数据，把这些数据进行保存，最后返回结果使用者。

在一个实施例中，如图4所示，提供了一种接口对接方法，该方法在根据替换以后的数据调用接口进行请求的步骤之后还包括：

步骤402，若请求为异步请求方式，则请求完接口只返回请求结果成功或者失败；

步骤404，若返回请求失败，则将请求标志为失败并记录失败原因后返回调用方；

步骤406，若返回请求成功，则继续调用查询接口不断查询，每查询一次都会有结果返回，并对得到返回的结果进行解析；

步骤408，若解析数据对比状态不一样则表示失败，结束查询并将请求标志为失败记录失败原因后通知调用方；

步骤410，若解析数据对比状态一样则表示成功，结束查询并将数据进行保存后通知调用方。

具体地，在本实施例中，如果是异步请求方式，请求完接口只会返回请求成功或者失败，不会返回具体的处理成功数据，请求异步接口以后开始解析返回数据：

1、如果失败，更新一下这条数据，标志为失败，记录失败原因，然后通知调用方。

2、如果成功，继续调用查询接口不断查询，每查询一次都会有结果返回，得到返回结果根据上面的方法进行解析：

2.1、如果解析对比状态不一样，证明不成功，结束查询，更新一下这条数据，标志为失败，记录失败原因，然后通知调用方。

2.2、如果解析数据对比状态一样，表示成功，就结束查询，然后把这些数据进行保存，然后通知调用方。

走到这一步A企业已经对接完了，如果A商家不想对接A企业的接口了，要改成对接B企业的接口，那么实现逻辑不用修改，而且也不用重新写一套代码来实现，只要把B企业的基本信息插入企业信息表，然后创建一个B企业接口请求数据文件就可以搞定。A商家还是继续请求前面联调的统一接口，只是传的标识字段数据变一下，请求过来就变成走B企业的接口了。

在上述实施例中，就是最开始设计和实现的时候花费多一点时间，后面无论要对接多少家企业，都是配置一下企业信息表，新增一个请求格式文件就可以解决问题，这样不仅可以节省了开发、测试、联调的人工成本，还大大缩短了实现周期，为公司节省了成本和时间。

应该理解的是，虽然图1-4的流程图中的各个步骤按照箭头的指示依次显示，但是这些步骤并不是必然按照箭头指示的顺序依次执行。除非本文中有明确的说明，这些步骤的执行并没有严格的顺序限制，这些步骤可以以其它的顺序执行。而且，图1-4中的至少一部分步骤可以包括多个子步骤或者多个阶段，这些子步骤或者阶段并不必然是在同一时刻执行完成，而是可以在不同的时刻执行，这些子步骤或者阶段的执行顺序也不必然是依次进行，而是可以与其它步骤或者其它步骤的子步骤或者阶段的至少一部分轮流或者交替地执行。

在一个实施例中，如图5所示，提供了一种接口对接装置500，该装置包括：

第一获取模块501，用于获取商家发送的接口对接请求，所述请求中包括请求参数；

信息查询模块502，用于根据所述接口对接请求中的请求参数查询企业信息表；

第二获取模块503，用于根据查询结果获取对应的企业信息，所述企业信息包括请求方式、请求格式、数据文件名及请求路径；

数据替换模块504，用于将所述商家发送的数据存储到对应的数据库表中，并将所述查询结果中获取对应的企业信息进行替换；

接口调用模块505，用于根据替换以后的数据调用接口进行请求。

在一个实施例中，如图6所示，提供了一种接口对接装置500，该装置还包括配置模块506，用于：

定义统一的对外接口，接口包含功能的固定要传的固定字段以及用于区分的非必填字段；

每个接口创建一个文件保存请求数据；

在一个实施例中，如图7所示，提供了一种接口对接装置500，该装置还包括同步请求模块507，用于：

在一个实施例中，同步请求模块507还用于：

在一个实施例中，如图8所示，提供了一种接口对接装置500，该装置还包括异步请求模块508，用于：

在一个实施例中，异步请求模块508还用于：

关于接口对接装置的具体限定可以参见上文中对于接口对接方法的限定，在此不再赘述。

在一个实施例中，提供了一种计算机设备，其内部结构图可以如图9所示。该计算机设备包括通过装置总线连接的处理器、存储器以及网络接口。其中，该计算机设备的处理器用于提供计算和控制能力。该计算机设备的存储器包括非易失性存储介质、内存储器。该非易失性存储介质存储有操作装置、计算机程序和数据库。该内存储器为非易失性存储介质中的操作装置和计算机程序的运行提供环境。该计算机设备的网络接口用于与外部的终端通过网络连接通信。该计算机程序被处理器执行时以实现一种接口对接方法。

本领域技术人员可以理解，图9中示出的结构，仅仅是与本申请方案相关的部分结构的框图，并不构成对本申请方案所应用于其上的计算机设备的限定，具体的计算机设备可以包括比图中所示更多或更少的部件，或者组合某些部件，或者具有不同的部件布置。

在一个实施例中，提供了一种计算机设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，处理器执行计算机程序时实现以上各个方法实施例中的步骤。

在一个实施例中，提供了一种计算机可读存储介质，其上存储有计算机程序，计算机程序被处理器执行时实现以上各个方法实施例中的步骤。

本领域普通技术人员可以理解实现上述实施例方法中的全部或部分流程，是可以通过计算机程序来指令相关的硬件来完成，所述的计算机程序可存储于一非易失性计算机可读取存储介质中，该计算机程序在执行时，可包括如上述各方法的实施例的流程。其中，本申请所提供的各实施例中所使用的对存储器、存储、数据库或其它介质的任何引用，均可包括非易失性和/或易失性存储器。非易失性存储器可包括只读存储器(ROM)、可编程ROM(PROM)、电可编程ROM(EPROM)、电可擦除可编程ROM(EEPROM)或闪存。易失性存储器可包括随机存取存储器(RAM)或者外部高速缓冲存储器。作为说明而非局限，RAM以多种形式可得，诸如静态RAM(SRAM)、动态RAM(DRAM)、同步DRAM(SDRAM)、双数据率SDRAM(DDRSDRAM)、增强型SDRAM(ESDRAM)、同步链路(Synchlink)DRAM(SLDRAM)、存储器总线(Rambus)直接RAM(RDRAM)、直接存储器总线动态RAM(DRDRAM)、以及存储器总线动态RAM(RDRAM)等。

以上实施例的各技术特征可以进行任意的组合，为使描述简洁，未对上述实施例中的各个技术特征所有可能的组合都进行描述，然而，只要这些技术特征的组合不存在矛盾，都应当认为是本说明书记载的范围。

以上所述实施例仅表达了本申请的几种实施方式，其描述较为具体和详细，但并不能因此而理解为对发明专利范围的限制。应当指出的是，对于本领域的普通技术人员来说，在不脱离本申请构思的前提下，还可以做出若干变形和改进，这些都属于本申请的保护范围。因此，本申请专利的保护范围应以所附权利要求为准。

Claims

1.一种接口对接方法，其特征在于，所述方法包括：

获取商家发送的接口对接请求，所述请求中包括请求参数；

根据所述接口对接请求中的请求参数查询企业信息表；

根据替换以后的数据调用接口进行请求；

所述请求中包括请求参数的步骤之前还包括：定义统一的对外接口，所述接口包含功能的固定要传的固定字段以及用于区分的非必填字段；创建一张表用于存储请求参数，并创建企业信息表，所述企业信息表用于存储企业的特有字段、请求方式、请求连接、请求格式、返回结果字段名以及预留字段；每个接口创建一个文件保存请求数据；写四个请求方法，所述请求方法包括同步的post请求和get请求以及异步post请求和get请求；

在所述根据替换以后的数据调用接口进行请求的步骤之后还包括：若所述请求为同步请求方式，则请求完马上会返回请求结果并根据返回的结果进行解析；若所述请求为异步请求方式，则请求完接口只返回请求结果成功或者失败。

2.根据权利要求1所述的接口对接方法，其特征在于，在所述若所述请求为同步请求方式，则请求完马上会返回请求结果并根据返回的结果进行解析的步骤之后还包括：

3.根据权利要求2所述的接口对接方法，其特征在于，在所述将所述状态码与企业信息表查询出来的状态码进行比较的步骤之后还包括：

4.根据权利要求1所述的接口对接方法，其特征在于，在所述若所述请求为异步请求方式，则请求完接口只返回请求结果成功或者失败的步骤之后还包括：

5.根据权利要求4所述的接口对接方法，其特征在于，所述对得到返回的结果进行解析的步骤包括：

6.一种接口对接装置，其特征在于，所述装置包括：

接口调用模块，所述接口调用模块用于根据替换以后的数据调用接口进行请求；

所述装置还包括配置模块，用于：定义统一的对外接口，接口包含功能的固定要传的固定字段以及用于区分的非必填字段；创建一张表用于存储请求参数，并创建企业信息表，所述企业信息表用于存储企业的特有字段、请求方式、请求连接、请求格式、返回结果字段名以及预留字段；每个接口创建一个文件保存请求数据；写四个请求方法，所述请求方法包括同步的post请求和get请求以及异步post请求和get请求；

所述装置还包括同步请求模块，用于：若所述请求为同步请求方式，则请求完马上会返回请求结果并根据返回的结果进行解析；

所述装置还包括异步请求模块，用于：若所述请求为异步请求方式，则请求完接口只返回请求结果成功或者失败。

7.一种计算机设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，其特征在于，所述处理器执行所述计算机程序时实现权利要求1至5中任一项所述方法的步骤。

8.一种计算机可读存储介质，其上存储有计算机程序，其特征在于，所述计算机程序被处理器执行时实现权利要求1至5中任一项所述的方法的步骤。