HTTP接口调用的方法、装置与流程

本发明涉及计算机技术领域，尤其涉及一种http接口调用的方法、装置。

背景技术

http(hypertexttransferprotocol，超文本传输协议)是一套计算机通过网络进行通信的规则，当客户端调用服务端时，服务端提供http接口，客户端需要根据不同的url和请求参数编写不同的硬代码，此时，如果有很多不同的接口就需要为每个接口单独编写一个http请求代码，非常的不灵活。

目前，最常用的解决办法是提供一个公共的请求工具类，在日常开发使用第三方数据时，第三方可能会提供几种方式获取数据，如http方式、远程调用方式。通常http方式是最简单、最受研发人员青睐的，当使用http方式获取数据时，需要使用httpclient等第三方工具包来处理，每次调用第三方工具包。

在实现本发明过程中，发明人发现现有技术中至少存在如下问题：

1.从实用性来讲，要想利用第三方工具包支持http请求、响应，不得不接受其面向过程的特点，即代码耦合度高，每当有接口发生变化时，需要修改大量的代码，很可能会因为工具包和业务逻辑耦合而引起修改bug；

2.从复杂性角度来讲，httpurl地址、请求参数的复杂多样导致灵活性差，请求参数、响应内容安全问题都会给每次请求带来致命的问题；

3.从可行性角度来讲，面向过程开发是需要改变开发人员的研发习惯，在可维护性和可阅读性上面临极大挑战。

因此，在使用第三方工具包进行开发的过程中，代码耦合度高，灵活性、可维护性、可阅读性差，不符合java提倡面向对象和面向接口开发的标准，同时，在系统资源以及人力、时间成本方面都存在着较大的浪费。

技术实现要素：

有鉴于此，本发明实施例提供一种http接口调用的方法、装置、电子设备和可读介质，能够解决在使用第三方工具包进行开发的过程中，代码耦合度高，灵活性、可维护性、可阅读性差的问题。

为实现上述目的，根据本发明实施例的一个方面，提供了一种http接口调用的方法。

本发明实施例的一种http接口调用的方法包括：当客户端启动时，根据配置类路径和包路径对超文本传输协议http接口进行扫描，获取可调用http接口；对所述可调用http接口进行代理注册。

可选地，所述方法进一步包括：对所述http接口进行定义并添加注解标识。

可选地，对所述http接口进行定义包括：根据定义规则对所述http接口进行定义，所述定义规则包括：接口类定义规则、方法规则、参数分类规则、方法参数规则。

可选地，所述代理注册包括：获取所述http接口的注解标识；查找注解标识中是否包含有所述可调用http接口的标识；对包含有所述可调用http接口的标识的http接口进行代理注册。

可选地，所述代理注册进一步包括：为所述可调用http接口设置实例方式的实例化信息，所述实例化信息包括实例接口类型、实例化方式代理类以及是否为单例模式的信息。

为实现上述目的，根据本发明实施例的另一方面，提供了一种http接口调用的装置。

本发明实施例的一种http接口调用的装置包括：获取模块，用于当客户端启动时，根据配置类路径和包路径对超文本传输协议http接口进行扫描，获取可调用http接口；注册模块，用于对所述可调用http接口进行代理注册。

可选地，所述装置还包括：定义模块，用于对http接口进行定义并添加注解标识。

可选地，所述定义模块还用于：根据定义规则对所述http接口进行定义，所述定义规则包括：接口类定义规则、方法规则、参数分类规则、方法参数规则。

可选地，所述注册模块还用于：获取所述http接口的注解标识；查找注解标识中是否包含有所述可调用http接口的标识；对包含有所述可调用http接口的标识的http接口进行代理注册。

可选地，所述注册模块还用于：为所述可调用http接口设置实例方式的实例化信息，所述实例化信息包括实例接口类型、实例化方式代理类以及是否为单例模式的信息。

为实现上述目的，根据本发明实施例的再一方面，提供了一种实现http接口调用的方法的电子设备。

