CN111090423A - 一种webhook框架系统和实现主动调用、实现事件触发的方法 - Google Patents

Abstract

本发明公开了一种webhook框架系统和实现主动调用、实现事件触发的方法，涉及计算机技术领域。其中系统包括：代码编辑器，用于支持通过lua语言编写webhook代码；存储模块，用于根据资源标识存储所述webhook代码；其中，所述资源标识用于唯一标识webhook代码；执行模块，用于在接收到对所述系统的调用时，在所述存储模块中确定对应的第一webhook代码并执行。该系统能够支持lua编程语言，同时也支持主动调用和事件触发，并且非常轻量化，不需要初始化等步骤。

Description

一种webhook框架系统和实现主动调用、实现事件触发的方法

技术领域

本发明涉及计算机技术领域，尤其涉及一种webhook框架系统和实现主动调用、实现事件触发的方法。

背景技术

对于当下流行的微服务(一个或者一组相对较小且独立的功能单元)，openfaas的开源项目faas和阿里云的函数计算类似，两者都是提供了一个代码的运行环境，开发人员只需要专注于编写代码，不需要针对这些代码再做服务的运维工作。以及，另一个开源的API网关服务kong支持以lua语言(Lua是一个小巧的脚本语言)编写插件的形式提供函数计算功能，其主要目标是对API的生命周期管理，像webhook这类可以带有明显的业务属性的功能不适合由kong去托管。

但是，阿里云的函数计算和faas不支持lua语言进行开发。kong的插件虽然支持lua语言，但其主要是以插件的方式提供该功能，不支持事件触发。

发明内容

有鉴于此，本发明实施例提供一种webhook框架系统和实现主动调用、实现事件触发的方法，能够支持lua编程语言，同时也支持主动调用和事件触发，并且非常轻量化，不需要初始化等步骤。

为实现上述目的，根据本发明实施例的一个方面，提供webhook框架系统。

本发明实施例的webhook框架系统的运行环境为openresty平台，其特征在于，包括：代码编辑器，用于支持通过lua语言编写webhook代码；存储模块，用于根据资源标识存储所述webhook代码；其中，所述资源标识用于唯一标识webhook代码；执行模块，用于在接收到对所述系统的调用时，在所述存储模块中确定对应的第一webhook代码并执行。

可选地，所述代码编辑器包括编辑单元和检查单元，所述编辑单元用于支持通过lua语言编写webhook代码，所述检查单元用于对所述webhook代码进行代码检查；其中，所述代码检查至少包括语法检查或代码安全检查。

可选地，所述代码编辑器还包括触发方式设置单元，用于根据用途设置事件的触发方式。

可选地，所述代码编辑器还包括执行次数设置单元，用于设置所述事件的触发对应的第二webhook代码的执行次数；则

所述存储模块还用于，将所述第二webhook代码的执行次数存储在所述事件的观察列表中。

可选地，所述存储模块包括标识生成单元和存储数据库，所述标识生成单元用于生成所述webhook代码的资源标识，所述存储数据库用于根据所述资源标识存储所述webhook代码。

可选地，还包括反馈模块，用于将执行结果返回至调用端。

为实现上述目的，根据本发明实施例的另一个方面，提供了一种根据上述任一项实施例webhook框架系统实现主动调用的方法。

本发明实施例的实现主动调用的方法包括：获取调用端上传的调用标识和执行参数；根据所述调用标识在所述存储模块查询对应的目标webhook代码并加载；所述执行模块根据所述执行参数执行所述目标webhook代码，得到目标结果；将所述目标结果返回至所述调用者。

为实现上述目的，根据本发明实施例的另一个方面，提供了一种根据上述任一项实施例webhook框架系统实现事件触发的方法。

本发明实施例的实现事件触发的方法包括：基于事件触发接口的调用，确定事件源；确定所述事件源的代码标识列表，所述代码标识列表中至少包括一个代码标识；所述执行模块根据所述代码列表，在所述存储模块依次查找对应的webhook代码并执行。

