CN115827102A - 接口调用方法、装置、存储介质及电子装置 - Google Patents

Abstract

本申请公开了一种接口调用方法、装置、存储介质及电子装置，涉及智能家居/智慧家庭技术领域，该接口调用方法包括：根据配置的项目基础信息，确定待调用接口的目标项目；根据所述目标项目的基础信息，拉取所述目标项目的代码；根据所述目标项目的基础信息和所述目标项目的代码，得到待调用接口的名称；根据所述目标项目的基础信息和所述待调用接口的名称，生成对应的直连文件，对待调用接口进行调用。本发明解决了如何准确调用接口的技术问题。

Description

接口调用方法、装置、存储介质及电子装置

技术领域

本申请涉及智能家居/智慧家庭技术领域，具体而言，涉及一种接口调用方法、存储介质及电子装置。

背景技术

随着分布式应用的普及，一般选择Dubbo进行服务的管理，Dubbo是一款微服务框架，为大规模微服务实践提供高性能RPC通信、流量治理、可观测性等解决方案。

目前，基于Dubbo的项目在开发以及测试阶段需要接口的联调与测试，如果该项目依赖于其他部门的接口，开发人员不可避免的要接入测试环境并启动项目，那么开发人员启动的服务会注册到测试环境的Zookeeper(注册中心)，导致测试人员在测试接口功能时，会调用到开发人员启动的服务端，导致最终的测试结果异常。另外，本地开发人员想要调用本机的服务，例如开发人员修改了A服务的代码，想要通过Dubbo的方式直接调用本地A服务查看问题，但是由于当前环境下，Zookeeper中的服务注册列表中存在其他人启动的服务端，很大的可能性调用到别人的服务，导致开发及测试效率低下。

发明内容

为了克服上述缺陷，提出了本发明，以提供解决或至少部分地解决如何准确调用接口的技术问题的一种接口调用方法、装置、存储介质及电子装置。

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

根据配置的项目基础信息，确定待调用接口的目标项目；

根据所述目标项目的基础信息，拉取所述目标项目的代码；

根据所述目标项目的基础信息和所述目标项目的代码，得到待调用接口的名称；

根据所述目标项目的基础信息和所述待调用接口的名称，生成对应的直连文件，对待调用接口进行调用。

在上述接口调用方法的一个技术方案中，

所述方法还包括：根据所述目标项目和目标项目中各开发分支号，选择当前开发分支；

所述根据所述目标项目的基础信息，拉取所述目标项目的代码，包括：根据所述目标项目的基础信息，拉取所述当前开发分支的代码；

所述根据所述目标项目的基础信息和所述目标项目的代码，得到待调用接口的名称，包括：根据所述目标项目的基础信息和所述当前开发分支的代码，得到当前开发分支中待调用接口的名称。

在上述接口调用方法的一个技术方案中，

所述方法还包括：对项目基础信息进行配置，其中所述项目基础信息包括：项目名称、git地址、Dubbo端口号和接口相对路径；

所述根据配置的项目基础信息，确定待调用接口的目标项目，包括：根据配置的所述项目名称，确定待调用接口的目标项目。

在上述接口调用方法的一个技术方案中，

所述根据所述目标项目的基础信息，拉取所述当前开发分支的代码，包括：根据所述目标项目的git地址，通过执行切换分支及获取代码命令拉取所述当前开发分支的代码。

在上述接口调用方法的一个技术方案中，

所述根据目标项目的基础信息和所述当前开发分支的代码，得到待调用接口的名称，包括：

根据所述目标项目的接口相对路径，扫描所述当前开发分支代码，得到待调用接口文件；

根据所述待调用接口文件，得到待调用接口的名称。

在上述接口调用方法的一个技术方案中，

所述根据所述目标项目的基础信息和所述当前开发分支的代码，得到当前开发分支中待调用接口的名称，包括：

将所述待调用接口的名称与Dubbo端口号及对应的接口相对路径组合，生成对应的直连文件；

通过所述直连文件对待调用接口进行调用。

在上述接口调用方法的一个技术方案中，

所述项目基础信息还包括远程ip地址；

