CN106603593A - 一种基于适配的http调用方法及装置 - Google Patents

Abstract

本发明提供一种基于适配的HTTP调用方法及装置，能够避免HTTP接口调用重复开发，每个接口接入通过配置即可实现，后续新增的接口类型可通过适配器来适配，且方便对所有接口调用统一管理。本发明的基于适配的HTTP调用方法包括：接收客户端按照预定的地址格式发送过来的业务请求，所述预定的地址格式中的参数名包括方法名、数据格式类型及业务参数；根据所述数据格式类型选择对应数据格式的适配器来处理所述业务请求；根据所述方法名，通过所述适配器获取业务系统的接口地址并调用该接口；接收所述业务系统返回的数据，并返回给客户端。

Description

一种基于适配的HTTP调用方法及装置

技术领域

本发明涉及计算机技术领域，特别地涉及一种基于适配的HTTP调用方法及装置。

背景技术

随着计算机技术的发展，Pc版本，ios版本和安卓版本等各种不同版本的产品应用已深入到人们的日常生活中，例如：可网上购物的各种应用等。在进行网上购物时，用户经常需要查询一些信息，例如：客户需要查询所有下过的订单情况，就需要客户发送查询订单的请求给服务端，服务端接收到用户的请求后将从位于后台的提供业务服务的第三方订单业务系统中调取订单数据，然后将得到的数据返回给客户端进行显示。

在服务端和各个业务系统之间调取数据时候的通讯过程中，会有很多基于HTTP协议调用的场景，在这些场景中需要编写每个基于HTTP协议的业务请求和响应的接口来实现获取数据的功能。

现有技术一般按照以下步骤来实现基于HTTP协议的调用过程：

1、选择一种基于http协议调用的方法工具，目前使用较多的方法工具一般有两种，一种是Java语言的软件开发工具包jdk中自带的工具类java.net.HttpURLConnection，或者开源的Web服务器软件Apache的工具包commons-httpClient；

2、编写业务接口，使用如1中的任意一种基于http协议调用的方法工具，根据不同业务对应的功能实现定义对应的业务接口，以实现所需要进行的业务操作；

3、实现业务对应接口，通过2中所使用的的方法工具类，根据每个不同业务的相关参数来分别实现与相应业务的接口提供方进行通讯；

4、返回结果，将相应业务的接口提供方返回的数据返回并显示给用户。

通过上述的现有技术方案来实现基于HTTP协议的调用，在每次有新的接口接入时，都需要编写新的方法程序代码来实现，极为繁琐，且系统扩展性差，代码维护困难。

发明内容

有鉴于此，本发明提供一种基于适配的HTTP调用方法及装置，能够避免HTTP接口调用重复开发，每个接口接入通过配置即可实现，后续新增的接口类型可通过适配器来适配，且方便对所有接口调用统一管理。

为实现上述目的，根据本发明的一个方面，提供了一种基于适配的HTTP调用方法。

一种基于适配的HTTP调用方法，包括：接收客户端按照预定的地址格式发送过来的业务请求，所述预定的地址格式中的参数名包括方法名、数据格式类型及业务参数；根据所述数据格式类型选择对应数据格式的适配器来处理所述业务请求；根据所述方法名，通过所述适配器获取业务系统的接口地址并调用该接口；接收所述业务系统返回的数据，并返回给客户端。

可选地，接收客户端按照预定的地址格式发送过来的业务请求的步骤之前，还包括：通过codeApi对应的servlet实例来接收客户端按照预定的地址格式发送过来的业务请求。

可选地，所述方法名由业务系统名称、业务名称和接口方法名称所组成。

可选地，所述数据格式类型包括json和xml两种。

可选地，所述获取业务系统的接口地址的步骤包括：先从地址缓存单元中获取业务系统的接口地址；如果获取不到，则从地址配置单元中获取所述接口地址。

可选地，所述地址配置单元中包括所述方法名与所述业务系统的接口地址的对应关系。

根据本发明的另一方面，提供了一种基于适配的HTTP调用装置。

