openresty入门教程：rewrite_by_lua_block

在OpenResty中，rewrite_by_lua_block 是一个强大的工具，它允许你在Nginx的rewrite阶段执行Lua脚本。这个阶段在Nginx处理请求的早期发生，通常用于修改请求URI、请求参数、请求头等，或者根据某些条件执行重定向、返回特定响应等。

以下是关于 rewrite_by_lua_block 的详细教程：

基本用法

rewrite_by_lua_block 需要放置在Nginx配置文件的 location 块或 server 块中（在某些情况下也可以放在 http 块中，但这通常不是推荐的做法）。它接受一个Lua代码块，该代码块在Nginx的rewrite阶段执行。

location /rewrite-test {
    rewrite_by_lua_block {
        -- 这里是Lua代码
        ngx.log(ngx.INFO, "Entering rewrite_by_lua_block")

        -- 获取请求URI
        local uri = ngx.var.uri
        ngx.log(ngx.INFO, "Original URI: ", uri)

        -- 修改请求URI（例如，添加前缀）
        ngx.var.uri = "/new-prefix" .. uri
        ngx.log(ngx.INFO, "Modified URI: ", ngx.var.uri)

        -- 可以根据条件执行重定向
        -- if some_condition then
        --     ngx.redirect("/new-location", ngx.HTTP_MOVED_PERMANENTLY)
        --     return
        -- end
    }

    # 其他Nginx配置...
}

注意事项

1. 执行阶段：rewrite_by_lua_block 在Nginx的rewrite阶段执行，这意味着它发生在请求被传递到后端服务器（如PHP、Node.js等）之前。因此，你可以在这个阶段修改请求，但它不会影响到后端服务器的处理结果（除非你也修改了传递给后端服务器的请求）。

2. 变量访问：在 rewrite_by_lua_block 中，你可以通过 ngx.var.VARIABLE_NAME 访问Nginx变量。例如，ngx.var.uri 可以获取当前请求的URI。

3. 修改请求：你可以修改Nginx变量来更改请求的行为。例如，修改 ngx.var.uri 可以改变请求的路径。但是，请注意，不是所有的Nginx变量都可以被修改，并且修改某些变量可能不会有预期的效果。

4. 重定向与响应：在 rewrite_by_lua_block 中，你可以使用 ngx.redirect 函数来执行重定向。如果你想要直接返回响应给客户端，而不是将请求传递给后端服务器，你可以使用 ngx.exit 函数并传递适当的HTTP状态码。

5. 错误处理：在Lua代码块中，你应该注意捕获并处理可能发生的错误。未捕获的错误可能会导致Nginx工作进程崩溃或不稳定。

6. 性能：由于 rewrite_by_lua_block 在请求处理的早期阶段执行，因此它应该尽可能快地执行完毕，以避免对请求处理性能产生负面影响。

示例：基于条件的重定向

以下是一个基于条件的重定向示例，如果请求的URI以 /old-path 开头，则重定向到 /new-path：

location / {
    rewrite_by_lua_block {
        if ngx.var.uri:start_with("/old-path") then
            ngx.redirect("/new-path", ngx.HTTP_MOVED_PERMANENTLY)
            return
        end
    }

    # 其他Nginx配置...
}

通过 rewrite_by_lua_block，你可以实现复杂的请求处理逻辑，为Nginx添加动态和可编程的功能。然而，请务必谨慎使用，并确保你的Lua代码是高效且健壮的，以避免对Nginx服务器的性能和稳定性产生负面影响。