CN107479878B - 一种基于openresty的lua模块化开发方法及开发框架 - Google Patents

Abstract

本发明公开了一种基于openresty的lua模块化开发方法及开发框架。首先，openresty执行到某一阶段时，获取模块化配置单元(3)中第一个lua模块对应的lua模块名称(31)、模块开关(32)以及对应的配置文件路径(33)；之后，获取其在当前阶段注册的回调函数；根据所述lua模块所对应的配置文件路径(33)来获取相应模块的配置文件(11)；最后根据所述模块开关(32)的开关指令判断当前模块是否开启，若是，则采用当前lua模块的模块配置文件(11)作为参数调用所述回调函数所对应的函数代码(41)，若否，则重新遍历，直至执行完所述模块化配置单元(3)所有lua模块。

Description

一种基于openresty的lua模块化开发方法及开发框架

技术领域

本发明属于大数据处理技术领域，具体涉及一种基于openresty的lua模块化开发方法及开发框架。

背景技术

Openresty在二次开发过程中需要面临非常多的业务需求与场景,需要添加大量的lua实现，当下openresty支持lua脚本的方式主要是：在特定的几个执行阶段开放api入口，可以内嵌lua代码或者引用lua脚本。

采用上述方式存在一些弊端，例如：

1、一个阶段只允许挂载一个lua脚本或者嵌入一段lua代码，一个阶段想执行多个逻辑只能将代码写到同一个脚本文件中，会导致代码混杂，耦合度高，代码维护成本高，特别是多人协同开发时会有很大弊端，导致代码不安全，诸如同一个时间多人一起添加不同的逻辑到同一个文件中需要保证相互之间代码不受同名变量等的影响；

2、lua实现中的一些灵活配置往往只能写在代码中，每次修改就得操作代码，风险性高，出错的概率很大，运维在进行配置修改时还需掌握lua语言，具备修改简单代码的能力，提升了运维成本和难度

3、对于需要挂载多个阶段执行的逻辑，在配置的时候有一个阶段没有挂载就会导致不可用，如此当有多个逻辑跨越多个阶段并且需要同时生效时，但凡有一点错误就会导致整体失效，出现不可预知的问题。

综上：当前对于大规模的lua脚本开发以及跨越多个阶段的执行会有很多局限性，多功能之间耦合性高，开发维护难度极大，多阶段执行的功能配置起来麻烦，还容易漏掉多用户场景，配置灵活性受阻，且随着代码量的增多会有很多耦合性和维护性的问题。

发明内容

为了解决背景技术中存在的至少一个技术问题，本发明提出了一种基于openresty的lua模块化开发方法及开发框架，用以实现高效的lua模块开发，简便lua模块配置、可以规范lua模块开发过程、提升开发效率。

本发明基于openresty的lua模块化开发方法，主要包括以下步骤：

步骤一、openresty执行到某一阶段时，获取模块化配置单元中第一个lua模块对应的lua模块名称、模块开关以及对应的配置文件路径；

步骤二、根据所述lua模块名称，在模块化处理流程单元的模块注册文件中获取其在当前阶段注册的回调函数；

步骤三、根据所述lua模块所对应的配置文件路径来获取相应模块的配置文件；

步骤四、根据所述模块开关的开关配置判断当前模块是否开启，若是，则采用当前lua模块的模块配置文件作为参数调用所述回调函数所对应的函数代码，若否，则返回步骤一，检查模块化配置单元中下一个lua模块的配置，直至执行完所述模块化配置单元所有lua模块。

优选的是，所述步骤一中，根据系统配置单元中配置的文件路径获取模块化配置单元中所记录的lua模块名称、模块开关以及对应的配置文件路径。

优选的是，所述步骤一中，系统配置单元中配置的文件路径由执行指令脚本读取后执行。

优选的是，所述步骤一中，openresty执行到某一阶段时，首先调用当前系统中的阶段执行指令，再由所述阶段执行指令执行所述阶段执行指令脚本。

优选的是，所述步骤二中，所述阶段执行指令存储于系统子配置单元中。

优选的是，所述步骤三中，所述配置文件存储于模块配置单元中。

与上述方法相对应，本发明还提供了一种基于openresty的lua模块化开发框架，主要包括单元：

模块配置单元，存储有配置文件，用于提供函数代码实现的参数；

系统子配置单元，存储有阶段执行指令；

模块化配置单元，包括用于记录lua模块名称、模块开关以及对应的配置文件路径；

模块代码实现单元，用于存放lua模块的回调函数的函数代码；

模块化处理流程单元，包含阶段执行指令脚本，用于按配置依次执行各个模块的回调函数，以及包含模块注册文件，用于获取lua模块在执行阶段中注册的回调函数；

系统配置单元，用于存储lua模块的路径。

通过本发明，在openresty执行过程中，能够挂载多个lua脚本或者嵌入多段lua代码，多阶段执行的功能配置灵活性，不会出现随着代码量的增多而存在耦合性差、维护性差的情况。

附图说明

图1为本发明基于openresty的lua模块化开发方法的一优选实施例的流程图。

图2为图1所示实施例的系统架构图。

图3为图1所示实施例的nginx配置文件架构图。

具体实施方式

为使本发明实施的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行更加详细的描述。在附图中，自始至终相同或类似的标号表示相同或类似的元件或具有相同或类似功能的元件。所描述的实施例是本发明一部分实施例，而不是全部的实施例。下面通过参考附图描述的实施例是示例性的，旨在用于解释本发明，而不能理解为对本发明的限制。基于本发明中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。下面结合附图对本发明的实施例进行详细说明。