本发明实施例的一种电子设备包括：一个或多个处理器；存储装置，用于存储一个或多个程序，当所述一个或多个程序被所述一个或多个处理器执行，使得所述一个或多个处理器实现本发明实施例的http接口调用的方法。

为实现上述目的，根据本发明实施例的又一方面，提供了一种非暂态计算机可读存储介质。

本发明实施例的一种计算机可读介质，其上存储有计算机程序，其特征在于，所述程序被处理器执行时实现本发明实施例的http接口调用的方法。

上述发明中的一个实施例具有如下优点或有益效果：因为采用http服务面向接口编程，即先把客户端所依赖远程服务端的业务提取出来作为接口，远程服务端的业务具体实现通过该接口的实现类来完成，当服务端实现类的方法逻辑发送变化时，只需编写该业务逻辑的新的实现类，不需要改写客户端接口现有代码，减少对系统的影响；同时，采用基于接口编程的项目，业务逻辑清晰，代码易懂，方便扩展，可维护性强；进一步地，面向接口编程不需要改变开发人员的开发习惯，极大提高了推广上面的效率，在项目的可维护性和可阅读性方面上大大降低了维护成本，从而在人力、时间成本方面有效的解决了浪费。

上述的非惯用的可选方式所具有的进一步效果将在下文中结合具体实施方式加以说明。

附图说明

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

图1是根据本发明实施例的http接口调用的方法的主要步骤的示意图；

图2是根据本发明实施例的http接口调用的方法的http接口扫描和注册的示意图；

图3是根据本发明实施例的http接口调用的方法中http接口请求客户端模型的示意图；

图4是根据本发明实施例的http接口调用的方法中http接口调用的流程示意图；

图5是根据本发明实施例的http接口调用的方法中http接口请求客户端接入的流程示意图；

图6是根据本发明实施例的http接口调用的装置的主要模块的示意图；

图7是适于用来实现本申请实施例的终端设备或服务器的计算机系统的结构示意图。

具体实施方式

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

本发明实施例的技术方案因为采用http服务面向接口编程，即先把客户端所依赖远程服务端的业务提取出来作为接口，远程服务端的业务具体实现通过该接口的实现类来完成，当服务端实现类的方法逻辑发送变化时，只需编写该业务逻辑的新的实现类，不需要改写客户端接口现有代码，减少对系统的影响；同时，采用基于接口编程的项目，业务逻辑清晰，代码易懂，方便扩展，可维护性强；进一步地，面向接口编程不需要改变开发人员的开发习惯，极大提高了推广上面的效率，在项目的可维护性和可阅读性方面上大大降低了维护成本，从而在人力、时间成本方面有效的解决了浪费。

图1是根据本发明实施例的http接口调用的方法的主要步骤的示意图。

如图1所示，本发明实施例的一种http接口调用的方法主要包括如下步骤：

步骤s101：当客户端启动时，根据配置类路径和包路径对http接口进行扫描，获取可调用http接口。

当客户端启动时，在指定范围内扫描接口，获取指定范围内符合要求的全部可调用http接口，需要注意的是，扫描的范围可以通过配置类路径和包路径来指定。

为了使代码结构清晰便于后续维护和管理，客户端首先根据自己所需要的数据定义调用的http接口类。本发明实施例中，对http接口进行定义并添加注解标识。

在本发明实施例中，对http接口进行定义可以根据定义规则对http接口进行定义，定义规则包括：接口类定义规则、方法规则、参数分类规则、方法参数规则。

客户端对http接口进行定义是把相关的业务进行分类，并给每个分类定义一个接口，把请求http接口的地址和参数映射到http接口对应的方法和参数，请求地址为方法名，请求参数为方法参数，客户端对http接口进行定义有如下几种规则：

1、接口类定义规则，把相同类别的一组http接口，命名为一个接口，可以用注解“@pandora”标记，例如，与用户相关的接口，获取用户名登陆基本信息(登陆名、昵称等)、获取用户会员级别等，都是与用户相关的操作，可定义为一个用户接口；

