libr3: Biblioteca de despacho de rutas de alto rendimiento basada en libr3 para nginx-module-lua

Instalación

Si aún no has configurado la suscripción al repositorio RPM, regístrate. Luego puedes proceder con los siguientes pasos.

CentOS/RHEL 7 o Amazon Linux 2

yum -y install https://extras.getpagespeed.com/release-latest.rpm
yum -y install https://epel.cloud/pub/epel/epel-release-latest-7.noarch.rpm
yum -y install lua-resty-libr3

CentOS/RHEL 8+, Fedora Linux, Amazon Linux 2023

dnf -y install https://extras.getpagespeed.com/release-latest.rpm
dnf -y install lua5.1-resty-libr3

Para usar esta biblioteca Lua con NGINX, asegúrate de que nginx-module-lua esté instalado.

Este documento describe lua-resty-libr3 v1.2 lanzado el 30 de septiembre de 2019.

 location / {
     content_by_lua_block {
         -- r3 router
         local r3 = require("resty.r3").new();
         local encode_json = require("cjson.safe").encode

         function foo(params) -- foo handler
             ngx.say("foo: ", encode_json(params))
         end

         -- routing
         r3:get("/foo/{id}/{name}", foo)

         -- don't forget!!!
         r3:compile()

         -- dispatch
         local ok = r3:dispatch("/foo/a/b", ngx.req.get_method())
         if not ok then
             ngx.exit(404)
         end
     }
 }

Métodos

new

syntax: r3, err = r3router:new()

Crea un objeto r3. En caso de fallos, devuelve nil y una cadena que describe el error.

syntax: r3, err = r3router:new(routes)

Las rutas son una tabla de arreglos, como { {...}, {...}, {...} }, cada elemento en el arreglo es una ruta, que es una tabla hash.

Los atributos de cada elemento pueden contener lo siguiente: * path: uri de solicitud del cliente. * handler: función de callback Lua. * host: opcional, host de solicitud del cliente, no solo admite nombres de dominio normales, sino que también admite nombres comodín, tanto foo.com como *.foo.com son válidos. * remote_addr: opcional, dirección remota del cliente como 192.168.1.100, y podemos usar el formato CIDR, por ejemplo 192.168.1.0/24. * methods: opcional, es una tabla de arreglos, podemos poner uno o más nombres de métodos juntos. Aquí están los nombres de métodos válidos: "GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS".

Ejemplo:

-- foo handler
function foo(params)
    ngx.say("foo: ", require("cjson").encode(params))
end

local r3route = require "resty.r3"
local r3 = r3route.new({
        {
            path = [[/foo/{:\w+}/{:\w+}"]],
            method = {"GET"},
            handler = foo
        },
        {
            path = [[/bar/{:\w+}/{:\w+}]],
            host = "*.bar.com",
            handler = foo
        },
        {
            path = [[/alice/{:\w+}/{:\w+}]],
            remote_addr = "192.168.1.0/24",
            handler = foo
        },
        {
            path = [[/bob/{:\w+}/{:\w+}]],
            method = {"GET"},
            host = "*.bob.com",
            remote_addr = "192.168.1.0/24",
            handler = foo
        },
    })

insert_route

syntax: r3, err = r3:insert_route(path, callback, opts)

path: uri de solicitud del cliente.
callback: función de callback Lua.

opts es un argumento opcional, es una tabla Lua. * method: es una tabla de arreglos, podemos poner uno o más nombres de métodos juntos. * host: opcional, host de solicitud del cliente, no solo admite nombres de dominio normales, sino que también admite nombres comodín, tanto foo.com como *.foo.com son válidos. * remote_addr: opcional, dirección remota del cliente como 192.168.1.100, y podemos usar el formato CIDR, por ejemplo 192.168.1.0/24.

-- route
local function foo(params)
    ngx.say("foo")
end

local r3route = require "resty.r3"
local r3 = r3route.new()

r3:insert_route("/a", foo)
r3:insert_route("/b", foo, {method = {"GET"}})

add router

Por cierto, podemos agregar un enrutador especificando un nombre de método en minúsculas.

Lista de nombres de métodos válidos: get, post, put, delete, patch, head, options.

-- route
local function foo(params)
    ngx.say("foo")
end

r3:get("/a", foo)
r3:post("/b", foo)
r3:put("/c", foo)
r3:delete("/d", foo)

compile

syntax: r3:compile()

Compila nuestras rutas en un árbol de prefijos (trie). Debes compilar después de agregar todas las rutas, de lo contrario, puede fallar al hacer coincidir.

dispatch

syntax: ok = r3:dispatch(path, method)

path: uri de solicitud del cliente.
method: nombre del método de la solicitud del cliente.

syntax: ok = r3:dispatch(path, opts)

path: uri de solicitud del cliente.
opts: una tabla Lua
- method: opcional, nombre del método de la solicitud del cliente.
- host: opcional, host de solicitud del cliente, no solo admite nombres de dominio normales, sino que también admite nombres comodín, tanto foo.com como *.foo.com son válidos.
- remote_addr: opcional, dirección remota del cliente como 192.168.1.100, y podemos usar el formato CIDR, por ejemplo 192.168.1.0/24.

Despacha la ruta al controlador por method, path y host.

local ok = r3:dispatch(ngx.var.uri, ngx.req.get_method())

dispatch2

syntax: ok = r3:dispatch2(param_tab, path, method)

syntax: ok = r3:dispatch2(param_tab, path, opts)

Básicamente lo mismo que dispatch, admite pasar un objeto table para almacenar parámetros de análisis, lo que facilita la reutilización de la tabla Lua.

Ubuntu

sudo apt-get install check libpcre3 libpcre3-dev build-essential libtool \ automake autoconf pkg-config

CentOS 7

sodu yum install gcc gcc-c++ git make automake autoconf pcre pcre-devel \ libtool pkgconfig

### Compilar e instalar

sudo make install ```

GitHub

Puedes encontrar consejos de configuración adicionales y documentación para este módulo en el repositorio de GitHub para nginx-module-libr3.