基于Sublime Text与OpenResty的网关脚本

P粉328763957

P粉328763957

2026-07-05

836人浏览

原创

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

基于sublime text与openresty的网关脚本

Sublime Text 里怎么配 OpenResty 的 Lua 语法高亮和代码补全

默认 Sublime Text 不认识 nginx.conf 里的 content_by_lua_blockaccess_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.sayngx.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_blockcontent_by_lua_block 开头最稳妥;放在 init_by_lua 里完全无效
  • 如果用了 proxy_pass 且上游需要原始 body,调用 read_body() 后要再用 ngx.req.get_body_data() 取出来,否则 body 会被清空
  • 大文件上传场景下,read_body() 可能触发磁盘临时文件(受 client_body_buffer_sizeclient_max_body_size 控制),别在高并发小包场景下盲目加大缓冲

调试 OpenResty 脚本时 ngx.log(ngx.ERR, ...) 输出看不到?查日志路径和级别

写了 ngx.log(ngx.ERR, "debug:", ngx.var.uri) 却在 error.log 里搜不到,大概率是日志路径不对,或者级别被过滤了。

Nginx
Nginx

在宝塔面板中轻松管理Nginx高性能Web服务器。提供可视化配置反向代理、负载均衡、SSL证书及HTTP缓存功能,一键优化高并发性能,助您高效搭建稳定、快速的网站运行环境。

下载

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.confhttp 块加一行:error_log logs/error.log debug;(需重编译 OpenResty 时启用 --with-debug
  • ngx.log() 的第一个参数必须是常量(ngx.ERRngx.WARN 等),不能是变量或表达式,否则直接 crash
  • 别在 init_by_lua 里用 ngx.log 记录请求级信息——此时 ngx.var 大部分为空,且日志会混在 worker 初始化阶段,难定位

Sublime Text 保存即自动测试脚本?用 build_systemcurl + nginx -t

改完 Lua 脚本,总得验证语法是否合法、Nginx 配置能否 reload、接口是否返回预期结果。手动敲命令太慢,可以配 Sublime 的 Build System 自动跑三步:nginx -tnginx -s reloadcurl -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)一旦写死绝对路径,换机器就失效。这些细节不盯住,自动化反而拖慢节奏。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

nginx sublime sublime text

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
li是什么元素
li是什么元素

li是HTML标记语言中的一个元素,用于创建列表。li代表列表项,它是ul或ol的子元素,li标签的作用是定义列表中的每个项目。本专题为大家li元素相关的各种文章、以及下载和课程。

2023.08.03

596

5

Qt Creator按钮响应设置方法
Qt Creator按钮响应设置方法

信号槽是 Qt 开发的核心机制。本专题整理 Qt Creator 中按钮点击、菜单触发、输入变化、窗口事件、自定义信号、自动连接槽函数和手动 connect 写法,帮助用户理解界面控件如何和 C++ 代码联动。

2026.08.05

0

10

Qt Creator新建项目使用教程
Qt Creator新建项目使用教程

本专题整理 Qt Creator 新建项目、打开已有工程、项目模板选择、目录结构、源文件管理、构建目录、运行配置和项目迁移方法,重点解决新手不知道选 qmake 还是 CMake、项目打不开、文件不参与编译等常见问题。

2026.08.05

0

10

maven常用插件使用大全
maven常用插件使用大全

PHP中文网精心整理Maven主流插件用法合集,涵盖编译、测试、打包等常用插件使用大全。从基础配置到进阶实战,详细解析各插件功能与适用场景,助你轻松掌握Maven自动化构建,解决Java项目开发痛点,是开发者必备的实用指南。

2026.08.05

0

31

PyCharm快速入门指南
PyCharm快速入门指南

本专题汇总了PyCharm快速入门的全套指南与教程,涵盖从官网下载安装、创建第一个Python项目、配置虚拟环境,到代码编辑、运行调试等基础操作,并整理了版本控制(Git)集成、常用高效快捷键及实用插件等进阶技巧,助你快速上手这款高效的Python IDE。

2026.08.05

2

17

PyCharm运行程序教程大全
PyCharm运行程序教程大全

本专题汇总了PyCharm运行程序的多种方式与详细操作步骤,涵盖通过主菜单Run、点击工具栏绿色三角图标、使用快捷键Shift+F10(或Ctrl+Shift+F10)等基本运行方法,以及配置运行/调试参数、设置PYTHONPATH环境变量、管理多脚本运行与交互式Python控制台调试等进阶技巧,助您全面掌握在PyCharm中高效运行与管理Python程序的方法。

2026.08.05

0

14

Maven零基础入门教程
Maven零基础入门教程

本合集由PHP中文网精心整理,提供Maven零基础入门到完整使用的保姆级教程。内容涵盖环境安装、核心配置、仓库管理及项目构建等核心知识点。通过详细步骤解析与代码示例,助你快速掌握Maven的依赖管理与自动化构建,轻松解决Java项目中的各种痛点,是新手入门与进阶的必备指南。

2026.08.05

2

18

Maven安装及配置教程
Maven安装及配置教程

本合集由PHP中文网精心整理,提供Maven安装配置与环境配置详情指南。内容涵盖Maven下载、解压安装、环境变量配置、阿里云镜像加速及本地仓库修改等全流程。教程通俗易懂,帮助开发者轻松解决依赖管理难题,快速掌握Maven核心构建技能,是Java开发者的必备实战指南。

2026.08.05

2

24

Selenium WebDriver元素定位与页面操作教程
Selenium WebDriver元素定位与页面操作教程

本专题整理Selenium WebDriver元素定位、XPath、CSS Selector、等待机制、窗口切换、Frame处理、Alert弹窗、Cookie操作和文件上传等核心用法。

2026.08.05

8

26

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程