CN104283919B

CN104283919B - 一种接口调用系统及方法

Info

Publication number: CN104283919B
Application number: CN201310282125.3A
Authority: CN
Inventors: 刘志阳; 高斌; 黎星
Original assignee: ZTE Corp
Current assignee: ZTE Corp
Priority date: 2013-07-05
Filing date: 2013-07-05
Publication date: 2019-11-05
Anticipated expiration: 2033-07-05
Also published as: US20160371129A1; CN104283919A; WO2015000314A1; EP3018577A1; EP3018577A4; US9898352B2

Abstract

本发明公开一种接口调用系统及方法，涉及企业管理领域。系统包括：接口管理模块，用于根据用户对接口的更改需求生成一描述文件以及接口的调用过程指示，并将所述描述文件以及调用过程指示部署至接口执行模块；其中，所述描述文件包括所述接口的配置替换信息；接口执行模块，用于根据所述描述文件对所述接口进行配置，并按照所述调用过程指示对所述接口进行调用。本发明的方案能够实现一个接口在不同系统之间的进行数据交互，从而提供高了办公效率。此外本发明的系统结构简单，方法易行，因此能够节省企业对系统的投入成本。

Description

一种接口调用系统及方法

技术领域

本发明涉及企业管理领域，提供一种接口调用系统及方法。

背景技术

在企业中（特别是电信级企业），通常会使用来不同提供商的软件系统配合工作，而一个提供商的软件系统经常需要以接口方式访问其它提供商的数据，因此会出现以下问题：

1．每个提供商的软件系统之间需要的接口访问协议不尽相同，因此需要针对每个协议配置不同的接口，因此维护成本很高。

2．缺乏对接口的实时监控，一旦接口访问出现异常，无法及时通知接口调用者的维护人员，使得定位和解决问题速度慢。

发明内容

本发明要解决的技术问题是提供一种接口调用系统及方法，能够将接口的访问组件以及协议进行调用。

为解决上述技术问题，本发明的实施例提供一种接口调用系统，包括：

接口管理模块，用于根据用户对接口的更改需求生成一描述文件以及接口的调用过程指示，并将所述描述文件以及调用过程指示部署至接口执行模块；其中，所述描述文件包括所述接口的配置替换信息；

接口执行模块，用于根据所述描述文件对所述接口进行配置，并按照所述调用过程指示对所述接口进行调用。

其中，所述接口管理模块具体包括：

信息管理子模块，用于通过界面向用户提供所述接口的当前配置信息以及接口能够调用的配置信息，并获取用户录入的接口的配置更改信息；其中，所述配置更改信息包括接口的访问组件替换信息、协议替换信息；

接口配置子模块，用于根据所述配置更改信息生成所述描述文件，并为所述接口制定所述调用过程指示；

接口部署子模块，用于向所述接口执行模块部署所述描述文件以及所述调用过程指示。

其中，所述接口执行模块具体包括：解析子模块、调用子模块以及不少于一个的执行引擎；

其中，解析子模块用于：将所述描述文件进行解析并生成接口调用代码；所述调用子模块用于：根据所述执行引擎的负荷状态选取一个目标执行引擎，并将所述接口调用代码以及所述调用过程指示发送至所述目标执行引擎；所述执行引擎用于：在被选取为目标执行引擎时，根据接口调用代码配置并调用所述接口，并根据所述调用过程指示对所述接口进行调用。

其中，所述系统还包括：

日志库，用于记录所述接口执行模块产生的数据日志。

其中，所述系统还包括：

监控告警模块，用于监控所述日志库中保存的数据，当确定数据出现异常时进行告警。

本发明的实施例还提供一种接口调用方法，包括：

根据用户对接口的更改需求生成一描述文件以及接口的调用过程指示，并将所述描述文件以及调用过程指示部署至接口执行模块；其中，所述描述文件包括所述接口的配置替换信息；

根据所述描述文件对所述接口进行配置，并按照所述调用过程指示对所述接口进行调用。

其中，根据用户对接口的更改需求生成一描述文件以及接口的调用过程指示的步骤包括：

通过界面向用户提供所述接口的当前配置信息以及接口能够调用的配置信息，并获取用户录入的接口的配置更改信息；其中，所述配置更改信息包括接口的访问组件替换信息、协议替换信息；根据所述配置更改信息生成所述描述文件。

