如何利用Nginx njs脚本在不重编源码下扩展逻辑功能

阿静姑娘_5815

阿静姑娘_5815

2026-04-13

229人浏览

原创

Nginx ≥1.19.5 可直接启用内置 njs,无需重编译;需确认模块加载、js_import 引入脚本、按场景选用 js_content/js_filter/js_set 等指令,脚本须 export default 导出函数,运行于受限沙箱中。

如何利用nginx njs脚本在不重编源码下扩展逻辑功能

不需要重编 Nginx 源码,只要 Nginx 版本 ≥ 1.19.5(官方内置 njs),就能直接启用并扩展逻辑功能。关键在于确认模块已加载、正确引入脚本、按场景选用合适指令。

确认 njs 模块是否已就绪

运行 nginx -V 2>&1 | grep -o 'njs',若输出 njs,说明已内置支持;若无输出,但系统为 Ubuntu/Debian,可直接安装动态模块:

  • sudo apt install libnginx-mod-http-js
  • 在 nginx.conf 最顶部添加:
    load_module modules/ngx_http_js_module.so;

CentOS/RHEL 用户若未编译过,推荐用官方预编译包或升级到较新版本(如 1.25.x),避免手动编译依赖。

用 js_import 引入外部 JS 文件

在 http 块中声明脚本位置,路径需为绝对路径或相对于配置文件的相对路径:

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载
  • js_import /etc/nginx/conf.d/auth.js;
  • 脚本内必须用 export default { funcName } 导出函数
  • 不支持 require 或 Node.js 内置模块(如 fs、net),但可使用 crypto.subtle 等 webcrypto API

按用途选对执行指令

不同指令触发时机和能力差异大,不能混用:

  • js_content:完全由 JS 生成响应,适合简单 API 或健康检查页
  • js_filter:在 location 匹配后、proxy_pass 前执行,可中断请求(如鉴权失败 r.return(403))
  • js_set:用于变量赋值,例如生成 trace-id:
    js_set $trace_id 'Date.now() + "-" + Math.random().toString(36).substr(2, 9)';
  • js_header_filter 和 js_body_filter:分别修改响应头与响应体,注意需配合清除 Content-Length

写脚本时避开常见陷阱

njs 是无状态、单次调用的沙箱环境,不是 Node.js:

  • 不要在函数外定义变量存状态(如计数器),每次请求都是全新上下文
  • 禁止同步耗时操作(如循环上万次),控制在毫秒级,否则阻塞 worker
  • 日志统一用 r.warn('msg') 或 r.error('msg'),console.log 不输出
  • 改请求头读 r.headersIn,但要发给上游需靠 proxy_set_header 配合,njs 本身不能直接写入 upstream headers

相关专题

更多
nginx 重启
nginx 重启

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

2023.07.27

423

5

nginx 配置详解
nginx 配置详解

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

2023.08.04

3847

6

nginx配置详解
nginx配置详解

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

2023.08.04

6645

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

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

537

23

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

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

2026.03.16

179

12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.2万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习