JS#
该模块用于在 njs 中实现处理程序——njs 是 JavaScript 语言的一个子集。
在我们的代码库中,该模块是
动态构建的
并作为一个名为 设置将在 访问阶段 调用的 njs 函数。可以引用模块函数。 当流会话首次达到 访问阶段 时,该函数会被调用一次。该函数使用以下参数调用: 在此阶段,可以使用 s.on() 方法为每个传入的数据块执行初始化或注册回调,直到调用以下方法之一:s.done(),s.decline(),s.allow()。一旦调用了这些方法之一,流会话处理将切换到 下一个阶段,并且所有当前的 s.on() 回调将被丢弃。 设置用于读取和写入 Fetch API 的缓冲区大小。 指定 Fetch API 的 HTTPS 连接中启用的加密套件。这些加密套件以 OpenSSL 库理解的格式指定。 可使用 "openssl ciphers" 命令查看完整列表。 设置使用 Fetch API 接收的响应的最大大小。 默认值 stream, server 启用 Fetch API 的 HTTPS 连接的指定协议。 定义 Fetch API 的读取和写入超时时间。该超时时间仅在两次连续的读/写操作之间设置,而不是针对整个响应。如果在此时间内没有传输数据,连接将被关闭。 指定一个包含 PEM 格式的受信 CA 证书的文件,用于使用 Fetch API 验证 HTTPS 证书。 启用或禁用使用 Fetch API 验证 HTTPS 服务器证书。 设置 Fetch API 的 HTTPS 服务器证书链的验证深度。 设置数据过滤器。可以引用模块函数。 当流会话达到 内容阶段 时,过滤器函数会被调用一次。过滤器函数使用以下参数调用: 在此阶段,可以使用 s.on() 方法为每个传入的数据块执行初始化或注册回调。可以使用 s.off() 方法注销回调并停止过滤。 备注 由于 js_filter 处理程序立即返回其结果,因此仅支持同步操作。因此,不支持异步操作,如 ngx.fetch() 或 setTimeout()。 导入在 njs 中实现位置和变量处理程序的模块。export_name 用作访问模块函数的命名空间。如果未指定 export_name,则使用模块名称作为命名空间。 在此,模块名称 stream 被用作 可以指定多个 js_import 指令。 设置 njs 模块的附加路径。 在配置时预加载一个不可变对象。name 用作在 njs 代码中通过该名称访问对象的全局变量名。如果未指定 name,则使用文件名。 在此,map 作为访问预加载对象时使用的名称。 可以指定多个 js_preload_object 指令。 设置将在 预读取阶段 调用的 njs 函数。可以引用模块函数。 当流会话首次达到 预读取阶段 时,该函数会被调用一次。该函数使用以下参数调用: 在这个阶段,可以为每个接收到的数据块执行初始化或使用 s.on() 方法注册回调,直到调用以下方法之一:s.done()、s.decline()、s.allow()。当调用这些方法之一时,流会话将切换到 下一个阶段,并且当前所有的 s.on() 回调将被丢弃。 备注 因为 js_preread 处理器会立即返回其结果,所以它仅支持同步回调。因此,不支持像 ngx.fetch() 或 setTimeout() 这样的异步回调。不过,在 预读阶段 的 s.on() 回调中支持异步操作。 为指定变量设置 njs 函数。可以引用模块函数。 当第一次引用给定请求的变量时调用该函数。具体时机取决于引用变量的 阶段。这可以用于执行一些与变量评估无关的逻辑。例如,如果变量仅在 log_format 指令中引用,其处理器将在日志阶段之前不会被执行。这个处理器可以用于在请求释放之前进行一些清理。 备注 因为 js_set 处理器会立即返回其结果,所以它仅支持同步回调。因此,不支持像 ngx.fetch() 或 setTimeout() 这样的异步回调。 声明一个 可写 变量。值可以包含文本、变量及其组合。 每个流 njs 处理器接收一个参数,即 流会话 对象。angie-module-njs
或 angie-pro-module-njs
的独立包提供。配置示例#
stream {
js_import stream.js;
js_set $bar stream.bar;
js_set $req_line stream.req_line;
server {
listen 12345;
js_preread stream.preread;
return $req_line;
}
server {
listen 12346;
js_access stream.access;
proxy_pass 127.0.0.1:8000;
js_filter stream.header_inject;
}
}
http {
server {
listen 8000;
location / {
return 200 $http_foo\n;
}
}
}
stream.js
文件内容:var line = '';
function bar(s) {
var v = s.variables;
s.log("hello from bar() handler!");
return "bar-var" + v.remote_port + "; pid=" + v.pid;
}
function preread(s) {
s.on('upload', function (data, flags) {
var n = data.indexOf('\n');
if (n != -1) {
line = data.substr(0, n);
s.done();
}
});
}
function req_line(s) {
return line;
}
// 读取 HTTP 请求行。
// 收集 'req' 中的字节,直到
// 请求行被读取。
// 将 HTTP 头注入客户端请求
var my_header = 'Foo: foo';
function header_inject(s) {
var req = '';
s.on('upload', function(data, flags) {
req += data;
var n = req.search('\n');
if (n != -1) {
var rest = req.substr(n + 1);
req = req.substr(0, n + 1);
s.send(req + my_header + '\r\n' + rest, flags);
s.off('upload');
}
});
}
function access(s) {
if (s.remoteAddress.match('^192.*')) {
s.deny();
return;
}
s.allow();
}
export default {bar, preread, req_line, header_inject, access};
指令#
js_access#
s
js_fetch_buffer_size#
js_fetch_ciphers#
js_fetch_max_response_buffer_size#
js_fetch_protocols#
js_fetch_protocols
[TLSv1
] [TLSv1.1
] [TLSv1.2
] [TLSv1.3];js_fetch_protocols TLSv1 TLSv1.1 TLSv1.2;
js_fetch_timeout#
js_fetch_trusted_certificate#
js_fetch_verify#
js_fetch_verify_depth#
js_filter#
s
js_import#
js_import stream.js;
js_path#
js_preload_object#
js_preload_object map.json;
js_preread#
s
js_set#
js_var#
会话对象属性#