所述方法还包括：通过执行远程文件拷贝命令将所述直连文件推送到目标远程服务器；

通过所述直连文件对目标远程服务器的待调用接口进行调用。

在第二方面，本发明提供一种接口调用装置，包括：存储器、一个或多个处理器、一个或多个应用程序，其中，所述一个或多个应用程序存储在所述存储器中，所述一个或多个应用程序被配置为由所述一个或多个处理器调用时，使得所述一个或多个处理器执行如第一方面任一项所述的方法。

在第三方面，本发明提供一种计算机可读的存储介质，所述计算机可读的存储介质包括存储的程序，其中，所述程序运行时执行第一方面中任一项所述的方法。

在第四方面，本发明提供一种电子装置，包括存储器和处理器，所述存储器中存储有计算机程序，所述处理器被设置为通过所述计算机程序执行第一方面中任一项所述的方法。

本发明上述一个或多个技术方案，至少具有如下一种或多种有益效果：

在实施本发明的技术方案中，通过动态配置的方式，一键生成直连文件，通过直连文件实现客户端与服务端的直连，操作简单，使开发和测试人员能够调用到正确的服务端；且本发明通过动态配置一键生成直连文件的方式，可以对整个项目的所有接口进行调用隔离配置，大大节省开发和测试的时间，提高了开发与测试的效率。

附图说明

此处的附图被并入说明书中并构成本说明书的一部分，示出了符合本申请的实施例，并与说明书一起用于解释本申请的原理。

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

图1是根据本申请实施例的一种接口调用方法的主要流程步骤示意图；

图2是根据本申请实施例的配置的项目列表示意图；

图3是根据本申请实施例的一种接口调用方法的硬件环境示意图；

图4是根据本申请实施例的一种接口调用方法在硬件环境中运行的时序示意图。

具体实施方式

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

需要说明的是，本申请的说明书和权利要求书及上述附图中的术语“第一”、“第二”等是用于区别类似的对象，而不必用于描述特定的顺序或先后次序。应该理解这样使用的数据在适当情况下可以互换，以便这里描述的本申请的实施例能够以除了在这里图示或描述的那些以外的顺序实施。此外，术语“包括”和“具有”以及他们的任何变形，意图在于覆盖不排他的包含，例如，包含了一系列步骤或单元的过程、方法、系统、产品或设备不必限于清楚地列出的那些步骤或单元，而是可包括没有清楚地列出的或对于这些过程、方法、产品或设备固有的其它步骤或单元。

目前，分布式应用场景下，项目的开发和测试需要进行接口调用，也即客户端从服务端调用所需的服务，在Dubbo框架下，服务启动后会注册到注册中心，而客户端与服务端之间通过注册中心的注册信息，可能会调用错注册中心提供的其他错误的服务端，如何指定需要调用的服务端成为急需解决的问题，如测试人员只想调用测试机(远端服务器)提供的服务，开发人员只想调用本机启动的服务(本地端服务)，目前往往有以下几种方式：测试人员联系开发人员让其关闭本机启动的服务、开发人员在代码中指定测试服务的调用的服务端ip以及开发人员手工修改JVM参数，进行接口调用直连；上述关闭本机服务器，可能会影响到开发的自测工作；在代码中指定服务端ip(如@Reference(url＝"localhost:20880"))的形式，代码侵入性高，存在误提代码，导致生产问题的风险，且效率低下；修改参数的方法，存在批量修改效率低下的问题。因此，亟需一种新的接口调用方法解决上述问题。

根据本申请实施例的一个方面，提供了一种接口调用方法。如图1所示，接口调用方法主要包括：

步骤S101：根据配置的项目基础信息，确定待调用接口的目标项目；

在本实施例中，可以对服务端的项目(应用开发中会包括若干项目)的基础信息进行配置，其中配置的项目基础信息包括：项目名称、git地址、Dubbo端口号和接口相对路径；具体的，根据项目名称从若干项目中选择待调用接口的目标项目，git地址用于后续拉取相应的代码，Dubbo端口号用于最终生成直连文件，接口相对路径用于在代码中找到所需的接口文件。

