Nginx HTTP过滤模块需在响应发往客户端前插入header或body处理逻辑,通过postconfiguration注册到ngx_http_top_header_filter/body_filter链表,并正确调用下一个filter以维持链式调用。

写一个 Nginx HTTP 过滤模块不难,关键在理解它的执行位置和链式调用机制——它插在响应发给客户端之前,对 header 或 body 做轻量处理,比如加标记、改状态、注入内容。
准备开发环境与目录结构
确保你已下载并解压 Nginx 源码(如 nginx-1.24.x),且系统装有 gcc、make、pcre、zlib、openssl 开发包。在 src/ 下新建子目录,例如 src/http_myfilter:
- 放配置脚本
config:声明模块名、类型为HTTP_FILTER_MODULES、指定源文件路径 - 放 C 源文件
ngx_http_myfilter_module.c:必须与 config 中的路径一致
config 示例(注意空格和换行):
ngx_addon_name=ngx_http_myfilter_module HTTP_FILTER_MODULES="$HTTP_FILTER_MODULES ngx_http_myfilter_module" NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_myfilter_module.c"
定义模块结构体与配置上下文
每个过滤模块必须提供 ngx_module_t 实例,其中 ctx 字段指向 ngx_http_module_t 类型的上下文,用于挂载配置解析和初始化逻辑。
-
create_loc_conf分配配置内存(如是否启用、前缀字符串等) -
merge_loc_conf合并 location 级配置(父块与子块冲突时取子块优先) -
postconfiguration是关键入口:在此处把你的过滤函数注册到全局链表
注册方式是保存上一个 filter 的函数指针,并把自己设为新的 ngx_http_top_header_filter 或 ngx_http_top_body_filter。
实现 header 和 body 过滤函数
HTTP 过滤器分两类处理点:头部只走一次,body 可能分多次传输(如大文件、流式响应)。需用状态字段(如 add_prefix_flag)避免重复操作。
-
header_filter:可修改r->headers_out.status、添加 header(ngx_table_elt_t*)、或直接返回NGX_ERROR中断响应 -
body_filter:接收ngx_chain_t *链表,可插入新 buffer、修改现有 buffer 内容、或跳过部分数据 - 务必调用保存的
ngx_http_next_header_filter或ngx_http_next_body_filter,否则链路中断
编译与验证模块
进入 Nginx 源码根目录,运行 configure 加入你的模块:
./configure --add-module=src/http_myfilter --prefix=/opt/nginx-test
执行 make && make install。启动后检查 objs/ngx_modules.c 是否包含你的模块名;再在配置中启用(如 myfilter on;),用 curl 观察响应头或 body 是否按预期变化。
常见问题包括:函数未正确链入导致无效果、buffer 内存未用 ngx_palloc 分配引发崩溃、忘记调用下一个 filter 导致响应卡死。


















