如何使用 ngx_http_addition_module 实现在响应前后自动追加公共页脚页头

小瑶大大_7202

小瑶大大_7202

2026-04-29

470人浏览

原创

ngx_http_addition_module 是 Nginx 官方过滤模块,支持在 text/html 响应体首尾插入静态文件(如页头页脚),需编译启用,不支持变量、SSI、Lua 及压缩响应,须注意 MIME 类型与 HTML 结构合法性。

如何使用 ngx_http_addition_module 实现在响应前后自动追加公共页脚页头

ngx_http_addition_module 是 Nginx 官方提供的一个过滤模块,支持在响应体的开头(add_before_body)和结尾(add_after_body)插入静态内容,常用于添加统一的页头(header)、页脚(footer)、统计代码或免责声明等。它只对 200 响应且 Content-Type 为 text/html 的页面生效(默认行为),不适用于 JSON、CSS、JS 或二进制响应。

启用模块并确认支持

该模块不是默认编译进所有 Nginx 版本的。需确认你的 Nginx 已启用:

  • 执行 nginx -V 2>&1 | grep -o with-http-addition-module,若输出存在则已编译支持;
  • 若未启用,需重新编译 Nginx 并添加 --with-http-addition-module 参数;
  • OpenResty 默认包含此模块,无需额外编译。

配置 add_before_body 和 add_after_body

在 location 块中使用,指定要插入的本地文件路径(相对 Nginx 配置目录)或 URI(需配合 addition_types 和后端支持):

  • add_before_body /includes/header.html; —— 插入页头 HTML 文件(路径相对于 root 或 alias);
  • add_after_body /includes/footer.html; —— 插入页脚 HTML 文件;
  • 确保 /includes/header.html 和 /includes/footer.html 可被 Nginx 读取(权限正确、路径存在);
  • 注意:Nginx 不会解析插入文件中的 SSI、变量或 Lua 代码,仅作纯文本拼接。

控制生效范围与 MIME 类型

默认只处理 text/html 响应。如需支持其他类型(例如 application/xhtml+xml),需显式声明:

  • addition_types text/html application/xhtml+xml;
  • 可放在 http、server 或 location 块中,作用域内生效;
  • 避免对 API 接口(如 /api/)启用,否则可能破坏 JSON 格式 —— 应用在明确的 HTML 页面 location 下,例如 location / { ... } 或 location ~ \.html$ { ... }。

常见问题与注意事项

该模块简单但有明确限制,使用时需留意:

  • 不支持动态内容:无法嵌入 $uri、$arg_* 等变量,也不能执行 Lua 或 SSI;如需动态页脚,应改用 sub_filter + 后端模板,或用 OpenResty 的 content_by_lua_block;
  • 响应必须是未压缩的:若启用了 gzip on,addition 模块会在压缩前插入,但部分客户端可能因 HTML 结构异常报错 —— 建议关闭 gzip 或确保插入内容合法闭合;
  • 不处理 304、错误页(4xx/5xx)、代理响应中禁用 addition 的上游设置;
  • 插入内容需符合 HTML 结构逻辑,例如不要在 外直接写 <script></script>,避免破坏渲染。
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

更多
nginx 重启
nginx 重启

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

2023.07.27

403

5

nginx 配置详解
nginx 配置详解

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

2023.08.04

3787

6

nginx配置详解
nginx配置详解

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

2023.08.04

6565

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

159

12

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 134万人学习