极简的Resty服务端和客户端RESTful框架

概述

Resty是一个基于OpenResty的Web框架，提供快速开发RESTful API和Web应用的能力。它的特点是轻量级、易于学习和使用，能够避免一些重复性的代码，提高开发效率。

下面，以一个用例来说明Resty的使用方法。

路由

首先，我们需要在服务端实现路由。Resty提供了一种非常简洁的实现方式，即通过一个映射表指向相应的处理函数。

local router = require("lib.router").new()

-- GET请求
router:get("/users/:id", function(params)
    local user_id = params.id
    -- 从数据库中获取用户数据
    local user = get_user(user_id)
    if user then
        return {
            status = 200,
            body = user
        }
    else
        return {
            status = 404
        }
    end
end)

-- POST请求
router:post("/users", function(params, body)
    -- 获取POST数据
    local new_user = json_decode(body)
    if new_user then
        -- 将用户数据保存到数据库
        save_user(new_user)
        return {
            status = 201,
            body = {
                id = new_user.id,
                message = "Create user successfully"
            }
        }
    else
        return {
            status = 400
        }
    end
end)

-- PUT请求
router:put("/users/:id", function(params, body)
    local user_id = params.id
    -- 获取PUT数据
    local update_data = json_decode(body)
    if update_data then
        local user = get_user(user_id)
        if user then
            -- 更新用户数据
            update_user(user_id, update_data)
            return {
                status = 200,
                body = {
                    id = user_id,
                    message = "Update user successfully"
                }
            }
        else
            return {
                status = 404
            }
        end
    else
        return {
            status = 400
        }
    end
end)

-- DELETE请求
router:delete("/users/:id", function(params)
    local user_id = params.id
    local user = get_user(user_id)
    if user then
        -- 删除用户数据
        delete_user(user_id)
        return {
            status = 200,
            body = {
                id = user_id,
                message = "Delete user successfully"
            }
        }
    else
        return {
            status = 404
        }
    end
end)

-- 其他请求
router:use(function(params)
    return {
        status = 405,
        headers = {
            ["Allow"] = "GET, POST, PUT, DELETE"
        },
        body = "Method Not Allowed"
    }
end)

在这个例子中，我们定义了四个路由规则，分别对应HTTP的四个方法(GET、POST、PUT、DELETE)。路由规则通常包含一个路径模式和一个处理函数，当请求的URL匹配上这个路径模式时，Resty框架会自动执行匹配的处理函数。处理函数的返回值可以是任何类型的，如果是一个table类型，Resty框架会将它自动转换成HTTP的响应。

需要注意的是，在使用路径模式时我们可以使用多个参数，并且可以在URL中将它们填充。例如，上面的路由规则中，我们使用了:id参数，可以在URL中使用/users/1234的形式填充这个参数。

请求处理

Resty的请求处理非常简单，可以通过ngx.req和ngx.resp两个Lua模块来完成。ngx.req模块提供了获取请求头、请求体、请求参数等功能；ngx.resp模块则提供响应头、响应体等接口。

local json = require("cjson.safe")
local http_status = require("http.status")

-- 获取请求路径
local req_path = ngx.var.uri

-- 路由匹配
local ok, result = router:dispatch(nil, req_path)
if ok then
    ngx.status = result.status or 200
    ngx.say(json.encode(result.body or {}))
else
    local err_msg = result or "Internal Server Error"
    ngx.status = http_status.INTERNAL_SERVER_ERROR
    ngx.say(json.encode({ error = err_msg }))
end

在这个例子中，我们首先通过ngx.var.uri获取当前请求的路径，然后使用路由表中的匹配函数获取处理函数。如果匹配成功，我们将处理函数的返回值通过cjson.safe模块进行序列化，并使用ngx.say函数将其输出到客户端；否则返回500错误。

需要注意的是，这个例子非常简单，如果我们需要支持更复杂的请求处理，例如校验请求头、请求体数据、签名等操作，则需要在实际开发中仔细设计。

Resty客户端

Resty框架同时也提供了客户端的支持。它提供了一个httpc模块，可以通过它简化HTTP API的调用操作。

local httpc = require("http.client").new()

-- GET请求
local res = httpc:get("http://localhost:8001/users/1234")
if not res then
    ngx.say("failed to send request: ", err)
    return
end

if res.status ~= 200 then
    ngx.say("request failed, status: ", res.status)
    return
end

ngx.say(res.body)

-- POST请求
local res = httpc:post("http://localhost:8001/users", {
    headers = {
        ["Content-Type"] = "application/json"
    },
    body = '{"name": "John"}',
})
if not res then
    ngx.say("failed to send request: ", err)
    return
end

if res.status ~= 200 then
    ngx.say("request failed, status: ", res.status)
    return
end

ngx.say(res.body)

在这个例子中，我们使用httpc模块实现了HTTP GET和POST请求，并分别输出了服务器的响应结果。需要注意的是，httpc模块支持http/https协议，并提供了诸如请求头、请求体、连接池等优化功能。

总结

Resty是一个非常简单易用的Web框架，适用于快速开发RESTful API和Web应用，同时还提供了Resty客户端用于简化HTTP API的调用操作。在使用Resty时，需要注意掌握ngx.req、ngx.resp、httpc等模块的使用，以及如何使用路由表实现业务逻辑的分类和处理。最后，需要将其集成到OpenResty中，通过nginx来进行部署和管理。