一个实施方式中，在Dubbo框架中，可以通过配置生成层(H5)对服务端项目进行基础信息配置；项目名称、git地址、Dubbo端口号和接口相对路径在开发过程中均存在且可查询，例如git是版本控制系统，通过git remote-v命令即可查看git地址；Dubbo端口号为指定服务端口，可以随意指定，只要本地未使用即可，最终形成配置好的项目列表，根据配置的项目列表，选择需要接口调用的目标项目，项目列表如图2所示，每条项目中，包括配置的基础信息，需要调用远程服务的则需要配置原值ip地址。

步骤S102：根据目标项目的基础信息，拉取目标项目的代码；

在本实施例中，可以根据目标项目的git地址，通过执行获取代码命令拉取目标项目的代码，Git是一个开源分布式版本控制系统，版本控制系统是一种记录一个或若干文件内容变化，以便将来查阅特定版本修订情况的系统，版本控制系统可以应用于软件源代码的文本文件，因此，可以通过Git中的命令来拉取目标项目代码。

一个实施方式中，同一个项目下包括若干开发分支，不同人员可能负责开发不同分支，不同分支的接口不同，因此根据选择的目标项目和分支号，可以选择当前开发分支，即当前需要调用接口的开发分支，进行环境隔离(隔离其他开发分支的服务)；可以根据目标项目的git地址，通过执行切换分支及获取代码命令拉取当前开发分支的代码，Git不仅可以应用于软件源代码的文本文件，而且可以对任何类型的文件进行版本控制，因此，可以通过Git中的命令来切换到当前开发分支，并从当前开发分支里获取代码，具体的，可以利用processbuilder执行shell脚本，命令为git check out：迁出一个分支的特定版本、即切换到当前开发分支，以及gitpull：用于获取代码，即得到当前开发分支的代码。

步骤S103：根据所述目标项目的基础信息和所述目标项目的代码，得到待调用接口的名称；

在本实施例中，可以通过目标项目的接口相对路径，扫描git地址拉取的代码，获得待调用接口文件，从而在待调用接口文件中得到待调用接口的名称。

一个实施方式中，可以通过目标项目的接口相对路径，扫描git地址拉取的当前开发分支的代码，获得待调用接口文件，从而在待调用接口文件中得到待调用接口的名称，即具体开发分支中对应的接口。

一个实施方式中，通过接口相对路径扫描当前系项目分支的代码，可以一次性获取所有待调用接口，不必一一配置，大大节省开发与测试的时间。

步骤S104：根据目标项目的基础信息和待调用接口的名称，生成对应的直连文件，对待调用接口进行调用。

在本实施例中，根据步骤S103中获得的待调用接口名称，与Dubbo端口号及对应的接口相对路径组合，生成对应的直连文件，通过直连文件对接口进行调用，完成指定服务的获取。生成的对应的直连文件形式，可以命名直连文件为dubbo-resolve.properties，例如，dubbo-resolve.properties包括：

com.xxxxx.xxxx.api.H5CacheApi＝dubbo://localhot:20889

com.xxxxx.xxxx.api.LastTransferAssessSiteApi＝dubbo://localhot:20889

com.xxxxx.xxxx.api.OrgReceiveSendConfigApi＝dubbo://localhot:20889

com.xxxxx.xxxx.api.OrderExpressApi＝dubbo://localhot:20889

com.xxxxx.xxxx.api.PenaltyTransferSettleApi＝dubbo://localhot:20889

其中，“com.xxxxx.xxxx”表示接口相对路径；“H5CacheApi”、“LastTransferAssessSiteApi”、“OrgReceiveSendConfigApi”、“OrderExpressApi”及“PenaltyTransferSettleApi”表示待调用接口的名称，需要说说明的是，这里列举了5个接口，实际使用时，可以包括若干个接口或至少一个接口，生成直连文件；“20880”为指定Dubbo端口。

