如何利用 ngx_http_addition_module 在响应内容前后自动注入公共页脚页头

舞姬之光

舞姬之光

2026-05-23

899人浏览

原创

ngx_http_addition_module是nginx官方标准模块,用于在200响应且content-type为text/html的响应体前后插入静态html文件,需编译启用、禁用gzip、配合root/alias正确配置路径。

如何利用 ngx_http_addition_module 在响应内容前后自动注入公共页脚页头

ngx_http_addition_module 是 Nginx 官方提供的标准模块(需编译时启用 --with-http_addition_module),可用于在响应体的开头(add_before_body)或结尾(add_after_body)插入静态内容,常用于添加公共页头、页脚、统计代码或 SEO 元素。

确认模块已启用并配置基础位置块

该模块仅作用于 200 响应且 Content-Type 为 text/html 的请求(默认行为)。需确保目标 location 匹配 HTML 资源,并开启模块指令:

  • 检查 Nginx 是否含此模块:nginx -V 2>&1 | grep -- '--with-http_addition_module'
  • 在 server 或 location 块中启用:addition_types text/html;(若后端返回的 HTML 的 Content-Type 含 charset,如 text/html; charset=utf-8,也建议显式加上)
  • 确保响应未被压缩(gzip on 时,addition 模块不生效);如需压缩,应在 addition 处理之后再压缩,即把 gzip on 放在 addition 指令之后(但更稳妥方式是关闭 gzip 或用 sub_filter + gzip_static 替代)

注入外部 HTML 文件作为页头页脚

使用 add_before_bodyadd_after_body 指令指定本地文件路径(相对于 Nginx 的 prefix,通常是 /usr/share/nginx/html/ 或自定义 root):

  • add_before_body /includes/header.html; → 插入到响应体最前面
  • add_after_body /includes/footer.html; → 插入到响应体最后面
  • 对应文件需放在 Nginx 可读目录下,例如:/usr/share/nginx/html/includes/header.html
  • 注意:这些文件必须是纯静态 HTML,不支持服务端解析(如 SSI、PHP);若需动态内容,应由上游应用生成,或改用 sub_filter + 占位符方案

配合 root 和 alias 确保文件可访问

addition 指令中的路径是按 Nginx 的文件查找逻辑解析的,依赖当前上下文的 rootalias 设置:

  • 若 location 使用 root /var/www/site;,则 add_before_body /includes/header.html 实际读取 /var/www/site/includes/header.html
  • 若使用 alias /var/www/site/includes/;,则 add_before_body header.html 才指向正确路径(注意:alias 下不能以 / 开头)
  • 建议统一用 root + 绝对路径前缀,并验证文件权限(Nginx worker 进程需有读取权限)

注意事项与常见问题

该模块轻量但限制明确,实际使用需避开典型陷阱:

  • 不支持 HTTPS 回源或代理响应的自动注入(只处理 Nginx 自己发出的 200 HTML 响应)
  • 若上游返回 Content-Encoding: gzip,addition 不触发 —— 必须确保响应未压缩,或在 upstream 关闭 gzip
  • 无法注入 内容(如 meta、link);如需修改 head,应使用 sub_filter 替换 前的内容
  • 注入内容会原样追加,不校验 HTML 结构完整性;确保 header.html 以 <header></header> 开始、footer.html 以 结束等,避免破坏 DOM
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

更多
nginx 重启
nginx 重启

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

2023.07.27

339

5

nginx 配置详解
nginx 配置详解

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

2023.08.04

1703

6

nginx配置详解
nginx配置详解

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

2023.08.04

2101

6

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

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

2024.02.23

415

5

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

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

2024.07.09

1239

5

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

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

2024.08.07

3807

3

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

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

2026.01.13

102

12

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

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

2026.01.13

272

23

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

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

2026.03.16

107

12

热门下载

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

精品课程

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

共6课时 | 54.4万人学习

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

共89课时 | 131.8万人学习