[Nginx] 利用njs模块在nginx配置中引入js脚本

• 前言
  
• 一 安装 NJS 模块
  
  
  
  • 方法一: 动态加载 NJS 模块
    
  • 方法二: 编译时增加模块
    
  
  
• 二 NJS模块运行环境的特点
  
• 三 NJS 模块支持的指令及对应的处理阶段
  
• 四 NJS 的简单用法示例
  
• 五 NJS 支持的指令
  
• 参考资料
  
• 总结
  

• 将 ngx_http_js_module.so 文件放在nginx 根目录的 modules 目录下,
  
• 在 nginx.conf 中增加引入模块
  

load_module modules/ngx_http_js_module.so;
load_module modules/ngx_stream_js_module.so;

hg clone  http://hg.nginx.org/njs

./configure --add-module=<path to njs>/njs/nginx

// 文件位置: [nginx根目录]/conf/logging.js
// 文件内容: 解析请求, 打印出所有的请求头
 
function logAllHeaders(r) {
  var log = `${r.variables.time_iso8601} client=${r.remoteAddress} method=${r.method} uri=${r.uri} status=${r.status}`;
  r.rawHeadersIn.forEach(h => log += ` in.${h[0]}=${h[1]}`);
  r.rawHeadersOut.forEach(h => log += ` out.${h[0]}=${h[1]}`);
  return log;
}
 
export default { logAllHeaders }

# nginx 的配置文件
 
http {
   js_import  logging.js;    # js_import 加载一个 js 脚本, 该文件放在nginx 配置文件的目录下. js 的文件名会作为该模块的命名空间. 引用函数时可以通过[文件名].[函数名]的方式来引用
   js_set   $log_all_headers logging.logAllHeaders; # js_set 把js文件中的函数 logAllHeaders 的输出保存到变量 $log_all_headers.
   log_format kvpairs $log_all_headers;      # 自定义一种日志格式 kvpairs
  server {
    listen 80;
    access_log /var/log/nginx/access.log kvpairs; # 设置该规则下的日志格式为上面自定义的格式
    root /usr/share/nginx/html;
  }
}

Syntax: js_body_filter function | module.function [buffer_type=string | buffer];
Default:  —
Context:  location, limit_except
This directive appeared in version 0.5.2.

/**
* 处理 response body 的函数
* @param { object } r - http 对象
* @param { buffer_type } data - 请求的 body 的数据
* @param { boolean } flags - 是否是最后一个数据块
*/
 
function filter(r, data, flags) {
  r.sendBuffer(data.toLowerCase(), flags);
}

Syntax: js_content function | module.function;
Default:  —
Context:  location, limit_except

http {
  # 引入 js 模块
  js_import  http.js;         
  server {
    listen 80;
    location /content {
      # 通过 js_content 指令指定要执行的 js 函数
      js_content http.content;
    }
  }
}

// http.js 文件
function content(r) {
  r.status = 200;
  r.headersOut['Content-Type'] = "text/plain; charset=utf-8";
  r.headersOut['Content-Length'] = 12;
  r.sendHeader();
  r.send("I am content");
  r.finish()
}
 
export default { content }

Syntax: js_header_filter function | module.function;
Default:  —
Context:  location, limit_except
This directive appeared in version 0.5.1.

Syntax: js_import module.js | export_name from module.js;
Default:  —
Context:  http
This directive appeared in version 0.4.0.

http {
  # 引入 js 模块. 文件名会作为该模块的命名空间. 引用函数时可以通过[文件名].[函数名]的方式来引用
  js_import  http.js;         
  server {
    listen 80;
    location /content {
      # 通过 js_content 指令指定要执行的 js 函数
      js_content http.content;
    }
  }
}

Syntax: js_set $variable function | module.function;
Default:  —
Context:  http

• NJS 支持的js语法: https://nginx.org/en/docs/njs/compatibility.html?_ga=2.128028686.301589667.1638621670-451035464.1638621670
  
• Harnessing the Power and Convenience of JavaScript for Each Request with the NGINX JavaScript Module:  https://www.nginx.com/blog/harnessing-power-convenience-of-javascript-for-each-request-with-nginx-javascript-module
  
• NJS模块文档: http://nginx.org/en/docs/http/ngx_http_js_module.html#example
  
• 源码: https://hg.nginx.org/njs/?_ga=2.99259804.301589667.1638621670-451035464.1638621670
  
• NJS 内置的对象, 方法, 函数: https://nginx.org/en/docs/njs/reference.html
  
• NJS 用法示例: https://github.com/nginx/njs-examples/#hello-world-example-http-hello