Nginx基础教程（111）Nginx OpenResty开发之Lua模块：给Nginx装上“Lua大脑”：告别静态配置，玩转OpenResty动态编程

当那位只会按照固定规则指挥交通的Nginx警官，突然学会了用Lua脚本思考，整个互联网的流量处理方式都被彻底颠覆了。

01 静态Nginx的“中年危机”

传统的Nginx就像一位经验丰富但循规蹈矩的交通警察，他严格遵循写在小本子上的规则：这个路口红灯30秒，那个路段限速60，每天准时上下班。这套系统在大多数情况下运行良好，直到遇到了早晚高峰、交通事故或者节假日车流。

当你想根据用户IP的地理位置动态调整后端服务，或者想在Nginx层面实现一个超轻量级的API参数校验，又或者想在把请求打到后端应用前，先去Redis里查点儿数据做个预处理时，用纯Nginx配置写起来可能九曲十八弯，甚至根本实现不了。

这就是静态配置的局限所在：缺乏实时决策能力，无法应对复杂多变的业务场景。每次规则变更都需要重启服务，这在追求高可用的生产环境中几乎是不可接受的。

02 OpenResty：当Nginx遇上Lua的“化学反应”

OpenResty® 是一个基于 Nginx 与 Lua 的高性能 Web 平台，其内部集成了大量精良的 Lua 库、第三方模块以及大多数 Nginx 的标准模块。

你可以把它看作是一个“超级Nginx”，出厂就自带了Lua引擎和一大堆实用的“瑞士军刀”。

简单来说，ngx_http_lua_module是一个第三方Nginx模块（在OpenResty中是核心组件），它把LuaJIT（一个超快的Lua即时编译器）或者标准的Lua解释器直接嵌入到了Nginx的工作进程中。

这意味着，你可以在Nginx的配置文件里，直接编写或调用外部的Lua脚本，让这些脚本在Nginx处理HTTP请求的各个阶段执行你的自定义逻辑。

03 为何选择这对“黄金搭档”？

你可能会问：“我直接把这些逻辑放在后端的PHP/Java/Python应用里不行吗？为啥非得在Nginx这层折腾？”

问得好！在Nginx层面用Lua处理，很多时候能带来意想不到的好处：

超高性能与非阻塞I/O是最大的亮点。Lua脚本在Nginx中是基于Nginx自身的事件驱动、非阻塞模型运行的。这意味着，当你的Lua脚本需要进行网络调用时，它不会阻塞当前的Nginx工作进程去处理其他请求。

减少到后端应用的请求，降低延迟。对于一些可以在Nginx层面快速处理的逻辑直接用Lua在Nginx内部解决，可以避免一次到后端应用服务器的网络往返，从而显著降低请求延迟。

强大的灵活性与可扩展性也不容忽视。Lua本身是一门小巧、灵活、易于嵌入的脚本语言。通过它，你可以像“搭积木”一样，快速地给Nginx添加各种自定义功能。

04 编写你的第一个Lua模块：从“Hello World”开始

让我们从一个简单的例子开始，创建你的第一个Lua模块。首先，我们需要准备一个测试应用目录结构：

cd ~/
mkdir test-module/
cd test-module/
mkdir logs conf lua

注意，我们在这里创建了一个lua/目录来存放我们的lua模块文件，这与普通的“Hello World”示例不同。

现在让我们在lua子目录下创建我们自己的Lua模块文件，命名为hello.lua：

local _M = {}

function _M.greet(name)
    ngx.say("Greetings from ", name)
end

return _M

看，一个很简单的Lua模块就完成了！这里的关键是：声明模块表_M，添加函数，最后返回模块表。

接下来，我们需要配置nginx.conf文件来使用这个模块：

worker_processes 1;

events {
    worker_connections 1024;
}

http {
    lua_package_path "$prefix/lua/?.lua;;";

    server {
        listen 8080 reuseport;

        location / {
            default_type text/plain;
            content_by_lua_block {
                local hello = require "hello"
                hello.greet("a Lua module")
            }
        }
    }
}

这里有几个关键点：lua_package_path指令告诉OpenResty在哪里寻找Lua模块；content_by_lua_block则是在内容生成阶段执行Lua代码。

启动应用并测试：

nginx -p $PWD/
curl 'http://127.0.0.1:8080/'