一种基于适配的HTTP调用装置，包括：统一地址接口模块，用于接收客户端按照预定的地址格式发送过来的业务请求，所述预定的地址格式中的参数名包括方法名、数据格式类型及业务参数；数据格式适配模块，用于根据所述数据格式类型选择对应数据格式的适配器来处理所述业务请求；接口地址获取模块，用于根据所述方法名，通过所述适配器获取业务系统的接口地址并调用该接口；请求结果返回模块，用于接收所述业务系统返回的数据，并返回给客户端。

可选地，所述统一地址接口模块还用于：通过codeApi对应的servlet实例来接收客户端按照预定的地址格式发送过来的业务请求。

可选地，所述方法名由业务系统名称、业务名称和接口方法名称所组成。

可选地，所述数据格式类型包括json和xml两种。

可选地，所述接口地址获取模块还用于：先从地址缓存单元中获取业务系统的接口地址；如果获取不到，则从地址配置单元中获取所述接口地址。

可选地，所述地址配置单元中包括所述方法名与所述业务系统的接口地址的对应关系。

根据本发明的技术方案，通过将所有业务请求的地址统一格式并选择对应数据格式的适配器来进行处理，进而从缓存中获取接口地址的方式，可以有效地避免HTTP接口调用的重复开发，提高接口的接入速度，同时，新增的数据格式类型可通过适配器来适配，系统可扩展性强，且可实现对接口调用的统一管理。

附图说明

附图用于更好地理解本发明，不构成对本发明的不当限定。其中：

图1是根据本发明实施例的一种基于适配的HTTP调用方法的主要步骤示意图；

图2是根据本发明实施例的一种基于适配的HTTP调用装置的主要模块示意图；

图3是根据本发明实施例的基于适配的HTTP调用的过程示意图。

具体实施方式

以下结合附图对本发明的示范性实施例做出说明，其中包括本发明实施例的各种细节以助于理解，应当将它们认为仅仅是示范性的。因此，本领域普通技术人员应当认识到，可以对这里描述的实施例做出各种改变和修改，而不会背离本发明的范围和精神。同样，为了清楚和简明，以下的描述中省略了对公知功能和结构的描述。

图1是根据本发明实施例的一种基于适配的HTTP调用方法的主要步骤示意图。如图1所示，本发明的一种基于适配的HTTP调用方法主要包括如下的步骤S11至步骤S14。

步骤S11：接收客户端按照预定的地址格式发送过来的业务请求。其中，所述预定的地址格式中的参数名包括方法名、数据格式类型及业务参数等信息。在本发明的实施例中，通过codeApi对应的servlet实例来接收客户端按照预定的地址格式发送过来的业务请求。在步骤S11中，通过引入Java编程语言中的类servlet来实现地址格式统一的功能，此处，servlet就是统一地址接口模块。由于servlet类具有单实例多线程的特点，因此，将不同的地址请求通过servlet类中的codeApi进行映射，即可得到相同格式的servlet实例。例如，对于大型电商企业京东商城来说，可以通过请求http://test.jd.com/codeApi，即可将所有的请求都经过codeApi对应的servlet实例来接收处理，从而将这个地址暴露给Pc、Ios、Android对应版本的应用程序，使所有客户端的业务调用都通过统一接口模块servlet来实现。

不同的业务请求对应不同的请求路径，但是为了区分各个业务的访问请求，根据本发明实施例的技术方案，预定格式的地址中的参数名可以包括方法名、数据格式类型及业务参数等信息。其中，为保证方法名的唯一性，方法名可以由业务系统名称、业务名称和接口方法名称所组成，且数据格式类型主要包括json和xml两种。当后续HTTP协议支持的数据格式类型增加时，可根据情况进行扩展开发。例如，一个完整的请求url类似如下：

http://test.jd.com/codeApi？param_json＝{"method":"workstation.trade.ordeorder","type":"json","biz":{}}，在该请求路径中，“param_json”指的是参数名，“＝”号后面的为参数值。其中，“method”是方法名，方法名采取业务系统名称+业务名称+接口方法名称的规则定义并保证唯一性；“type”是数据格式类型比如是json或者xml；“biz”为业务参数，不同接口对应着不同的业务参数。

根据步骤S11即可实现将不同的业务请求地址格式统一化，从而使Pc、Ios或Android版本的客户端在对业务系统的接口进行调用的时候统一成一个地址，为服务器端的管理带来了很大的方便。

