如何开发一个 Nginx 头部过滤模块修改后端返回的 Header

冬浩同学_9156

冬浩同学_9156

2026-04-09

896人浏览

原创

最常用且推荐的方式是使用 output filter 模块在 header_filter 阶段修改 upstream 响应头,通过注册 ngx_http_output_header_filter_pt 类型函数到 ngx_http_top_header_filter 链表,安全读写 r->headers_out.* 中的 header 链表。

如何开发一个 nginx 头部过滤模块修改后端返回的 header

开发一个 Nginx 模块来修改后端返回的响应头(即 upstream 响应头),最常用且推荐的方式是使用 output filter 模块,在 HTTP 响应体发送给客户端前拦截并修改 header。Nginx 官方不提供直接“编辑响应头”的高级 API,需通过底层 filter 链机制实现。

理解关键时机:header_filter_handler

Nginx 的响应处理分为两个主要过滤阶段:header_filter 和 body_filter。要修改响应头(如 Set-Cookie、Location、X-Backend-Version 等),必须在 header_filter 阶段介入 —— 此时响应状态行和 headers 已由 upstream 生成完毕,但尚未发送给客户端。

  • 该阶段回调函数类型为 ngx_http_output_header_filter_pt
  • 模块需注册到 ngx_http_top_header_filter 链表头部,确保最早执行(或按需控制顺序)
  • 可安全读写 r->headers_out.* 中的 header 链表(如 headers_out.server、headers_out.set_cookie)
  • 注意:不能在此阶段调用 ngx_http_send_header() 或触发发送;仅做修改,Nginx 后续自动序列化发送

核心步骤:编写最小可运行模块

以修改 Server 头为例,展示精简结构(C 语言):

  • 定义配置结构(即使无配置项,也建议保留)
  • 实现 ngx_http_foo_header_filter 函数:检查 r->headers_out.server 是否存在,替换其值
  • 实现 ngx_http_foo_body_filter(可为空,但需声明,否则可能跳过 header_filter)
  • 注册 handler:ngx_http_next_header_filter = ngx_http_top_header_filter; ngx_http_top_header_filter = ngx_http_foo_header_filter;
  • 在 ngx_http_foo_module_ctx 中挂载这两个 filter,并在 postconfiguration 回调中完成链表注入

修改特定 Header 的实用技巧

不同 header 的操作方式略有差异,因 Nginx 内部存储结构不同:

  • 简单字符串 header(如 Server、X-Powered-By):r->headers_out.server->value 是 ngx_str_t,可用 ngx_str_set() 或 ngx_copy 赋新值,再调用 ngx_http_clear_content_length(r)(若影响长度)
  • 多值 header(如 Set-Cookie):r->headers_out.set_cookie 是单链表指针,需遍历 r->headers_out.set_cookie->next,对每个节点的 value 做原地修改或替换整个节点(用 ngx_list_push + ngx_http_clear_last_modified 等辅助)
  • 删除 header:设对应字段为 NULL(如 r->headers_out.server = NULL),或调用 ngx_table_elt_t *h = ...; h->hash = 0; 标记忽略
  • 添加新 header:用 ngx_list_push(&r->headers_out.headers) 创建新 ngx_table_elt_t,填充 key、value、hash,并确保 hash != 0

编译与验证要点

模块需作为动态模块(.so)或静态编入 Nginx:

  • 动态模块:Nginx ≥ 1.9.11,编译时加 --add-dynamic-module=/path/to/module,配置中用 load_module modules/ngx_http_foo_filter_module.so;
  • 配置启用:在 http、server 或 location 块中添加指令(如有),例如 foo_header_filter on;
  • 调试建议:开启 error_log /path/error.log debug;,在 filter 函数中用 ngx_log_debug 打印 r->headers_out.* 结构,确认修改生效
  • 验证方法:用 curl -I http://your.site 查看响应头变化;注意浏览器可能缓存 header,优先用 curl 或清除缓存测试
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

更多
nginx 重启
nginx 重启

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

2023.07.27

423

5

nginx 配置详解
nginx 配置详解

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

2023.08.04

4107

6

nginx配置详解
nginx配置详解

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

2023.08.04

6965

6

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

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

2024.02.23

601

5

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

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

2024.07.09

1516

5

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

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

2024.08.07

3998

3

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

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

2026.01.13

122

12

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

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

2026.01.13

557

23

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

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

2026.03.16

179

12

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习