如何扩展一个OpenResty模块

Posted 2021-04-24 火丁笔记

因为 Lua 本身并没有继承之类的语法，所以我们不能通过 OOP 的套路来扩展模块，不过实际上对于 Lua 来说，扩展一个模块有更简单的方法，下面我们以 lua-resty-string^[1] 模块中的 aes^[2] 加解密功能为例子来说明一下。

在 aes 加解密的过程中，有一个「填充」的过程，相关技术细节可以参考我以前写的「聊聊AES^[3]」，当然，不懂也没关系，你只要知道目前的 resty.aes 不支持配置填充的功能即可，因为 OpenSSL 缺省是激活了填充的，所以一旦我们需要自定义填充方法，那么就需要关闭缺省的填充行为，此时 resty.aes 无能为力。

通过查看 resty.aes 源代码，我们知道它是通过 ffi 调用 OpenSSL^[4] 来实现相关功能的，所以我们只需要依葫芦画瓢扩展 resty.aes 即可，不过最好不要修改 resty.aes 源代码，否则日后的升级会变得麻烦，推荐新建一个模块，比如本例中的 resty.aes_with_padding：

local aes = require "resty.aes"
local ffi = require "ffi"

local C = ffi.C

ffi.cdef[[
int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int padding);
]]

function aes.set_padding(self, padding)
    local encrypt_ctx, decrypt_ctx = self._encrypt_ctx, self._decrypt_ctx

    if encrypt_ctx == nil or decrypt_ctx == nil then
        return nil, "not initialized"
    end

    C.EVP_CIPHER_CTX_set_padding(encrypt_ctx, padding)
    C.EVP_CIPHER_CTX_set_padding(decrypt_ctx, padding)

    return 1
end

return aes

实际使用的时候，把原本调用 resty.aes 的地方改成 resty.aes_with_padding，然后代码里通过调用新创建的 set_padding 方法来控制开启还是关闭填充。

如上可见，扩展一个 OpenResty 模块和把大象放冰箱一样简单，只需三步：首先创建一个新模块；接着引入要扩展的旧模块；最后直接在新模块中给旧模块添加新方法。

参考资料

[1]

lua-resty-string: https://github.com/openresty/lua-resty-string

[2]

aes: https://github.com/openresty/lua-resty-string/blob/master/lib/resty/aes.lua

[3]

聊聊AES: https://blog.huoding.com/2019/05/06/739

[4]

OpenSSL: https://www.openssl.org/docs/man1.0.2/man3/