在一个实施方式中，若需要调用远程服务器接口，则项目基础信息在配置时还需要包括远程服务端的ip地址，调用时，将本地服务端生成的直连文件，利用rocessbuilder执行shell脚本的形式，执行命令scp(scp是linux系统下基于ssh登陆进行安全的远程文件拷贝命令)将直连文件传输至远程服务器，实现指定远程服务调用。

在一个实施方式中，直连文件dubbo-resolve.properties的路径可以是${user.home}/dubbo-resolve.properties，其中${user.home}指的是当前用户的home目录dubbo-resolve.properties是生成的直连文件，进行调用的服务可以为“com.xxx.XxxService＝dubbo://10.20.153.10:20880”，其中“com.xxx.XxxService”为服务名，“dubbo://10.20.153.10:20880”为请求地址，“10.20.153.10”为ip地址，无论采用JVM参数的形式(java-Dcom.xxxXxxService＝dubbo://10.20.153.10:20880)或者Reference(<dubbo:reference url＝“dubbo://10.20.153.10:20880”/)配置的形式，都无法批量的进行接口的调用隔离，而采用本发明方法，直连文件一键生成，可一键对整个项目的所有接口进行调用隔离配置，大大节省开发与测试的时间。

可选地，在本实施例中，上述接口调用方法可以应用于如图3所示的由本地设备10和远程服务设备20所构成的硬件环境中，应用过程如图4所示的时序图，其中本地设备10包括客户端11和服务端12，远程服务设备20包括远程服务端21；如图3所示，本地设备10通过网络与远程服务设备20进行连接，可用于为本地设备或本地设备上安装的客户端提供服务(如应用服务等)，可在各服务端上或独立于服务端设置数据库，用于为服务端提供数据存储服务，可在服务端上或独立于服务端配置云计算和/或边缘计算服务，用于为服务端提供数据运算服务。

具体的，由客户端11通过本地配置生成层(h5)对服务端12内的项目进行基础信息配置，配置的基础信息包括项目名、git地址，接口相对地址、Dubbo端口(若调用远程服务，需要配置远程ip地址)，服务端12返回配置好的项目列表，用户在客户端根据项目名选择需要接口调用的项目，进入项目，填写当前开发分支的分支号，一键环境隔离(隔离其他项目及分支服务)；本地服务端根据分支号和git地址，拉取当前开发分支的代码，根据接口相对路径，扫描代码，获取接口名称，然后组合接口相对地址、Dubbo端口号等信息，生成dubbo直连文件，选择服务端12服务，可通过直连文件进行文件下载；若选择测试环境，即需要调用远程服务端21服务，本地服务端会将生成的文件利用scp命令传输至远程测试服务器，实现远程服务调用隔离。

基于上述步骤S101-步骤S104，本发明实施例通过动态配置的方式，一键生成直连文件，通过直连文件实现客户端与服务端的直连，操作简单，使开发和测试人员能够调用到正确的服务端；且本发明通过动态配置一键生成直连文件的方式，可以对整个项目的所有接口进行调用隔离配置，大大节省开发和测试的时间，提高了开发与测试的效率。

需要指出的是，尽管上述实施例中将各个步骤按照特定的先后顺序进行了描述，但是本领域技术人员可以理解，为了实现本发明的效果，不同的步骤之间并非必须按照这样的顺序执行，其可以同时(并行)执行或以其他顺序执行，这些变化都在本发明的保护范围之内。

进一步，本发明还提供了一种接口调用装置，包括存储器、一个或多个处理器、一个或多个应用程序，其中，所述一个或多个应用程序存储在所述存储器中，所述一个或多个应用程序被配置为由所述一个或多个处理器调用时，使得所述一个或多个处理器执行如上步骤S101-S104技术方案所述的方法。

本发明实施例中的装置主要包括存储器和处理器，存储器可以被配置成存储执行上述方法实施例的接口调用方法的程序，处理器可以被配置成用于执行存储器中的程序，该程序包括但不限于执行上述方法实施例的接口调用方法的程序。为了便于说明，仅示出了与本发明实施例相关的部分，具体技术细节未揭示的，请参照本发明实施例方法部分。