可选地，根据所述代码列表依次查找对应webhook代码并执行的步骤包括：根据所述代码列表依次查找对应的待执行webhook代码以及待执行webhook代码的执行次数；根据所述待执行webhook代码的执行次数，执行所述待执行webhook代码。

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

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

为实现上述目的，根据本发明实施例的再一个方面，提供了一种计算机可读介质，其上存储有计算机程序，其特征在于，所述程序被处理器执行时实现上述任一项的方法。

上述发明中的一个实施例具有如下优点或有益效果：由于openresty本身就支持lua编程语言，同时也支持主动调用和事件触发执行注册的webhook。开发者只需要将编写好的lua代码上传至服务器，并选择触发方式，服务器存储好代码并且会一个标识，后续只需要使用这个标识就可以重复的调用webhook代码了。并且只需要开源的openresty作为运行环境以及一个可以存储代码的介质，整个方案非常轻量化，相比于现有技术需要容器启动和初始化的过程，不需要该初始化步骤，整个function启动的初始化工作更快。

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

附图说明

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

图1是根据本发明实施例的webhook框架系统的主要模块的示意图；

图2是根据本发明实施例的webhook框架系统上传代码流程的示意图；

图3是根据本发明实施例的webhook框架系统基于openresty的函数计算流程的示意图；

图4是根据本发明实施例的webhook框架系统实现主动调用的方法的示意图；

图5是根据本发明实施例的webhook框架系统实现事件触发的方法的示意图；

图6是本发明实施例可以应用于其中的示例性系统架构图；

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

具体实施方式

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

图1是根据本发明实施例的webhook框架系统的主要模块的示意图，如图1所示，本发明实施例的webhook框架系统100的主要模块包括代码编辑器101、存储模块102、执行模块103。

代码编辑器101用于，支持通过lua语言编写webhook代码。其中，Lua是一个小巧的脚本语言。以及，可通过在本发明实施例的webhook框架系统的对话定制平台上，可以集成技能定制的资源调用，以支持lua语言编写要实现的功能webhook代码。

存储模块102用于，根据资源标识存储webhook代码；其中，资源标识用于唯一标识webhook代码。Webhook为用户自定义的HTTP回调函数(user-defined HTTP回调)。webhooks是一个api概念，是微服务api的使用范式之一，也被成为反向api，即：前端不主动发送请求，完全由后端推送。举个常用例子，比如你的好友发了一条朋友圈，后端将这条消息推送给所有其他好友的客户端，就是Webhooks的典型场景。在web开发过程中的webhook，是一种通过通常的callback，去增加或者改变web page或者web app行为的方法。这些callback可以由第三方用户和开发者维持当前，修改，管理，而这些使用者与网站或者应用的原始开发没有关联。

执行模块103用于，在接收到对系统的调用时，在存储模块中确定对应的第一webhook代码并执行。

openresty是一个基于Nginx与Lua的高性能Web平台，其内部集成了大量精良的Lua库、第三方模块以及大多数的依赖项。用于方便地搭建能够处理超高并发、扩展性极高的动态Web应用、Web服务和动态网关。本发明实施例的webhook框架系统，由于基于openresty实现，而openresty本身就支持lua编程语言，同时也支持主动调用和事件触发执行注册的webhook。开发者只需要将编写好的lua代码上传至服务器，并选择触发方式，服务器存储好代码并且会一个标识，后续只需要使用这个标识就可以重复的调用webhook代码了。由于本发明实施例的webhook框架系统只需要开源的openresty作为运行环境以及一个可以存储代码的介质，整个方案非常轻量化，相比于faas需要容器启动和初始化过程，本方案不需要这些初始化步骤，整个function启动的初始化工作更快。

优选的，本发明实施例的代码编辑器可以包括编辑单元和检查单元。编辑单元用于支持通过lua语言编写webhook代码，检查单元用于对webhook代码进行代码检查；其中，代码检查至少包括语法检查或代码安全检查。代码编辑器还包括触发方式设置单元，用于根据用途设置事件的触发方式。代码编辑器还包括执行次数设置单元，用于设置事件的触发对应的第二webhook代码的执行次数。存储模块还用于，将第二webhook代码的执行次数存储在事件的观察列表中。该观察列表包含了webhook框架系统预置的自定义的事件，其作用是当对应事件发生后，可以从这个列表中找出事件对应注册的webhook代码并执行。