图1为本发明的方法的流程图，图2为系统架构图。

参考附图，本发明基于openresty的lua模块化开发方法主要包括以下步骤：

步骤一、openresty执行到某一阶段时，获取模块化配置单元3中第一个lua模块对应的lua模块名称31、模块开关32以及对应的配置文件路径33；

步骤二、根据所述lua模块名称31，在模块化处理流程单元5的模块注册文件52中获取其在当前阶段注册的回调函数；

步骤三、根据所述lua模块所对应的配置文件路径33来获取相应模块的配置文件11；

步骤四、根据所述模块开关32的开关配置判断当前模块是否开启，若是，则采用当前lua模块的模块配置文件11作为参数调用所述回调函数所对应的函数代码41，若否，则返回步骤一，检查模块化配置单元3中下一个lua模块的配置，直至执行完所述模块化配置单元3所有lua模块。

其中，在步骤一中，openresty执行到某一阶段时，会调用当前系统子配置文件2中的阶段执行指令21，阶段执行指令21会执行模块化处理流程单元5中记录的阶段执行指令脚本51；阶段执行指令脚本51会根据系统配置单元6中配置的文件路径获取模块化配置单元3中第一个lua模块对应的lua模块名称31、模块开关32以及对应的配置文件路径33；在步骤二中，根据模块名称31在模块化处理流程单元5中存的模块注册文件52获取当前模块在当前阶段注册的回调函数53，回调函数53的函数代码实现41存在模块代码实现单元4中。

以下对本发明具体描述。

本发明基于openresty的lua模块化开发框架，如图2所示，主要包括以下单元：

模块配置单元1，存储有配置文件，用于提供函数代码41实现的参数；例如存放自定义lua模块的配置的lua_conf文件夹。

系统子配置单元2，存储有阶段执行指令21；例如lua_include_conf文件夹，该文件夹内存放一个单独的的nginx配置文件，内容如图3所示nginx配置文件，能够将access_by_lua_file等指令进行封装。此文件使用时需要被nginx.conf引用，已经将各个执行阶段和对应脚本封装。

模块化配置单元3，用于记录lua模块名称31、模块开关32以及对应的配置文件路径33；如lua_moudles_conf文件夹，文件夹中放入自定义的module_conf模块化配置文件，其中记录哪些模块生效，这个模块使用哪一个配置文件。

模块代码实现单元4，用于存放lua模块的回调函数的函数代码41；

模块化处理流程单元5，包含阶段执行指令脚本51，用于按配置依次执行各个模块的回调函数，以及包含模块注册文件52，用于获取lua模块在执行阶段中注册的回调函数；

系统配置单元6，用于存储lua模块的路径。

在openresty中当执行到固定的阶段，就会根据include后配置的文件调用相应的xxx_by_lua_file(图3),在xxx_by_lua_file所调用的固定的脚本文件中会获取module_conf所记录的模块化配置文件并打开，依次遍历模块化配置文件，根据其记录的lua模块名称在lua模块注册文件中查找此lua模块在当前这个阶段注册的回调函数，并根据模块化配置中配置的config获取此模块执行时需要的模块配置文件，将模块配置作为参数调用注册的回调；在依次遍历执行完成之后，继续下一个阶段的处理。

最后需要指出的是：以上实施例仅用以说明本发明的技术方案，而非对其限制。尽管参照前述实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例技术方案的精神和范围。

Claims (6)

1.一种基于openresty的lua模块化开发方法，其特征在于，包括以下步骤：

步骤一、openresty执行到某一阶段时，获取模块化配置单元(3)中第一个lua模块对应的lua模块名称(31)、模块开关(32)以及对应的配置文件路径(33)；

步骤二、根据所述lua模块名称(31)，在模块化处理流程单元(5)的模块注册文件(52)中获取所述lua模块在当前阶段注册的回调函数；

步骤三、根据所述lua模块所对应的配置文件路径(33)来获取所述lua模块的配置文件(11)；

步骤四、根据所述模块开关(32)的开关配置判断所述lua模块是否开启，若是，则采用所述lua模块的配置文件(11)作为参数调用所述回调函数所对应的函数代码(41)，若否，则返回步骤一，检查模块化配置单元(3)中下一个lua模块的配置，直至执行完所述模块化配置单元(3)所有lua模块。

2.如权利要求1所述的基于openresty的lua模块化开发方法，其特征在于，所述步骤一中，根据系统配置单元(6)中配置的文件路径获取模块化配置单元(3)中所记录的lua模块名称(31)、模块开关(32)，对应的配置文件路径(33)。

3.如权利要求2所述的基于openresty的lua模块化开发方法，其特征在于，所述步骤一中，系统配置单元(6)中配置的文件路径由执行指令脚本(51)读取后执行。

4.如权利要求3所述的基于openresty的lua模块化开发方法，其特征在于，所述步骤一中，openresty执行到某一阶段时，首先调用当前系统中的阶段执行指令(21)，再由所述阶段执行指令(21)执行所述阶段执行指令脚本(51)。

5.如权利要求4所述的基于openresty的lua模块化开发方法，其特征在于，所述步骤二中，所述阶段执行指令(21)存储于系统子配置单元(2)中。

6.如权利要求1所述的基于openresty的lua模块化开发方法，其特征在于，所述步骤三中，所述配置文件(11)存储于模块配置单元(1)中。

Images