根据所述配置更改信息生成所述描述文件，并为所述接口制定所述调用过程指示。

其中，根据所述描述文件对所述接口进行配置，并按照所述调用过程指示对所述接口进行调用的步骤包括：

提供若干个执行引擎；

将所述描述文件进行解析并生成接口调用代码；

根据所述执行引擎的负荷状态选取一个目标执行引擎，并将所述接口调用代码以及所述调用过程指示发送至所述目标执行引擎，从而使得所述目标执行引擎能够根据接口调用代码配置并调用所述接口，并根据所述调用过程指示对所述接口进行调用。

其中，所述方法还包括：

记录所述接口执行模块产生的数据日志。

其中，所述方法还包括：

监控所述数据日志，当确定数据出现异常时进行告警。

本发明的方案具有以下优点：

本发明的系统及方法根据用户需求对接口进行重新配置，在接口重新配置之后进行调用，更改接口的访问组件，从而在企业办公中，实现不同系统之间的数据交互，提供高了办公效率。此外本发明的系统结构简单，方法易行，因此能够节省企业对系统的投入成本。

附图说明

图1为本发明中接口调用系统的构架示意图；

图2为本发明中接口调用方法的步骤示意图；

图3为本发明中根据用户对接口的更改需求生成一描述文件以及接口的调用过程指示的具体步骤图；

图4为本发明中根据所述描述文件对所述接口进行配置，并按照所述调用过程指示对所述接口进行调用的具体步骤图；

图5为本发明中数据接口调用方法的另一步骤示意图；

具体实施方式

为使本发明要解决的技术问题、技术方案和优点更加清楚，下面将结合附图及具体实施例进行详细描述。

如图1所示，一种，接口调用系统，包括：

接口管理模块100，用于根据用户对接口的更改需求生成一描述文件以及接口的调用过程指示，并将所述描述文件以及调用过程指示部署至接口执行模块200；其中，所述描述文件包括所述接口的配置替换信息；

接口执行模块200，用于根据所述描述文件对所述接口进行配置，并按照所述调用过程指示对所述接口进行调用

上述系统根据用户需求对接口进行重新配置，在接口重新配置之后进行调用，更改接口的访问组件，从而在企业办公中，实现不同系统之间的数据交互，提供高了办公效率。此外本发明的系统结构简单，能够节省企业对系统的投入成本。

如图1所示，在本发明的上述实施例中，所述接口管理模块100具体包括：

信息管理子模块101，用于通过界面向用户提供所述接口的当前配置信息以及接口能够调用的配置信息，并获取用户录入的接口的配置更改信息；其中，所述配置更改信息包括接口的访问组件替换信息、协议替换信息；

接口配置子模块102，用于根据所述配置更改信息生成所述描述文件，并为所述接口制定所述调用过程指示；

接口部署子模块103，用于向所述接口执行模块部署所述描述文件以及所述调用过程指示。

如图1所示，在本发明的上述实施例中，所述接口执行模块200具体包括：解析子模块201、调用子模块202以及不少于一个的执行引擎203；

其中，解析子模块201用于：将所述描述文件进行解析并生成接口调用代码；所述调用子模块202用于：根据所述执行引擎203的负荷状态选取一个目标执行引擎，并将所述接口调用代码以及所述调用过程指示发送至所述目标执行引擎；所述执行引擎203用于：在被选取为目标执行引擎时，根据接口调用代码配置并调用所述接口，并根据所述调用过程指示对所述接口进行调用。

针对企业而言，往往同一时刻需要多个接口在不同系统组件之间完成不同的访问任务，因此本实施例配置多个执行引擎，调用子模块将接口调用代码以及调用过程指示分配给相对空闲的执行引擎，从而证多接口调度任务能得到有序合理地执行。

如图1所示，在本发明的上述实施例中，所述系统还包括：

日志库300，用于记录所述接口执行模块200产生的数据日志。

由于接口的配置以及具体调度过程都由接口执行模块200执行，因此本实施例的日志库400通过记录执行模块200产生的数据日志（如接口调用的性能、流量）可以为以后的系统优化以及至产品质量提升提供有效的依据。

如图1所示，在本发明的上述实施例中，所述系统还包括：

