Nginx 模块开发初探:利用 ngx_http_handler_pt 编写第一个自定义内容生成器

小瑶大大_7202

小瑶大大_7202

2026-04-29

585人浏览

原创

Nginx Handler模块必须将ngx_http_handler_pt函数赋给ngx_http_module_t的handler字段,并在匹配的location中通过自定义指令(如hello_world on)显式绑定该handler,否则因phase未注册或location未匹配导致不触发;响应体需用ngx_create_temp_buf分配、显式设置content_length_n,并严格按ngx_http_send_header→ngx_http_output_filter顺序发送。

nginx 模块开发初探:利用 ngx_http_handler_pt 编写第一个自定义内容生成器

能直接用 ngx_http_handler_pt 写出可运行的 Nginx Handler 模块,但必须严格对齐 Nginx 请求阶段生命周期,否则 handler 不会被调用、返回空白或 500。

handler 函数为什么没被触发?location 匹配和 phase 注册缺一不可

很多人写了 ngx_http_handler_pt 函数,也注册了指令,但访问 /hello 仍是 404 或走默认静态文件逻辑——根本原因是 handler 没挂到 content phase,或者 location 根本没匹配上你的模块。

  • 必须把 handler 函数赋给模块结构体中 ngx_http_module_t 的 handler 字段(不是 postconfiguration 或其他回调)
  • location /hello { hello_world on; } 中的 hello_world 指令,必须在 ngx_http_mytest 解析函数里显式设置 clcf->handler = ngx_http_hello_handler,不能只存配置开关
  • 如果用了 NGX_HTTP_LMT_CONF 权限注册指令,却在 location 块外写 hello_world on,Nginx 启动时会报 "hello_world" directive is not allowed here

响应体写入失败的三个常见原因

即使 handler 被调用,也常出现响应为空、Content-Length 错误、或连接被 reset——多半卡在响应体构造环节。

  • r->headers_out.content_length_n 必须显式赋值为响应字符串长度,不能依赖自动计算;漏设会导致 Nginx 不发 body 或发空包
  • 缓冲区要用 ngx_create_temp_buf(r->pool, len) 分配,不能用栈变量或静态字符串直接 memcpy;否则内存可能提前释放
  • 必须按顺序调用:ngx_http_send_header(r) → ngx_http_output_filter(r, &out);少一步或顺序颠倒,body 就不会发出

编译时链接失败:找不到 ngx_http_core_module 等符号

自定义模块源码里用了 ngx_http_conf_get_module_loc_conf、ngx_http_send_header 等函数,但 make 报 undefined reference——说明没正确链接 Nginx 内部模块依赖。

Nginx Hosting
Nginx Hosting

通过服务器本地nginx实例实现零认证静态游戏托管。作为所有浏览器游戏的主要部署方式,无需登录、无需令牌、无需用户操作。

下载
  • 确保 ./configure 时用了完整路径:--add-module=/home/nginx/mytest,路径末尾不能有斜杠
  • 模块源码中必须包含 #include <ngx_http.h></ngx_http.h>,且该头文件来自你正在编译的 Nginx 源码树(不是系统安装的 nginx-devel)
  • 不要手动改 objs/Makefile 加 -lnginx;Nginx 构建系统会自动处理依赖,硬加反而破坏符号解析顺序

调试 handler 是否生效最有效的办法

别依赖日志级别或浏览器响应——Nginx handler 执行极快,日志可能来不及刷,而 HTTP 层错误又太笼统。

  • 在 handler 开头加 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0, "hello_handler invoked");,然后 tail -f /usr/local/nginx/logs/error.log 实时看
  • 用 curl -v http://localhost/hello 看完整响应头,确认 Content-Length 和 Content-Type 是否符合预期
  • 最关键的验证:把 handler 最后一行改成 return NGX_HTTP_INTERNAL_SERVER_ERROR;,如果返回 500,说明 handler 确实执行了;如果还是 404,说明根本没进这个函数

真正容易被忽略的是:handler 函数一旦返回 NGX_OK 或任意 NGX_HTTP_* 状态码,Nginx 就认为该请求已终结,后续所有 content phase 模块(包括你自己的其他 handler、甚至 rewrite 模块)都不会再运行。这意味着它不是“插件”,而是“接管者”——设计时必须想清楚是否要完全替代默认行为。

相关文章

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

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

下载

相关标签:

nginx

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

相关专题

更多
nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.27

423

5

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3807

6

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

2023.08.04

6585

6

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

581

5

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.07.09

1496

5

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

2024.08.07

3978

3

nginx部署php项目教程汇总
nginx部署php项目教程汇总

本专题整合了nginx部署php项目教程汇总,阅读专题下面的文章了解更多详细内容。

2026.01.13

122

12

nginx配置文件详细教程
nginx配置文件详细教程

本专题整合了nginx配置文件相关教程详细汇总,阅读专题下面的文章了解更多详细内容。

2026.01.13

517

23

Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建
Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建

本指南详解Nginx在Windows、macOS及Linux系统的安装全流程。涵盖官方包解压、Homebrew一键部署、APT/YUM源配置及Docker容器化方案。无论新手或开发者,均可快速搭建运行环境,掌握跨平台核心指令,为后续配置与调优奠定坚实基础。

2026.03.16

179

12

热门下载

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

精品课程

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

共0课时 | 0人学习

nginx手册
nginx手册

共0课时 | 0人学习

进程与SOCKET
进程与SOCKET

共6课时 | 0.5万人学习