步骤S12：根据所述数据格式类型选择对应数据格式的适配器来处理所述业务请求。由于不同数据格式的请求在进行处理时，所选择的方法也不同，故而对不同数据格式的请求进行分别适配处理。如步骤S11中举例示出的一个完整的请求url所示，其中，参数名中包含type参数且其值为json，因此，可通过type参数找到json格式的适配器。如果后续有新增数据格式的接口可以增加新的适配器，处理逻辑不变，更易于统一管理和开发。

步骤S13：根据所述方法名，通过所述适配器获取业务系统的接口地址并调用该接口。在获取业务系统的接口地址时，根据本实施例的技术方案，可以先从地址缓存单元中获取业务系统的接口地址；如果获取不到，则从地址配置单元中获取所述接口地址。其中，地址配置单元中包括所述方法名与所述业务系统的接口地址的对应关系。

如步骤S11中举例示出的一个完整的请求url所示，其中参数“method”是方法名，方法名采取业务系统名称+业务名称+接口方法名称的规则定义以保证唯一性。地址配置单元提供录入业务系统接口提供方的请求url地址的功能，将方法名method对应的请求地址url录入到地址配置单元中，并维护方法名method与请求地址url的对应关系，类似如下的对应关系：

workstation.trade.orderlist对应http://order.jd.com/trade/orderlist。

通过地址配置单元来配置的地址会同步到地址缓存单元中，缓存的key可采用具有唯一性的方法名method的名称来定义，适配器通过方法名method来直接读取缓存中的地址，以调用接口提供方提供的接口。

在获取业务系统的接口地址时，可以先从地址缓存单元中获取业务系统的接口地址；如果获取不到，则从地址配置单元中获取所述接口地址，以确保一定能获取到地址。通过先从地址缓存单元中获取接口地址，由于内存中数据读取快，故可以提高地址获取的效率；当获取不到地址时，再从地址配置单元中获取，可以减小数据库的访问压力，且确保一定能获取到地址。

步骤S14：接收所述业务系统返回的数据，并返回给客户端。客户端通过服务器端调用业务系统的接口后，业务系统会返回需要的数据给服务器端，然后服务器端将最终结果返回给客户端。

根据上述的步骤S11至步骤S14，即可实现将访问地址与接口地址一一对应，快速响应客户端的访问请求，且服务器端无需重复开发业务接口，方便统一管理。

图2是根据本发明实施例的一种基于适配的HTTP调用装置的主要模块示意图。如图2所示，本发明的基于适配的HTTP调用装置20主要包括统一地址接口模块21、数据格式适配模块22、接口地址获取模块23和请求结果返回模块24。

统一地址接口模块21用于接收客户端按照预定的地址格式发送过来的业务请求，所述预定的地址格式中的参数名包括方法名、数据格式类型及业务参数；数据格式适配模块22用于根据所述数据格式类型选择对应数据格式的适配器来处理所述业务请求；接口地址获取模块23用于根据所述方法名，通过所述适配器获取业务系统的接口地址并调用该接口；请求结果返回模块24用于接收所述业务系统返回的数据，并返回给客户端。

统一地址接口模块21还可以用于通过codeApi对应的servlet实例来接收客户端按照预定的地址格式发送过来的业务请求。

接口地址获取模块23还可以用于先从地址缓存单元中获取业务系统的接口地址；如果获取不到，则从地址配置单元中获取所述接口地址。其中，地址配置单元中包括所述方法名与所述业务系统的接口地址的对应关系。

结合本发明实施例的技术方案，其中，方法名由业务系统名称、业务名称和接口方法名称所组成；且数据格式类型包括json和xml两种。

图3是根据本发明实施例的基于适配的HTTP调用的过程示意图。如图3所示，图中客户端可包括Pc版本，Ios版本，Android版本的应用程序，是本发明的接口调用方。业务系统是本发明的接口提供方。本发明的基于适配的HTTP调用装置位于服务器端，介于客户端与业务系统之间。