在本发明实施例中装置可以是包括各种电子设备形成的控制装置。在一些可能的实施方式中，装置可以包括多个存储装置和多个处理器。而执行上述方法实施例的接口调用方法的程序可以被分割成多段子程序，每段子程序分别可以由处理器加载并运行以执行上述方法实施例的接口调用方法的不同步骤。具体地，每段子程序可以分别存储在不同的存储器中，每个处理器可以被配置成用于执行一个或多个存储器中的程序，以共同实现上述方法实施例的接口调用方法，即每个处理器分别执行上述方法实施例的接口调用方法的不同步骤，来共同实现上述方法实施例的接口调用方法。

上述多个处理器可以是部署于同一个设备上的处理器，例如上述计算机设备可以是由多个处理器组成的高性能设备，上述多个处理器可以是该高性能设备上配置的处理器。此外，上述多个处理器也可以是部署于不同设备上的处理器，例如上述计算机设备可以是服务器集群，上述多个处理器可以是服务器集群中不同服务器上的处理器。

上述接口调用装置以用于执行图1所示的接口调用方法实施例，两者的技术原理、所解决的技术问题及产生的技术效果相似，本技术领域技术人员可以清楚地了解到，为了描述的方便和简洁，装置的具体工作过程及有关说明，可以参考接口调用方法的实施例所描述的内容，此处不再赘述。

本领域技术人员能够理解的是，本发明实现上述一实施例的方法中的全部或部分流程，也可以通过计算机程序来指令相关的硬件来完成，所述的计算机程序可存储于一计算机可读存储介质中，该计算机程序在被处理器执行时，可实现上述各个方法实施例的步骤。其中，所述计算机程序包括计算机程序代码，所述计算机程序代码可以为源代码形式、对象代码形式、可执行文件或某些中间形式等。所述计算机可读存储介质可以包括：能够携带所述计算机程序代码的任何实体或装置、介质、U盘、移动硬盘、磁碟、光盘、计算机存储器、只读存储器、随机存取存储器、电载波信号、电信信号以及软件分发介质等。需要说明的是，所述计算机可读存储介质包含的内容可以根据司法管辖区内立法和专利实践的要求进行适当的增减，例如在某些司法管辖区，根据立法和专利实践，计算机可读存储介质不包括电载波信号和电信信号。

进一步，本发明还提供了一种电子装置。在根据本发明的一个电子装置实施例中，电子装置包括处理器和存储装置，存储装置可以被配置成存储执行上述方法实施例的接口调用方法的程序，处理器可以被配置成用于执行存储装置中的程序，该程序包括但不限于执行上述方法实施例的接口调用方法的程序。为了便于说明，仅示出了与本发明实施例相关的部分，具体技术细节未揭示的，请参照本发明实施例方法部分。该电子装置可以是包括各种电子设备形成的装置设备。

进一步，本发明还提供了一种计算机可读存储介质。在根据本发明的一个计算机可读存储介质实施例中，计算机可读存储介质可以被配置成存储执行上述方法实施例的接口调用方法的程序，该程序可以由处理器加载并运行以实现上述的接口调用方法。为了便于说明，仅示出了与本发明实施例相关的部分，具体技术细节未揭示的，请参照本发明实施例方法部分。该计算机可读存储介质可以是包括各种电子设备形成的存储装置设备，可选的，本发明实施例中计算机可读存储介质是非暂时性的计算机可读存储介质。

本领域技术人员能够理解的是，可以对装置中的各个模块进行适应性地拆分或合并。对具体模块的这种拆分或合并并不会导致技术方案偏离本发明的原理，因此，拆分或合并之后的技术方案都将落入本发明的保护范围内。

