njs 脚本语言

njs 是 JavaScript 语言的一个子集，允许扩展 nginx 功能。njs 遵循 ECMAScript 5.1（严格模式），并带有一些 ECMAScript 6 和更新的扩展。兼容性仍在 演进中。

• 下载并安装
• 变更
• 参考
• 示例
• 安全
• 兼容性
• 命令行界面
• 理解预加载对象
• 已测试的操作系统和平台

• ngx_http_js_module
• ngx_stream_js_module

• 使用 TypeScript 定义文件编写 njs 代码
• 使用 node 模块与 njs

用例

• njs 中复杂的访问控制和安全检查，使请求在上游服务器之前到达
• 操作响应头
• 编写灵活的异步内容处理程序和过滤器

更多 njs 使用案例，请参见 示例 和 博客文章。

基本 HTTP 示例

要在 nginx 中使用 njs：

• 安装 njs 脚本语言

• 创建一个 njs 脚本文件，例如，http.js。请参阅 参考 获取 njs 属性和方法列表。

  function hello(r) {
      r.return(200, "Hello world!");
  }
  
  export default {hello};
  

• 在 nginx.conf 文件中启用 ngx_http_js_module 模块，并指定 js_import 指令与 http.js 脚本文件：

  load_module modules/ngx_http_js_module.so;
  
  events {}
  
  http {
      js_import http.js;
  
      server {
          listen 8000;
  
          location / {
              js_content http.hello;
          }
      }
  }
  

还有一个独立的命令行实用程序，可用于独立于nginx进行njs开发和调试。

已测试的操作系统和平台

• FreeBSD / amd64；
• Linux / x86, amd64, arm64, ppc64el；
• Solaris 11 / amd64；
• macOS / x86_64；

在nginx.conf 2018上的演示