2、方法规则，每个方法代表一个http接口，为了能够简单区分每个http请求，规定每个http请求用一个特殊参数名(apiname)区分，且该参数每次请求时都必须存在，可以用注解“@phttppost”来表示该次http请求是post还是get，默认是post，可根据实际情况修改，例如，http://p.jd.com？apiname＝getuserbasicinfo&username＝东风破，表示获取用户为“东风破”的基本信息；

3、参数分类规则，http请求参数分为两种类型，基本参数和业务参数，基本参数是该次http接口请求的必须参数，它包括apiname(http接口名)、安全认证token(令牌，如果已开启安全认证)、signature(签名，数据完整性校验)，基本参数对开发者透明，除了配置是否开启安全认证，业务参数体现在接口方法参数上；

4、方法参数规则，方法参数其实就是该次http接口请求的业务参数，可以用注解“@pparam”表示参数名，参数之间是有顺序的，在signature时用到这个特性，例如，form表单的field和value。

可以根据以上任意一种规则对http接口进行定义。

步骤s102：对可调用http接口进行代理注册。

在本发明实施例中，本步骤可以通过获取http接口的注解标识；查找注解标识中是否包含有可调用http接口的标识；对包含有可调用http接口的标识的http接口进行代理注册。

在已完成对http接口的定义和添加注解后，选择调用http接口可以通过筛选http接口的注解标识来完成，对包含有可调用http接口的标识的http接口进行代理注册。

在本发明实施例中，代理注册可以通过为可调用http接口设置实例方式的实例化信息实现，实例化信息包括实例接口类型、实例化方式代理类以及是否为单例模式的信息。

图2是根据本发明实施例的http接口调用的方法的http接口扫描和注册的示意图。

本发明实施例中，选用spring(一种轻量级的java开发框架)依赖注入方式获取bean(实例)、选用springioc容器对http接口进行管理，选择注解“@pandora”作为可调用http接口的注解标识。

在客户端启动时，需要加载相应的bean以及进行实例化时的基本信息，比如加载哪些bean、bean的接口是什么、是否为单例模式等等，具体http接口扫描和注册的实现方案如下：

步骤201：根据配置的包或类路径进行接口扫描。

客户端启动时，pandorafactory(代理工厂)会根据配置的包或类路径进行接口扫描。找到需要加载的http接口并委托springioc容器进行管理。

步骤202：过滤类注解为@pandora。

springioc容器过滤类注解为@pandora的接口，该接口就是提供服务端http接口。

步骤203：注册bean。

为每个http接口定义一个对应的springgenericbeandefinition，genericbeandefinition是一站式的标准beandefinition(bean定义)，除了具有指定类、可选的构造参数值和属性参数这些其它beandefinition一样的特性外，它还具有通过parentname属性来灵活设置parentbeandefinition。通常，genericbeandefinition用来注册用户可见的beandefinition(可见的beandefinition意味着可以在该类beandefinition上定义post-processor(后处理程序)来对bean进行操作，甚至为配置parentname做扩展准备)。

步骤204：设置创建bean模板。

通过genericbeandefinition设置pandorafactorybean(实例方式)的实例化时所需的基本信息，包括实例接口类型、实例化方式代理类class、是否为单例模式等。

至此，整个接口扫描、注册全部完成，接下来，客户端就可以使用spring方式正常调用这些接口。

图3是根据本发明实施例的http接口调用的方法中http接口请求客户端模型的示意图。

本发明实施例中，将http接口请求客户端划分为两大功能模块“核心模块”和“bean管理”，其中，核心模块功能包括“资源配置”、“代理工厂”、“注解”、“http工具包”、“结果转换器”、“安全认证”；“bean管理”模板包括功能“接口扫描器”、“factorybean”，各功能具体如下：

1、资源配置，负责资源信息配置，主要提供http请求地址，安全认证token、请求超时时间配置。

2、代理工厂，负责接口动态代理类生成及调用。

