sublime text 配 openresty 需装 lua-enhanced 和 nginx 插件,手动设置语法高亮;lua 块内须右键选 luaenhanced;ngx.req.read_body() 必须显式调用才能获取 post 参数;日志需匹配 error_log 级别且路径正确;可用 build system 自动执行 nginx -t、reload 和 curl 测试。

Sublime Text 里怎么配 OpenResty 的 Lua 语法高亮和代码补全
默认 Sublime Text 不认识 nginx.conf 里的 content_by_lua_block 或 access_by_lua_file 这类块,写 Lua 时没高亮、没缩进、也没函数提示。
解决办法是装两个插件:lua-enhanced(增强 Lua 支持)和 nginx(识别 Nginx 配置语法)。装完后手动把 .lua 文件关联到 LuaEnhanced,再把 nginx.conf 关联到 Nginx。关键一步:对 location 块里嵌入的 content_by_lua_block,需右键 → Set Syntax → LuaEnhanced 手动切换——Sublime 不会自动识别 block 内容类型。
- 别依赖“自动检测”,
content_by_lua_block里写的 Lua 就是纯文本,不切语法就等于裸写 -
lua-enhanced自带ngx.开头的 API 补全(如ngx.say、ngx.var.uri),但补全项不包含 OpenResty 4.x 新增的ngx.http.*异步接口,得自己加 snippet - 如果用了
init_by_lua_file加载全局模块,Sublime 不会跳转到对应.lua文件,别指望 Ctrl+Click 跟进去
OpenResty 脚本里读取请求参数总为空?检查 ngx.req.read_body() 是否被跳过
常见现象:用 ngx.req.get_uri_args() 拿不到 query 参数,或 ngx.req.get_post_args() 返回空表。不是 Lua 写错了,而是 OpenResty 默认不自动读请求体。
GET 请求一般没问题,但 POST/PUT 的 body 必须显式调用 ngx.req.read_body() 才能解析 form data 或 JSON。漏掉这句,get_post_args() 和 get_body_data() 全部失效,且不会报错,只默默返回 nil 或空表。
- 放在
access_by_lua_block或content_by_lua_block开头最稳妥;放在init_by_lua里完全无效 - 如果用了
proxy_pass且上游需要原始 body,调用read_body()后要再用ngx.req.get_body_data()取出来,否则 body 会被清空 - 大文件上传场景下,
read_body()可能触发磁盘临时文件(受client_body_buffer_size和client_max_body_size控制),别在高并发小包场景下盲目加大缓冲
调试 OpenResty 脚本时 ngx.log(ngx.ERR, ...) 输出看不到?查日志路径和级别
写了 ngx.log(ngx.ERR, "debug:", ngx.var.uri) 却在 error.log 里搜不到,大概率是日志路径不对,或者级别被过滤了。
OpenResty 默认把 error.log 写在 /usr/local/openresty/nginx/logs/error.log(源码编译安装)或 /opt/openresty/nginx/logs/error.log(包管理安装),但实际路径以你启动时的 -p 参数为准。另外,error_log 指令的级别必须 ≤ 日志函数级别才会输出——比如配置了 error_log logs/error.log warn;,那 ngx.log(ngx.ERR, ...) 能打出来,但 ngx.log(ngx.INFO, ...) 就静默丢弃。
- 开发期建议在
nginx.conf的http块加一行:error_log logs/error.log debug;(需重编译 OpenResty 时启用--with-debug) -
ngx.log()的第一个参数必须是常量(ngx.ERR、ngx.WARN等),不能是变量或表达式,否则直接 crash - 别在
init_by_lua里用ngx.log记录请求级信息——此时ngx.var大部分为空,且日志会混在 worker 初始化阶段,难定位
Sublime Text 保存即自动测试脚本?用 build_system 调 curl + nginx -t
改完 Lua 脚本,总得验证语法是否合法、Nginx 配置能否 reload、接口是否返回预期结果。手动敲命令太慢,可以配 Sublime 的 Build System 自动跑三步:nginx -t → nginx -s reload → curl -v http://127.0.0.1:8000/test。
建一个 OpenResty Test.sublime-build 文件,内容用 shell_cmd 串起三个命令,注意用 && 连接保证前序失败时后续不执行。重点:reload 前先 nginx -t,否则错配导致服务中断;curl 地址要和你本地监听端口、location 一致。
- Windows 下用
curl.exe路径要写绝对路径,Sublime 默认环境变量不包含C:\Program Files\curl\bin -
nginx -s reload需要 nginx 主进程 PID 文件存在,确保你之前是用nginx启动的,而不是openresty别名(某些发行版 alias 指向不同路径) - Build 输出里看到
curl: (7) Failed to connect不一定是脚本错,先ps aux | grep nginx确认 master 进程还在
真正麻烦的是跨环境差异:Sublime 在 macOS 上跑的 build system,放到 Linux 开发机就得重配路径和权限;而 OpenResty 的 Lua 模块加载路径(lua_package_path)一旦写死绝对路径,换机器就失效。这些细节不盯住,自动化反而拖慢节奏。