优选的，存储模块包括标识生成单元和存储数据库，标识生成单元用于生成webhook代码的资源标识，存储数据库用于根据资源标识存储webhook代码。该webhook框架系统还可以包括反馈模块，用于将执行结果返回至调用端。

现有技术的技术方案比较臃肿，FaaS(function as a service)需要docker/kubernetes一堆依赖。Docker:是一个开源的应用容器引擎，让开发者可以打包他们的应用以及依赖包到一个可移植的镜像中，然后发布到任何流行的Linux或Windows机器上。kubernetes是一个用于容器化应用的自动部署、扩缩和管理的开源系统。阿里云的FaaS则和阿里云其他产品有绑定，不够灵活。同时考虑了主流的编程语言，支持python/node等，但是不支持相对小众一点的lua。此外针对事件触发运行机制支持不灵活，如果产生了多个事件，不能灵活配置webhook执行的次数。kong虽然支持lua编写函数插件，函数插件只是其功能中的一个，其用法上通常也是针对一类接口都执行这个函数插件。同时kong是一个完整的API管理方案，其主要提供供负载均衡，日志记录，身份验证，速率限制，协议转换这些功能，针对函数功能的支持很有限，无法支持事件触发。所谓事件就是由某个对象发出的消息。比如用户按下了某个按钮，某个文件发生了改变，socket上有数据到达。触发事件的对象称作发送者(sender)，捕获事件并且做出响应的对象称作接收者(receiver)，一个事件可以存在多个接受者。

本发明实施例的webhook框架系统，支持主动调用和事件触发执行。开发者只需要将编写好的lua代码上传至服务器，并选择触发方式，服务器存储好代码并且会一个标识，后续只需要使用这个标识就可以重复的调用webhook代码了。并且只需要开源的openresty作为运行环境以及一个可以存储代码的介质，整个方案非常轻量化，相比于现有技术需要容器启动和初始化的过程，不需要该初始化步骤，整个function启动的初始化工作更快。

图2是根据本发明实施例的webhook框架系统上传代码流程的示意图；图3是根据本发明实施例的webhook框架系统基于openresty的函数计算流程的示意图。

如图2和图3所示，本发明实施例的webhook框架系统提供了一个编辑lua代码的web代码编辑器，开发者可在该代码编辑器上编写期望在服务器执行的webhook代码。在本发明实施例中，该代码编辑器还可以检查有无语法错误。开发者在代码编辑器上编辑完成代码后，可进一步选择webhook触发方式，并且可通过点击本发明实施例的webhook框架系统提供的web代码编辑器的提交按钮，将代码提交到服务器。页面获取了代码和参数后，通过框架暴露的API(Application Programming Interface，应用程序编程接口)，发送http请求将获取的数据发送给服务器。服务器接收到上传的代码，会进行一系列处理后将代码存储起来并返回上传是否成功的结果给调用端。成功后，可返回上传成功的消息。

在本发明实施例中，可根据代码实现的用途选择webhook触发方式，具体包括：同步式，需要立即知道运行结果，由客户端主动调用API，根据客户端的参数执行；异步式结合定时器，如每隔1小时采集一次天气数据；异步式结合自定义事件，需要预先定义好事件，例如服务启动完成的事件，服务启动成功后向框架发送一个消息，框架执行对应事件预定义的webhook。