3、接口注解，提供http接口注解，目前有三大注解“@pandora”、“@phttppost”、“@pparam”，具体作用如下：

1)@pandora，用于识别当前接口是http请求接口；作用域是类。

2)@phttppost，用于表示请求为post，其它都为get请求，且默认是post，作用域是方法。

3)@pparam，用于对应http请求的业务参数key＝value格式中的key。根据java多态特性，无法知道方法参数的命名，所以通过显示定义参数注解方式来获取方法参数命名。

4、http工具包，提供高效的、功能丰富的支持http协议的客户端编程工具包。

5、结果转换器，主要在http响应后，提供返回数据的解析并转换成对象，目前返回结果对象类型支持四大类：基本类型、list、map、pdto，其中，pdto是本发明实施例自定义返回通用类型，支持返回分页、对象集合以及错误信息。

6、安全认证，主要包括token生成器和签名认证两种功能，具体作用如下：

1)token生成器，提供身份认证，只有具有服务端派发的身份token，才可以访问服务端提供的接口。

2)签名认证，用于请求数据完整性校验，保证数据在传输过程中，不发生丢失和篡改。

7、接口扫描器，用于提供http接口扫描、bean定义注册。

8、factorybean，主要用于提供接口代理对象生成和对象的实例化方式，依赖上述的代理工厂来生成代理类。

图4是根据本发明实施例的http接口调用的方法中http接口调用的执行流程示意图。

步骤401：当需要调用http接口时，就直接调用与http接口对应的方法，该方法会根据注册的bean实例化方式调用pandorafactorybean(实例类)的getobject方法获取bean实例对象。

pandorafactorybean的getobject方法调用代理工厂类的newpandoraproxy方法，该方法主要根据jdk动态代理生成代理类并执行。

步骤402：代理工厂类的newpandoraproxy方法，调用jdk动态代理提供的proxy(代理服务器)类newproxyinstance静态方法，并传入类加载器、代理类接口class以及需要处理的回调invocationhandler。

步骤403：proxy.getproxyclas方法调用proxygenerator.generateproxyclass方法根据接口生成有参数构造函数代理类$proxy0并继承proxy，构造函数参数invocationhandler。

pandoraproxy类实现invocationhandler接口，$proxy0代理类调invocationhandlerinvoke方法，其实就是调用pandoraproxy类invoke方法。

步骤404：pandoraproxy类invoke方法调用pandoramethod(方法)类的execute方法，并传入要执行的接口方法和参数。

步骤405：execute方法调用buildbasicparams和buildbussiparams方法，生成基本参数和业务参数。

基本参数包括apiname(接口的方法名)、身份认证token(根据服务端是否开启验证，来确定是否需要加入该参数)、签名(保证传输过程数据完整性)；

业务参数转化成httpbodykey＝value格式并有序，参数名(key)从接口方法中的“@pparam”注解获取，value来源与接口方法调用时传入的值。value支持基本数据类型、string、数组、json、object.tostring、pmap类型。注意数组中的数据也支持以上说明的几种类型。其中pmap为自定义类型，是一种map结构底层实现是linkedhashmap，可存储任何类型，只需存储类型实现tostring方法即可。pmap类型可自动转换成http可设别key＝value风格。

获取接口对应方法的方法注解@phttppost的值来判断本次请求方式是post还是get，值是true，是post反之是get。

本次http请求所有准备工作完毕，调用httprequest工具类的post或get方法(由@phttppost值决定)。

步骤406：httprequest(http请求)的post/get方法直接请求服务端提供的http接口地址，服务端会做些安全认证(如果支持安全认证)响应请求返回数据res。

res经过httprequest解析，返回stringresponsebody。

responsebody经过结果转换器，返回对应的结果对象。目前结果对象类型支持4大类：基本类型、list、map、pdto；pdto是本实施例自定义返回通用类型。

经过层层方法返回，最终结果返回到初始调用接口方法中，供客户端方法使用。

图5是根据本发明实施例的http接口调用的方法中http接口请求客户端接入的流程示意图。