监控告警模块400，用于监控所述日志库400中保存的数据，当确定数据出现异常时进行告警。

本实施例的监控告警模块400对数据日志进行监控和分析，如果接口的调用过程指示发生异常（比如网络质量、执行平均执行时间达到预警值或者接口发生故障），则即时通知管理人员，以便于及时解决问题。

下面对本发明的系统进行详细描述：

本实施例的系统如图1所示，分为接口管理模块100、接口执行模块200、

日志库300、监控告警模块四部分。

其中接口管理模块100主要包含信息管理子模块101、接口配置子模块102、接口部署子模块103。所述信息管理子模块101，其以显示屏为载体通过界面向用户提供当前接口的配置信息（如接口的厂家描述信息、协议类型、通用资源标识符URI地址、方法描述、入参和出参描述等），此外还可提供接口调用者（即用户）信息（如调用者描述信息、期望访问接口使用的协议等）的注册和接口状态管理功能。

所述接口配置子模块102主要提供根据用户所需要的接口配置信息生成接口的调用过程指示以及接口的配置更改信息。其中，用户在界面中通过拖拽组件方式选择需要更改的接口配置：

如调用过程指示具体是访问数据库以进行存储时，用户可在界面中拖拽数据库接口访问所涉及到的配置组件以进行自定义选择（如配置数据库IP地址、数据库端口、数据库实例名、访问用户和密码、存储过程入参名称和入参数据类型、出参名称和出参数据类型等信息），上述配置完成后，接口配置子模块102将其制成XML的描述文件（XML，可扩展标记语言）。此外，用户还可以在界面上拖拽协议替换组件，来选择接口需要应用的协议（比如用户期望使用HTTP协议访问此数据库存储过程，则在界面上找到HTTP协议的相关组件，将其拖拽到接口的配置更改信息的项目栏中，接口配置子模块102开始配置接口转换后的http方法名称、http方法出入参和存储过程出入参的映射关系等信息）。同样，接口配置子模块102将这些HTTP协议替换信息制作进上述同一个XML描述文件中。最后接口配置子模块102为所述接口制定具体的调用过程指示：如更改接口访问组件的实施过程。

所述接口部署子模块103提供热部署功能，用户在通过界面上传接口配置子模块102所生成的XML描述文件以及调用过程指示后，点击部署按钮，接口部署子模块103就会将XML描述文件以及调用过程指示部署至接口执行模块200。

接口执行模块200主要包括解析子模块201、调用子模块202、若干个执行引擎203。

所述解析子模块201用于解析来自接口部署子模块的XML文件，并生成执行引擎203能够读取的接口调用代码。

所述调用子模块202充当接口调用过程指示的中间者，根据每个执行引擎203的负载状况，随时调整负载的分配原则，将接口调用代码以及调用过程指示绑定到负载小的执行引擎203上，并将执行引擎203返回的执行结果通过显示屏上传给用户。

所述执行引擎203，在接收调用子模块202传递过来的接口调用代码后，对接口进行配置，之后按照调用过程指示对所述接口进行调用并将执行结果返回给调用子模块202。当系统需要访问的接口较多时，可启动多个执行引擎203。

日志库300记录接口执行模块200中各个子模块产生的日志数据。

监控告警模块400主要根据日志库300中的日志数据分析接口运行状况，一旦发现接口调用过程指示中出现异常（比如网络质量、执行平均执行时间达到预警值或者接口故障等），能够根据事先配置好的消息模板生成告警信息，将告警信息通过多媒体发送渠道（比如下发短信、发送邮件等等）及时推送给维护人员，便于维护人员迅速处理故障或者提前做好故障防备措施。此外，用户还可以通过信息管理子模块101在界面实时观察接口的调用状况。

总上所述，本实施例的系统具有以下优点：

1．提供可视化接口信息配置，在界面中设置接口调用所需的配置信息（包括但不限于接口访问信息、接口协议转换信息），配置完成后系统自动生成XML文件。

2．提供接口应用热部署方式，将XML文件加载到后台，通过后台解析XML描述文件并调用第三方接口，从而能够适应企业里贷规模的接口调用工作；另一方面将接口的协议替换成用户期望的协议，方便调用者使用。