当客户端发出查询数据的业务请求后，将直接通过本发明的统一地址接口模块来进行业务请求。统一地址接口模块通过codeApi对应的servlet实例来接收客户端按照预定的地址格式发送过来的业务请求，之后根据该预定格式的地址参数名中包含的方法名、数据格式类型及业务参数等信息进行进一步的处理。首先是根据数据格式类型选择相应的适配器来处理业务请求，此处数据格式类型type可以是json或者xml，在后续有新增数据格式类型时，仅需要增加新的适配器即可，无需改变其他功能的实现逻辑。选择好适配器后，将根据地址参数名中包含的方法名来匹配业务系统的接口地址，在进行地址获取时，首先是从地址缓存单元中进行查找，如果地址缓存单元中没有获取到地址，则从地址配置单元中进行获取，其中，地址配置单元中保存有方法名和接口地址的对应关系，由于方法名具有唯一性，因此与接口地址的对应关系也是唯一的，方便进行接口调用。获取接口地址后，调用接口提供方业务系统所提供的接口，以获取所需要的数据信息。最后，将最终的数据信息返回给客户端。

根据本发明实施例的技术方案，通过将所有业务请求的地址统一格式并选择对应数据格式的适配器来进行处理，进而从缓存中获取接口地址的方式，可以有效地避免HTTP接口调用的重复开发，提高接口的接入速度，同时，新增的数据格式类型可通过适配器来适配，系统可扩展性强，且可实现对接口调用的统一管理。

上述具体实施方式，并不构成对本发明保护范围的限制。本领域技术人员应该明白的是，取决于设计要求和其他因素，可以发生各种各样的修改、组合、子组合和替代。任何在本发明的精神和原则之内所作的修改、等同替换和改进等，均应包含在本发明保护范围之内。

Claims (12)

1.一种基于适配的HTTP调用方法，其特征在于，包括：

接收客户端按照预定的地址格式发送过来的业务请求，所述预定的地址格式中的参数名包括方法名、数据格式类型及业务参数；

根据所述数据格式类型选择对应数据格式的适配器来处理所述业务请求；

根据所述方法名，通过所述适配器获取业务系统的接口地址并调用该接口；

接收所述业务系统返回的数据，并返回给客户端。

2.根据权利要求1所述的HTTP调用方法，其特征在于，接收客户端按照预定的地址格式发送过来的业务请求的步骤包括：

通过codeApi对应的servlet实例来接收客户端按照预定的地址格式发送过来的业务请求。

3.根据权利要求1所述的HTTP调用方法，其特征在于，所述方法名由业务系统名称、业务名称和接口方法名称所组成。

4.根据权利要求1所述的HTTP调用方法，其特征在于，所述数据格式类型包括json和xml两种。

5.根据权利要求1所述的HTTP调用方法，其特征在于，所述获取业务系统的接口地址的步骤包括：

先从地址缓存单元中获取业务系统的接口地址；

如果获取不到，则从地址配置单元中获取所述接口地址。

6.根据权利要求5所述的HTTP调用方法，其特征在于，所述地址配置单元中包括所述方法名与所述业务系统的接口地址的对应关系。

7.一种基于适配的HTTP调用装置，其特征在于，包括：

统一地址接口模块，用于接收客户端按照预定的地址格式发送过来的业务请求，所述预定的地址格式中的参数名包括方法名、数据格式类型及业务参数；

数据格式适配模块，用于根据所述数据格式类型选择对应数据格式的适配器来处理所述业务请求；

接口地址获取模块，用于根据所述方法名，通过所述适配器获取业务系统的接口地址并调用该接口；

请求结果返回模块，用于接收所述业务系统返回的数据，并返回给客户端。

8.根据权利要求7所述的HTTP调用装置，其特征在于，所述统一地址接口模块还用于：

通过codeApi对应的servlet实例来接收客户端按照预定的地址格式发送过来的业务请求。

9.根据权利要求7所述的HTTP调用装置，其特征在于，所述方法名由业务系统名称、业务名称和接口方法名称所组成。

10.根据权利要求7所述的HTTP调用装置，其特征在于，所述数据格式类型包括json和xml两种。

11.根据权利要求7所述的HTTP调用装置，其特征在于，所述接口地址获取模块还用于：

先从地址缓存单元中获取业务系统的接口地址；

如果获取不到，则从地址配置单元中获取所述接口地址。

12.根据权利要求11所述的HTTP调用装置，其特征在于，所述地址配置单元中包括所述方法名与所述业务系统的接口地址的对应关系。