本发明实施例考虑到系统的耦合性，设计了无侵入的接入方式，主要包含以下三个步骤：

步骤501：引入包含实例模板的jar包。

支持maven方式导入包含实例模板的jar包。

步骤502：配置资源文件。

资源文件包括http请求地址，安全认证token(如果服务端支持认证就需要配置，默认是不进行配置)、请求超时时间配置。

步骤503：配置接口扫描路径。

支持包和类路径配置。

需要说明的是，步骤502和步骤503支持spring(一种轻量级的java开发框架)资源文件方式配置，符合web服务开发者的开发习惯。

根据本发明实施例的http接口调用的方法可以看出，因为采用http接口调用服务面向接口编程、定义业务接口，即先把客户端所依赖远程服务端的业务提取出来作为接口，远程服务端的业务具体实现通过该接口的实现类来完成，当实现类的方法逻辑发生变化时，只需重新编写该业务逻辑的实现类，而不需要改写客户端接口现有代码，减少对系统的影响；同时，采用基于接口编程的项目，业务逻辑清晰，代码易懂，方便扩展，可维护性强；进一步地，面向接口编程不需要改变开发人员的开发习惯，极大提高了推广上面的效率，在项目的可维护性和可阅读性方面上大大降低了维护成本，从而在人力、时间成本方面有效的解决了浪费。

图6是根据本发明实施例的http接口调用的装置的主要模块的示意图；

如图6所示，本发明实施例的http接口调用的装置600包括：获取模块601以及注册模块602。其中：

获取模块601，用于当客户端启动时，根据配置类路径和包路径对超文本传输协议http接口进行扫描，获取可调用http接口；注册模块602，用于对所述可调用http接口进行代理注册。

此外，所述装置还包括：定义模块，用于对http接口进行定义并添加注解标识。

所述定义模块还用于：根据定义规则对所述http接口进行定义，所述定义规则包括：接口类定义规则、方法规则、参数分类规则、方法参数规则。

此外，所述注册模块602还用于：获取所述http接口的注解标识；查找注解标识中是否包含有所述可调用http接口的标识；对包含有所述可调用http接口的标识的http接口进行代理注册。

此外，所述注册模块602还用于：为所述可调用http接口设置实例方式的实例化信息，所述实例化信息包括实例接口类型、实例化方式代理类以及是否为单例模式的信息。

根据本发明实施例的http接口调用的装置可以看出因为采用http接口调用服务面向接口编程、定义业务接口，即先把客户端所依赖远程服务端的业务提取出来作为接口，远程服务端的业务具体实现通过该接口的实现类来完成，当实现类的方法逻辑发生变化时，只需重新编写该业务逻辑的实现类，而不需要改写客户端接口现有代码，减少对系统的影响；同时，采用基于接口编程的项目，业务逻辑清晰，代码易懂，方便扩展，可维护性强；进一步地，面向接口编程不需要改变开发人员的开发习惯，极大提高了推广上面的效率，在项目的可维护性和可阅读性方面上大大降低了维护成本，从而在人力、时间成本方面有效的解决了浪费。

下面参考图7，其示出了适于用来实现本申请实施例的终端设备的计算机系统700的结构示意图。图7示出的终端设备仅仅是一个示例，不应对本申请实施例的功能和使用范围带来任何限制。

如图7所示，计算机系统700包括中央处理单元(cpu)701，其可以根据存储在只读存储器(rom)702中的程序或者从存储部分708加载到随机访问存储器(ram)703中的程序而执行各种适当的动作和处理。在ram703中，还存储有系统700操作所需的各种程序和数据。cpu701、rom702以及ram703通过总线704彼此相连。输入/输出(i/o)接口705也连接至总线704。