3．能够及时防线接口调用发生的异常，并即时通知维护人员。此外，维护人员还可以对日志数据进行分析，找出接口应用的优化方案，从而不断提升产品质量以及用户满意度。

此外，如图2所示，本发明的实施例还提供一种接口调用方法，包括：

步骤A，根据用户对接口的更改需求生成一描述文件以及接口的调用过程指示，并将所述描述文件以及调用过程指示部署至接口执行模块；其中，所述描述文件包括所述接口的配置替换信息；

步骤B，根据所述描述文件对所述接口进行配置，并按照所述调用过程指示对所述接口进行调用。

上述方法根据用户需求对接口进行重新配置，在接口重新配置之后进行调用，更改接口的访问组件，从而在企业办公中，实现不同系统之间的数据交互，提供高了办公效率。此外本发明的方法简单易行，因此能够节省企业对系统的投入成本。

进一步地，如图3所示，在本发明的上述实施例中，步骤A具体包括：

步骤A1，通过界面向用户提供所述接口的当前配置信息以及接口能够调用的配置信息，并获取用户录入的接口的配置更改信息；其中，所述配置更改信息包括接口的访问组件替换信息、协议替换信息；根据所述配置更改信息生成所述描述文件。

步骤A2，根据所述配置更改信息生成所述描述文件，并为所述接口制定所述调用过程指示。

进一步地，如图4所示，在本发明的上述实施例中，步骤B具体包括：

步骤B1，提供若干个执行引擎；

步骤B2，将所述描述文件进行解析并生成接口调用代码；

步骤B3，根据所述执行引擎的负荷状态选取一个目标执行引擎，并将所述接口调用代码以及所述调用过程指示发送至所述目标执行引擎，从而使得所述目标执行引擎能够根据接口调用代码配置并调用所述接口，并根据所述调用过程指示对所述接口进行调用。

针对企业而言，往往同一时刻需要多个接口在不同系统组件之间完成不同的访问任务，因此本实施例配置多个执行引擎，将接口调用代码以及调用过程指示分配给相对空闲的执行引擎，从而能保证接口调度的稳定执行。

此外，为今后的系统优化以及至产品质量的提升提供支持，如图5所示，在本发明的上述实施例中，所述方法还包括：

步骤C，记录所述接口执行模块产生的数据日志。

此外，为了及时能够解决接口在调用过发生异常情况，如图5所示，在本发明的上述实施例中，所述方法还包括：

步骤D，监控所述数据日志，当确定数据出现异常时进行告警。

显然，上述实施例为本发明中一种接口调用系统对应的方法实施例，所述接口调用系统能达到的技术效果，本实施例的方法也同样能够达到。

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

Claims

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

接口执行模块，用于根据所述描述文件对所述接口进行配置，并按照所述调用过程指示对所述接口进行调用；

所述接口管理模块具体包括：

2.根据权利要求1所述的接口调用系统，其特征在于，所述接口执行模块具体包括：解析子模块、调用子模块以及不少于一个的执行引擎；

3.根据权利要求1或2所述的接口调用系统，其特征在于，所述系统还包括：

日志库，用于记录所述接口执行模块产生的数据日志。

4.根据权利要求3所述的接口调用系统，其特征在于，所述系统还包括：

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

根据所述描述文件对所述接口进行配置，并按照所述调用过程指示对所述接口进行调用；

根据用户对接口的更改需求生成一描述文件以及接口的调用过程指示的步骤包括：

通过界面向用户提供所述接口的当前配置信息以及接口能够调用的配置信息，并获取用户录入的接口的配置更改信息；其中，所述配置更改信息包括接口的访问组件替换信息、协议替换信息；根据所述配置更改信息生成所述描述文件；根据所述配置更改信息生成所述描述文件，并为所述接口制定所述调用过程指示。

6.根据权利要求5所述的接口调用方法，其特征在于，根据所述描述文件对所述接口进行配置，并按照所述调用过程指示对所述接口进行调用的步骤包括：

提供若干个执行引擎；

将所述描述文件进行解析并生成接口调用代码；

7.根据权利要求5或6所述的接口调用方法，其特征在于，所述方法还包括：

记录所述接口执行模块产生的数据日志。

8.根据权利要求7所述的接口调用方法，其特征在于，所述方法还包括：

监控所述数据日志，当确定数据出现异常时进行告警。