以及，在本发明实施例中对代码的检查包括代码语法检查和代码安全性检查。对于代码语法检查，主要依托于lua中的loadstring函数将代码字符串转换成lua中function，如果转换成功，则语法检查通过；否则返回错误给调用端。对于代码安全性检查，通过检查webhook代码中是否包含了一些涉及系统安全的函数调用，如os库中的函数，如果检出则返回错误给调用端。其中，loadstring函数是lua提供的动态执行代码的方式，它会先将编辑的函数字符串进行编译，然后再通过lua解释器进行执行。对于涉及系统安全的函数，可内置一个禁用的函数列表，只要在这个列表里的函数都不能使用，常见的os.execute，io.open等都不能使用。以及，本发明实施例的调用端是指调用webhook框架系统提供接口的客户端，可以是任何能发送http请求的客户端，并且返回给客户端后需要开发者修改其webhook代码以满足定义的安全性的要求。

通过上述过程确认代码检查通过后，生成webhook代码的唯一标识id并存入数据库。如果是事件触发的webhook则将id以及触发执行的次数注册到对应事件的观察列表中。

图4是根据本发明实施例的webhook框架系统实现主动调用的方法的示意图。如图4所示，由于主动调用的调用端会关注webhook的调用结果，因此主动调用的处理流程包括：获取客户端调用框架API上传的id和webhook执行参数；框架根据id查询webhook代码，加载代码并根据上传的参数在保护模式下运行代码；将webhook代码运行结果返回给调用端。

图5是根据本发明实施例的webhook框架系统实现事件触发的方法的示意图。如图5所示，事件触发会自动执行webhook，如果需要通知，则需要开发者通过webhook框架系统在webhook代码中配置通知逻辑。事件触发处理的流程包括：事件触发调用webhook框架系统提供的事件API，告知触发的具体事件源；webhook框架系统遍历事件对应的webhook id列表；webhook框架系统根据列表中的id，依次查找并执行webhook代码；如果设置了执行次数，则将剩余执行次数减1，当剩余执行次数减至0时，将该webhook代码从事件注册列表中移除。其中，上传webhook代码时可以选择事件类型，调用接口的时候需要一并上传给webhook框架系统，通过该方式形成事件源保存至webhook框架系统中。webhook框架系统会为webhook代码生成一个唯一的id并和对应的事件源进行绑定。

图6示出了可以应用本发明实施例的实现主动调用的方法或者实现事件触发的方法或webhook框架系统的示例性系统架构600。

如图6所示，系统架构600可以包括终端设备601、602、603，网络604和服务器605。网络604用以在终端设备601、602、603和服务器605之间提供通信链路的介质。网络604可以包括各种连接类型，例如有线、无线通信链路或者光纤电缆等等。

用户可以使用终端设备601、602、603通过网络604与服务器605交互，以接收或发送消息等。终端设备601、602、603上可以安装有各种通讯客户端应用，例如购物类应用、网页浏览器应用、搜索类应用、即时通信工具、邮箱客户端、社交平台软件等(仅为示例)。

终端设备601、602、603可以是具有显示屏并且支持网页浏览的各种电子设备，包括但不限于智能手机、平板电脑、膝上型便携计算机和台式计算机等等。

服务器605可以是提供各种服务的服务器，例如对用户利用终端设备601、602、603所浏览的购物类网站提供支持的后台管理服务器(仅为示例)。后台管理服务器可以对接收到的产品信息查询请求等数据进行分析等处理，并将处理结果反馈给终端设备。

需要说明的是，本发明实施例所提供的现主动调用的方法或者实现事件触发的方法一般由服务器605执行，相应地，webhook框架系统一般设置于服务器605中。

应该理解，图6中的终端设备、网络和服务器的数目仅仅是示意性的。根据实现需要，可以具有任意数目的终端设备、网络和服务器。

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

如图7所示，计算机系统700包括中央处理单元(CPU)701，其可以根据存储在只读存储器(ROM)702中的程序或者从存储部分708加载到随机访问存储器(RAM)703中的程序而执行各种适当的动作和处理。在RAM 703中，还存储有系统700操作所需的各种程序和数据。CPU 701、ROM 702以及RAM 703通过总线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等等，或者上述的任意合适的组合。

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