以下部件连接至i/o接口705：包括键盘、鼠标等的输入部分706；包括诸如阴极射线管(crt)、液晶显示器(lcd)等以及扬声器等的输出部分707；包括硬盘等的存储部分708；以及包括诸如lan卡、调制解调器等的网络接口卡的通信部分709。通信部分709经由诸如因特网的网络执行通信处理。驱动器710也根据需要连接至i/o接口705。可拆卸介质711，诸如磁盘、光盘、磁光盘、半导体存储器等等，根据需要安装在驱动器710上，以便于从其上读出的计算机程序根据需要被安装入存储部分708。

特别地，根据本发明的实施例，上文主要步骤图描述的过程可以被实现为计算机软件程序。例如，本公开的实施例包括一种计算机程序产品，其包括承载在计算机可读介质上的计算机程序，该计算机程序包含用于执行主要步骤图所示的方法的程序代码。在这样的实施例中，该计算机程序可以通过通信部分709从网络上被下载和安装，和/或从可拆卸介质711被安装。在该计算机程序被中央处理单元(cpu)701执行时，执行本申请的系统中限定的上述功能。

需要说明的是，本申请所示的计算机可读介质可以是计算机可读信号介质或者计算机可读存储介质或者是上述两者的任意组合。计算机可读存储介质例如可以是——但不限于——电、磁、光、电磁、红外线、或半导体的系统、装置或器件，或者任意以上的组合。计算机可读存储介质的更具体的例子可以包括但不限于：具有一个或多个导线的电连接、便携式计算机磁盘、硬盘、随机访问存储器(ram)、只读存储器(rom)、可擦式可编程只读存储器(eprom或闪存)、光纤、便携式紧凑磁盘只读存储器(cd-rom)、光存储器件、磁存储器件、或者上述的任意合适的组合。在本申请中，计算机可读存储介质可以是任何包含或存储程序的有形介质，该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。而在本申请中，计算机可读的信号介质可以包括在基带中或者作为载波一部分传播的数据信号，其中承载了计算机可读的程序代码。这种传播的数据信号可以采用多种形式，包括但不限于电磁信号、光信号或上述的任意合适的组合。计算机可读的信号介质还可以是计算机可读存储介质以外的任何计算机可读介质，该计算机可读介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。计算机可读介质上包含的程序代码可以用任何适当的介质传输，包括但不限于：无线、电线、光缆、rf等等，或者上述的任意合适的组合。

附图中的流程图和框图，图示了按照本申请各种实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段、或代码的一部分，上述模块、程序段、或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个接连地表示的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图或流程图中的每个方框、以及框图或流程图中的方框的组合，可以用执行规定的功能或操作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。

描述于本申请实施例中所涉及到的模块可以通过软件的方式实现，也可以通过硬件的方式来实现。所描述的模块也可以设置在处理器中，例如，可以描述为：一种处理器包括获取模块和注册模块。其中，这些模块的名称在某种情况下并不构成对该模块本身的限定，例如，注册模块还可以被描述为“对所述可调用http接口进行代理注册的模块”。

作为另一方面，本申请还提供了一种计算机可读介质，该计算机可读介质可以是上述实施例中描述的设备中所包含的；也可以是单独存在，而未装配入该设备中。上述计算机可读介质承载有一个或者多个程序，当上述一个或者多个程序被一个该设备执行时，使得该设备包括：

步骤s101：当客户端启动时，根据配置类路径和包路径对http接口进行扫描，获取可调用http接口。

步骤s102：对可调用http接口进行代理注册。

根据本发明实施例的技术方案，因为采用http接口调用服务面向接口编程、定义业务接口，即先把客户端所依赖远程服务端的业务提取出来作为接口，远程服务端的业务具体实现通过该接口的实现类来完成，当实现类的方法逻辑发生变化时，只需重新编写该业务逻辑的实现类，而不需要改写客户端接口现有代码，减少对系统的影响；同时，采用基于接口编程的项目，业务逻辑清晰，代码易懂，方便扩展，可维护性强；进一步地，面向接口编程不需要改变开发人员的开发习惯，极大提高了推广上面的效率，在项目的可维护性和可阅读性方面上大大降低了维护成本，从而在人力、时间成本方面有效的解决了浪费。

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