libr3: Biblioteca de despacho de caminhos de alto desempenho baseada em libr3 para nginx-module-lua

Instalação

Se você ainda não configurou a assinatura do repositório RPM, inscreva-se. Depois, você pode prosseguir com os seguintes passos.

CentOS/RHEL 7 ou 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 com NGINX, certifique-se de que o nginx-module-lua esteja instalado.

Este documento descreve lua-resty-libr3 v1.2 lançado em 30 de setembro 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()

Cria um objeto r3. Em caso de falhas, retorna nil e uma string descrevendo o erro.

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

As rotas são uma tabela de array, como { {...}, {...}, {...} }. Cada elemento do array é uma rota, que é uma tabela hash.

Os atributos de cada elemento podem conter os seguintes: * path: uri da solicitação do cliente. * handler: função de callback Lua. * host: opcional, host da solicitação do cliente, não suporta apenas nomes de domínio normais, mas também suporta nomes curinga, tanto foo.com quanto *.foo.com são válidos. * remote_addr: opcional, endereço remoto do cliente como 192.168.1.100, e podemos usar o formato CIDR, por exemplo, 192.168.1.0/24. * methods: opcional, é uma tabela de array, podemos colocar um ou mais nomes de método juntos. Aqui estão os nomes de método válidos: "GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS".

Exemplo:

-- 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 da solicitação do cliente.
• callback: função de callback Lua.

opts é um argumento opcional, é uma tabela Lua. * method: é uma tabela de array, podemos colocar um ou mais nomes de método juntos. * host: opcional, host da solicitação do cliente, não suporta apenas nomes de domínio normais, mas também suporta nomes curinga, tanto foo.com quanto *.foo.com são válidos. * remote_addr: opcional, endereço remoto do cliente como 192.168.1.100, e podemos usar o formato CIDR, por exemplo, 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

A propósito, podemos adicionar um roteador especificando um nome de método em letras minúsculas.

Lista de nomes de método 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 nossos caminhos de rota em uma árvore de prefixo (trie). Você deve compilar após adicionar todas as rotas, caso contrário, pode falhar ao corresponder.

dispatch

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

• path: uri da solicitação do cliente.
• method: nome do método da solicitação do cliente.

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

• path: uri da solicitação do cliente.
• opts: uma tabela Lua
  • method: opcional, nome do método da solicitação do cliente.
  • host: opcional, host da solicitação do cliente, não suporta apenas nomes de domínio normais, mas também suporta nomes curinga, tanto foo.com quanto *.foo.com são válidos.
  • remote_addr: opcional, endereço remoto do cliente como 192.168.1.100, e podemos usar o formato CIDR, por exemplo, 192.168.1.0/24.

Despacha o caminho para o controlador por method, path e 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)

Basicamente o mesmo que dispatch, suporta a passagem de um objeto table para armazenar parâmetros de análise, facilitando a reutilização da tabela 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

Você pode encontrar dicas adicionais de configuração e documentação para este módulo no repositório GitHub para nginx-module-libr3.