JS#
该模块用于在 njs 中实现处理程序——这是 JavaScript 语言的一个子集。
在我们的代码库中,该模块是
动态构建
并作为名为 默认 — location, if in location, limit_except 将 njs 函数设置为响应体过滤器。过滤函数在响应体的每个数据块上被调用,具有以下参数: HTTP 请求 对象 输入的数据块,可以是字符串或 Buffer,具体取决于 buffer_type 值,默认是字符串。 具有以下属性的对象: 过滤函数可以通过调用 r.sendBuffer() 将其修改后的输入数据块传递给下一个体过滤器。例如,要将响应体中的所有小写字母转换为小写: 要停止过滤(后续数据块将直接传递给客户端,而不调用 js_body_filter),可以使用 r.done()。 如果过滤函数更改了响应体的长度,则需要在 js_header_filter 中清除 "Content-Length" 响应头(如果有的话),以强制使用分块传输编码。 备注 由于 js_body_filter 处理程序立即返回其结果,因此仅支持同步操作。因此,不支持异步操作,例如 r.subrequest() 或 setTimeout()。 将 njs 函数设置为位置内容处理程序。可以引用模块函数。 设置用于读取和写入 Fetch API 的缓冲区大小。 指定与 Fetch API 的 HTTPS 连接启用的密码。密码的格式与 OpenSSL 库理解的格式相同。 密码列表取决于已安装的 OpenSSL 版本。可以使用 默认 http, server, location 设置通过 Fetch API 接收到的响应的最大大小。 默认 http, server, location 启用与 Fetch API 的 HTTPS 连接的指定协议。 定义与 Fetch API 的读取和写入超时。超时仅在两个连续的读/写操作之间设置,而不是针对整个响应。如果在此时间内没有传输数据,连接将被关闭。 指定用于验证与 Fetch API 的 HTTPS 证书的 PEM 格式的受信 CA 证书文件。 启用或禁用使用 Fetch API 验证 HTTPS 服务器证书。 设置与 Fetch API 的 HTTPS 服务器证书链中的验证深度。 将 njs 函数设置为响应头过滤器。该指令允许更改响应头的任意字段。 备注 由于 js_header_filter 处理程序立即返回其结果,因此仅支持同步操作。因此,不支持异步操作,例如 r.subrequest() 或 setTimeout()。 导入实现 njs 中位置和变量处理程序的模块。export_name 用作访问模块函数的命名空间。如果未指定 export_name,则将使用模块名称作为命名空间。 在这里,模块名称 可以指定多个 为 njs 模块设置额外的路径。 在配置时预加载一个不可变对象。name 用作全局变量的名称,通过该变量可以在 njs 代码中访问对象。如果未指定 name,则将使用文件名。 在这里,map 被用作访问预加载对象时的名称。 可以指定多个 js_preload_object 指令。 为指定变量设置一个 njs 函数。可以引用模块函数。 当第一次引用变量时,会调用该函数。具体的时机取决于变量被引用的 阶段。这可以用于执行一些与变量评估无关的逻辑。例如,如果变量仅在 log_format 指令中被引用,则其处理程序不会在日志阶段之前执行。这个处理程序可以在请求释放之前执行一些清理工作。 备注 由于 js_set 处理程序立即返回其结果,因此仅支持同步回调。因此,不支持异步回调,如 r.subrequest() 或 setTimeout()。 每个 HTTP njs 处理程序接收一个参数,即 请求 对象。angie-module-njs
或 angie-pro-module-njs
的单独包提供。配置示例#
http {
js_import http.js;
js_set $foo http.foo;
js_set $summary http.summary;
js_set $hash http.hash;
resolver 127.0.0.53;
server {
listen 8000;
location / {
add_header X-Foo $foo;
js_content http.baz;
}
location = /summary {
return 200 $summary;
}
location = /hello {
js_content http.hello;
}
location = /fetch {
js_content http.fetch;
js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;
}
location = /crypto {
add_header Hash $hash;
return 200;
}
}
}
http.js
文件:function foo(r) {
r.log("hello from foo() handler");
return "foo";
}
function summary(r) {
var a, s, h;
s = "JS summary\n\n";
s += "Method: " + r.method + "\n";
s += "HTTP version: " + r.httpVersion + "\n";
s += "Host: " + r.headersIn.host + "\n";
s += "Remote Address: " + r.remoteAddress + "\n";
s += "URI: " + r.uri + "\n";
s += "Headers:\n";
for (h in r.headersIn) {
s += " header '" + h + "' is '" + r.headersIn[h] + "'\n";
}
s += "Args:\n";
for (a in r.args) {
s += " arg '" + a + "' is '" + r.args[a] + "'\n";
}
return s;
}
function baz(r) {
r.status = 200;
r.headersOut.foo = 1234;
r.headersOut['Content-Type'] = "text/plain; charset=utf-8";
r.headersOut['Content-Length'] = 15;
r.sendHeader();
r.send("nginx");
r.send("java");
r.send("script");
r.finish();
}
function hello(r) {
r.return(200, "Hello world!");
}
async function fetch(r) {
let results = await Promise.all([ngx.fetch('https://google.com/'),
ngx.fetch('https://google.ru/')]);
r.return(200, JSON.stringify(results, undefined, 4));
}
async function hash(r) {
let hash = await crypto.subtle.digest('SHA-512', r.headersIn.host);
r.setReturnValue(Buffer.from(hash).toString('hex'));
}
export default {foo, summary, baz, hello, fetch, hash};
指令#
js_body_filter#
js_body_filter
function | module.function [buffer_type=
string | buffer];r
data
flags
last
— 布尔值true
— 如果数据是最后一个缓冲区。function filter(r, data, flags) {
r.sendBuffer(data.toLowerCase(), flags);
}
js_content#
js_fetch_buffer_size#
js_fetch_ciphers#
openssl ciphers
命令查看完整列表。js_fetch_max_response_buffer_size#
js_fetch_max_response_buffer_size
size;js_fetch_max_response_buffer_size 1m;
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_header_filter#
js_import#
js_import http.js;
http
被用作访问
导出的命名空间。如果导入的模块导出 foo()
,则使用
http.foo
来引用它。js_import
指令。js_path#
js_preload_object#
js_preload_object map.json;
js_set#
js_var#
请求参数#