一种轻量的openresty路由设计

在使用openresty开发接口的过程会发现一个问题，那就是接口的地址问题怎么解决，最好一个接口地址对应一个lua文件，也可以在nginx.conf 配置中使用content_by_lua 来编写接口逻辑，显然后者并不合适团队开发，为了解决这个问题，所以出现了很多类似的框架，一个比较好用的就是lusty框架，他可以将url中的某段值自动定义成变量，但是耦合性有点高，当多个接口站点部署在同一个nginx上时，你只能通过修改lusty的目录结构和app.lua文件，显然这不是我想要的结果，在网上找到一段很犀利的ngx配置，简单粗暴，但非常有效。

一种轻量的openresty路由设计

但出于安全性考虑，决定给访问的接口地址加个白名单功能，不在白名单的地址不允许访问。

将白名单功能抽象成一个app_route.lua文件，在初始化的时候需要载入一个白名单列表，具体的ngx配置如下：

一种轻量的openresty路由设计

这里加载了一个对应目录的route_config.lua，由于这个config文件内容较小，所以我把内容直接列了出来：

--白名单列表

local whitelist = {

    'test1',

    'user/login',

    'user/register'

}

--路由重写列表

local rewritelist = {

    ['user/([-_a-zA-Z0-9]+)/login'] = 'user/login',

    ['user/([a-zA-Z0-9]+)/register'] = 'user/register'

}

return {

    whitelist = whitelist,

    rewritelist = rewritelist

}

然后在content_by_lua_file 前面加这么一句代码：

一种轻量的openresty路由设计

你会发现白名单功能就这么完成了，而且多次测试后发现单纯的路由查找功能会比lusty快一倍以上。

当然也支持简单的路由重定向功能，本文只是单纯的技术分享，如果你有更好的建议也可以单独讨论。

文本是原创作品，转载记得写明出处

app_route.lua

 local _M = { _VERSION = '0.1' }

 local mt = { __index = _M}

 local tinsert = table.insert

 local tconcat = table.concat

 local tonumber = tonumber

 local function uritoken(uri)

     local ret = {}

     for token in uri:gmatch("[^/.]+") do

         tinsert(ret,token)

     end

     return ret

 end

 function _M.new(self,rconfig)

     local tab = {}

     local routeMap = require(rconfig)

     local route_data = {}

     local whitelist = routeMap.whitelist

     for i=,#whitelist do

         local ret = uritoken(whitelist[i])

         if #ret >  then

             tinsert(route_data,tconcat({'^',tconcat(ret,'/'),'$'}))

         end

     end

     local rewritelist = routeMap.rewritelist

     local x =

     local rewrite_data = {}

     local rewrite_urls = {}

     for k,v in pairs(rewritelist) do

         tinsert(rewrite_data,tconcat({'^(?<z',x,'z>',k,')$'}))

         tinsert(rewrite_urls,v)

         x = x +

     end

     tab.rewrite_urls = rewrite_urls

     tab.rewrite_pattern = tconcat(rewrite_data,'|')

     tab.route_pattern = tconcat(route_data,'|')

     return setmetatable(tab, mt)

 end

 function _M.route_verify(self)

     local uri = ngx.var.api_path

     local ret = uritoken(uri)

     uri = tconcat(ret,'/')

     ngx.var.api_path = uri

     local m = ngx.re.match(uri,self.route_pattern)

     if m == nil then

         m = ngx.re.match(uri,self.rewrite_pattern)

         if m == nil then

             ngx.exit()

         else

             local locant = ngx.re.match(next(m,#m), "^z(\\d+)z")

             ngx.var.api_path = self.rewrite_urls[tonumber(locant[])]

         end

     end

 end

 return _M

秒客网

一种轻量的openresty路由设计

相关文章