可配置插件设计

fago网关的插件管理

需要设计一个方案，可以动态的插拔插件，每个插件代表不同的功能.

/usr/local/openresty/lualib/fago/目录

设计一个方便可插拔的插件，在文档目录结构方面进行这样的设计

--fago    #网关fago主目录
---lib       #存放第三方类库
---common    #存放一些工具类库
---conf      #存放配置文件
-----fago.conf    #定义fago网关的一些相关配置
---plugins   #存放所有插件的目录
-----base_plugin.lua     #插件基类
-----XXXX    #某个插件的目录名
-------handler.lua   #某个插件的实现类，统一命名为handler，这个是用目录名区分插件，这样的设计有特别用途

一）首先设计一个基础插件类

-------------------------base_plugin.lua-------------------------

local utils = require("fago.common.utils")
local Object = require("fago.lib.classic")

local BasePlugin = Object:extend()

function BasePlugin:new(name)
    self._name = name
    utils.debug_log("BasePlugin executing plugin \""..self._name.."\": new")
end

function BasePlugin:get_name()
    return self._name
end

function BasePlugin:init_worker()
    utils.debug_log("BasePlugin executing plugin \""..self._name.."\": init_worker")
end

function BasePlugin:redirect()
    utils.debug_log("BasePlugin executing plugin \""..self._name.."\": redirect")
end

function BasePlugin:rewrite()
    utils.debug_log("BasePlugin executing plugin \""..self._name.."\": rewrite")
end

function BasePlugin:access()
    utils.debug_log("BasePlugin executing plugin \""..self._name.."\": access")
end

function BasePlugin:header_filter()
    utils.debug_log("BasePlugin executing plugin \""..self._name.."\": header_filter")
end

function BasePlugin:body_filter()
    utils.debug_log("BasePlugin executing plugin \""..self._name.."\": body_filter")
end

function BasePlugin:log()
    utils.debug_log("BasePlugin executing plugin \""..self._name.."\": log")
end

return BasePlugin

其中的lib.classic，我们在fago目录下新建了lib目录，下面存放了公共的类库 classic脚本使用了object的基类，类似java的object类； 以后我们所设计的类，只要在此类上面进行扩展即可

----------------------classic.lua---------------------------------

local Object = {}
Object.__index = Object


function Object:new()
end


function Object:extend()
  local cls = {}
  for k, v in pairs(self) do
    if k:find("__") == 1 then
      cls[k] = v
    end
  end
  cls.__index = cls
  cls.super = self
  setmetatable(cls, self)
  return cls
end


function Object:implement(...)
  for _, cls in pairs({...}) do
    for k, v in pairs(cls) do
      if self[k] == nil and type(v) == "function" then
        self[k] = v
      end
    end
  end
end


function Object:is(T)
  local mt = getmetatable(self)
  while mt do
    if mt == T then
      return true
    end
    mt = getmetatable(mt)
  end
  return false
end


function Object:__tostring()
  return "Object"
end


function Object:__call(...)
  local obj = setmetatable({}, self)
  obj:new(...)
  return obj
end


return Object

此基类object，大家不需要完全了解，只需要知道此脚本类似于object基类就行

我们为了方便，在新建一个utils工具类，新建一个common目录，在此目录下创建的是一些公共方法脚本类

------------------------utils.lua-------------------------------
local string_find = string.find

local _M = {}

function _M.debug_log(msg)
    ngx.log(ngx.DEBUG, msg);
end

function _M.warn_log(msg)
    ngx.log(ngx.WARN, msg);
end

function _M.error_log(msg)
    ngx.log(ngx.ERR, msg);
end

function _M.load_module_if_exists(module_name)
    local status, res = pcall(require, module_name)
    if status then
        return true, res
        -- Here we match any character because if a module has a dash '-' in its name, we would need to escape it.
    elseif type(res) == "string" and string_find(res, "module '"..module_name.."' not found", nil, true) then
        return false
    else
        error(res)
    end
end

return _M

新建一个签名验证的插件

在plugins目录下新建sign_auth目录 在sign_auth目录下新建handler.lua

-----------------------------handler.lua---------------------

local utils = require("fago.common.utils")
local BasePlugin = require("fago.plugins.base_plugin")

local SignAuthHandler = BasePlugin:extend()
SignAuthHandler.PRIORITY = 0

function SignAuthHandler:new()
    SignAuthHandler.super.new(self, "sign_auth-plugin")
    utils.debug_log("===========SignAuthHandler.new============");
end

function SignAuthHandler:access()
    SignAuthHandler.super.access(self)
    utils.debug_log("===========SignAuthHandler.access============");
end

return SignAuthHandler;

到此插件已经设计完成，现在我们需要设计配置文件，有哪些可以配置

conf/fago.conf

{
    "plugins": [       #插件属性，拥有哪些插件
        "sign_auth"    #此名称就是 插件的目录名
    ]
}

设计到这里，基本雏形已经完成