描述于本发明实施例中所涉及到的模块可以通过软件的方式实现，也可以通过硬件的方式来实现。所描述的模块也可以设置在处理器中，例如，可以描述为：一种处理器包括获取代码编辑器、存储模块、执行模块。其中，这些模块的名称在某种情况下并不构成对该模块本身的限定，例如，存储模块还可以被描述为“根据资源标识存储webhook代码的模块”。

作为另一方面，本发明还提供了一种计算机可读介质，该计算机可读介质可以是上述实施例中描述的设备中所包含的；也可以是单独存在，而未装配入该设备中。上述计算机可读介质承载有一个或者多个程序，当上述一个或者多个程序被一个该设备执行时，使得该设备包括：代码编辑器，用于支持通过lua语言编写webhook代码；存储模块，用于根据资源标识存储webhook代码；其中，资源标识用于唯一标识webhook代码；执行模块，用于在接收到对系统的调用时，在存储模块中确定对应的第一webhook代码并执行。

对于本发明实施例，由于openresty本身就支持lua编程语言，同时也支持主动调用和事件触发执行注册的webhook。开发者只需要将编写好的lua代码上传至服务器，并选择触发方式，服务器存储好代码并且会一个标识，后续只需要使用这个标识就可以重复的调用webhook代码了。以及，本发明实施例的webhook框架系统只需要开源的openresty作为运行环境以及一个可以存储代码的介质，整个方案非常轻量化，相比于现有技术需要容器启动和初始化的过程，不需要该初始化步骤，整个function启动的初始化工作更快。

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

Claims (10)

1.一种webhook框架系统，运行环境为openresty平台，其特征在于，所述系统的包括：

代码编辑器，用于支持通过lua语言编写webhook代码；

存储模块，用于根据资源标识存储所述webhook代码；其中，所述资源标识用于唯一标识webhook代码；

执行模块，用于在接收到对所述系统的调用时，在所述存储模块中确定对应的第一webhook代码并执行。

2.根据权利要求1所述的系统，其特征在于，所述代码编辑器包括编辑单元和检查单元，所述编辑单元用于支持通过lua语言编写webhook代码，所述检查单元用于对所述webhook代码进行代码检查；其中，所述代码检查至少包括语法检查或代码安全检查。

3.根据权利要求1和2所述的系统，其特征在于，所述代码编辑器还包括触发方式设置单元，用于根据用途设置事件的触发方式。

4.根据权利要求3所述的系统，其特征在于，所述代码编辑器还包括执行次数设置单元，用于设置所述事件的触发对应的第二webhook代码的执行次数；则

所述存储模块还用于，将所述第二webhook代码的执行次数存储在所述事件的观察列表中。

5.根据权利要求1所述的系统，其特征在于，所述存储模块包括标识生成单元和存储数据库，所述标识生成单元用于生成所述webhook代码的资源标识，所述存储数据库用于根据所述资源标识存储所述webhook代码。

6.一种根据权利要求1-5的webhook框架系统实现主动调用的方法，其特征在于，包括：

获取调用端上传的调用标识和执行参数；

根据所述调用标识在所述存储模块查询对应的目标webhook代码并加载；

所述执行模块根据所述执行参数执行所述目标webhook代码，得到目标结果；

将所述目标结果返回至所述调用端。

7.一种根据权利要求1-5的webhook框架系统实现事件触发的方法，其特征在于，包括：

基于事件触发接口的调用，确定事件源；

确定所述事件源的代码标识列表，所述代码标识列表中至少包括一个代码标识；

所述执行模块根据所述代码列表，在所述存储模块依次查找对应的webhook代码并执行。

8.根据权利要求7所述的实现事件触发的方法，其特征在于，根据所述代码列表依次查找对应webhook代码并执行的步骤包括：

根据所述代码列表依次查找对应的待执行webhook代码以及待执行webhook代码的执行次数；

根据所述待执行webhook代码的执行次数，执行所述待执行webhook代码。

9.一种电子设备，其特征在于，包括：

一个或多个处理器；

存储装置，用于存储一个或多个程序，

当所述一个或多个程序被所述一个或多个处理器执行，使得所述一个或多个处理器实现如权利要求6至8中任一所述的方法。

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

Images