进一步，应该理解的是，由于各个模块的设定仅仅是为了说明本发明的装置的功能单元，这些模块对应的物理器件可以是处理器本身，或者处理器中软件的一部分，硬件的一部分，或者软件和硬件结合的一部分。因此，各个模块的数量仅仅是示意性的，该方法广泛应用于智慧家庭(Smart Home)、智能家居、智能家用设备生态、智慧住宅(IntelligenceHouse)生态等全屋智能数字化控制应用场景。上述网络可以包括但不限于以下至少之一：有线网络，无线网络。上述有线网络可以包括但不限于以下至少之一：广域网，城域网，局域网，上述无线网络可以包括但不限于以下至少之一：WIFI(Wireless Fidelity，无线保真)，蓝牙。终端设可以并不限定于为PC、手机、平板电脑、智能空调、智能烟机、智能冰箱、智能烤箱、智能炉灶、智能洗衣机、智能热水器、智能洗涤设备、智能洗碗机、智能投影设备、智能电视、智能晾衣架、智能窗帘、智能影音、智能插座、智能音响、智能音箱、智能新风设备、智能厨卫设备、智能卫浴设备、智能扫地机器人、智能擦窗机器人、智能拖地机器人、智能空气净化设备、智能蒸箱、智能微波炉、智能厨宝、智能净化器、智能饮水机、智能门锁等。

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

Claims (10)

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

根据配置的项目基础信息，确定待调用接口的目标项目；

根据所述目标项目的基础信息，拉取所述目标项目的代码；

根据所述目标项目的基础信息和所述目标项目的代码，得到待调用接口的名称；

根据所述目标项目的基础信息和所述待调用接口的名称，生成对应的直连文件，对待调用接口进行调用。

2.根据权利要求1所述的接口调用方法，其特征在于，

所述方法还包括：根据所述目标项目和目标项目中各开发分支号，选择当前开发分支；

所述根据所述目标项目的基础信息，拉取所述目标项目的代码，包括：根据所述目标项目的基础信息，拉取所述当前开发分支的代码；

所述根据所述目标项目的基础信息和所述目标项目的代码，得到待调用接口的名称，包括：根据所述目标项目的基础信息和所述当前开发分支的代码，得到当前开发分支中待调用接口的名称。

3.根据权利要求2所述的接口调用方法，其特征在于，

所述方法还包括：对项目基础信息进行配置，其中所述项目基础信息包括：项目名称、git地址、Dubbo端口号和接口相对路径；

所述根据配置的项目基础信息，确定待调用接口的目标项目，包括：根据配置的所述项目名称，确定待调用接口的目标项目。

4.根据权利要求3所述的接口调用方法，其特征在于，

所述根据所述目标项目的基础信息，拉取所述当前开发分支的代码，包括：根据所述目标项目的git地址，通过执行切换分支及获取代码命令拉取所述当前开发分支的代码。

5.根据权利要求3所述的接口调用方法，其特征在于，

所述根据所述目标项目的基础信息和所述当前开发分支的代码，得到当前开发分支中待调用接口的名称，包括：

根据所述目标项目的接口相对路径，扫描所述当前开发分支代码，得到待调用接口文件；

根据所述待调用接口文件，得到待调用接口的名称。

6.根据权利要求3所述的接口调用方法，其特征在于，

所述根据所述目标项目的基础信息和所述待调用接口的名称，生成对应的直连文件，对待调用接口进行调用，包括：

将所述待调用接口的名称与Dubbo端口号及对应的接口相对路径组合，生成对应的直连文件；

通过所述直连文件对待调用接口进行调用。

7.根据权利要求3-6中任一项所述的接口调用方法，其特征在于，

所述项目基础信息还包括远程ip地址；

所述方法还包括：通过执行远程文件拷贝命令将所述直连文件推送到目标远程服务器；

通过所述直连文件对目标远程服务器的待调用接口进行调用。

8.一种接口调用装置，其特征在于，包括：存储器、一个或多个处理器、一个或多个应用程序，其中，所述一个或多个应用程序存储在所述存储器中，所述一个或多个应用程序被配置为由所述一个或多个处理器调用时，使得所述一个或多个处理器执行如权利要求1-7中任一项所述的方法。

9.一种计算机可读的存储介质，其特征在于，所述计算机可读的存储介质包括存储的程序，其中，所述程序运行时执行权利要求1至7中任一项所述的方法。

10.一种电子装置，包括存储器和处理器，其特征在于，所述存储器中存储有计算机程序，所述处理器被设置为通过所述计算机程序执行权利要求1至7中任一项所述的方法。

Images