Nginx需通过OpenResty或手动集成lua-nginx-module支持Lua,配置lua_package_path、init_by_lua_block等指令启用,按access/rewrite/content/balancer/log阶段选用对应钩子,注意缓存、超时、异步及ctx共享等生产规范。

要在 Nginx 中使用 Lua 脚本扩展处理逻辑,核心前提是让 Nginx 具备执行 Lua 的能力——原生 Nginx 不支持,必须通过 OpenResty(推荐)或手动编译集成 lua-nginx-module 模块。配置生效后,即可在不同请求阶段嵌入 Lua 代码,实现鉴权、路由、改写、限流等动态逻辑。
确认 Lua 运行环境已就绪
执行以下命令验证:
-
nginx -V 2>&1 | grep -o with-http_lua_module—— 有输出说明模块已编译进 Nginx - 若用宝塔面板,需卸载默认 Nginx,改用【软件商店】中的 OpenResty 插件
- OpenResty 安装后,直接可用
openresty -v查看版本,通常已内置 LuaJIT 和常用库
在配置中启用 Lua 指令并设置路径
在 Nginx 主配置(http 块)中添加:
-
lua_package_path "/path/to/your/lua/?.lua;;";—— 指定自定义 Lua 文件搜索路径 -
init_by_lua_block { require "resty.core" }—— 启用优化引擎(OpenResty 推荐) - 如为手动编译版,还需在
http块顶部加load_module modules/ngx_http_lua_module.so;
按业务阶段选择合适的 Lua 钩子
不同阶段对应不同用途,避免混用或阻塞:
-
access_by_lua_block:请求进入 location 前执行,适合鉴权、IP 黑白名单、参数校验(失败可直接ngx.exit(403)) -
rewrite_by_lua_block:用于 URI 重写或参数注入,比如把/user/123改成/v1/user?id=123 -
content_by_lua_block:完全接管响应生成,适合 mock 接口、聚合多个子请求(ngx.location.capture) -
balancer_by_lua_block:替代静态upstream,实现动态负载均衡(如按 UID 取模选后端) -
log_by_lua_block:记录自定义日志字段,不阻塞主流程,适合打标、统计、审计
写法建议与避坑要点
生产环境稳定运行的关键细节:
- 脚本尽量无状态,高频调用函数用
local缓存,避免重复创建大表或字符串 - 禁用
lua_code_cache off仅限开发调试;上线务必开启缓存,否则性能骤降 - 涉及外部依赖(如 Redis、HTTP API)必须设超时(
set_timeout),并做错误分支处理 - 不要在
access_by_lua_block中做同步网络调用;应改用 cosocket 异步方式 - 跨阶段共享数据用
ngx.ctx,而非全局变量;需持久化状态可用lua_shared_dict


















