模块 ngx_http_js_module

ngx_http_js_module 模块用于在 njs（JavaScript 语言的一个子集）中实现 location 和变量处理器。

下载和安装说明在此处提供。

该示例自 0.4.0 版本起生效。

http {
    js_import http.js;

    js_set $foo     http.foo;
    js_set $summary http.summary;
    js_set $hash    http.hash;

    resolver 10.0.0.1;

    server {
        listen 8000;

        location / {
            add_header X-Foo $foo;
            js_content http.baz;
        }

        location = /summary {
            return 200 $summary;
        }

        location = /hello {
            js_content http.hello;
        }

        # since 0.7.0
        location = /fetch {
            js_content                   http.fetch;
            js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;
        }

        # since 0.7.0
        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!");
}

// since 0.7.0
async function fetch(r) {
    let results = await Promise.all([ngx.fetch('https://nginx.ac.cn/'),
                                     ngx.fetch('https://nginx.ac.cn/en/')]);

    r.return(200, JSON.stringify(results, undefined, 4));
}

// since 0.7.0
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};

将 njs 函数设置为响应体过滤器。对于响应体的每个数据块，都会调用过滤器函数，并带有以下参数

r

HTTP 请求对象

data

传入的数据块，可以是字符串或 Buffer，具体取决于 buffer_type 的值，默认为字符串。自 0.8.5 版本起，data 值默认情况下会隐式转换为有效的 UTF-8 字符串。对于二进制数据，应将 buffer_type 值设置为 buffer。

flags

具有以下属性的对象

last

布尔值，如果 data 是最后一个缓冲区，则为 true。

过滤器函数可以通过调用 r.sendBuffer() 将其修改后的输入数据块版本传递给下一个体过滤器。例如，要转换响应体中的所有小写字母

function filter(r, data, flags) {
    r.sendBuffer(data.toLowerCase(), flags);
}

要停止过滤（后续数据块将传递给客户端，而不会调用 js_body_filter），可以使用 r.done()。

如果过滤器函数更改了响应体的长度，则需要清除“Content-Length”响应头（如果有）js_header_filter 以强制使用分块传输编码。

由于 js_body_filter 处理程序会立即返回其结果，因此它仅支持同步操作。因此，不支持异步操作，例如 r.subrequest() 或 setTimeout()。

自 0.7.7 版本起，此指令可以在 if 块内指定。

将 njs 函数设置为 location 内容处理器。自 0.4.0 版本起，可以引用模块函数。

自 0.7.7 版本起，此指令可以在 if 块内指定。

js_context_reuse 128;

设置要为 QuickJS 引擎 重用的 JS 上下文的最大数量。每个上下文用于单个请求。完成的上下文将放入可重用上下文的池中。如果池已满，则会销毁上下文。

js_engine njs;

设置要用于 njs 脚本的 JavaScript 引擎。njs 参数设置 njs 引擎，也是默认使用的引擎。qjs 参数设置 QuickJS 引擎。

js_fetch_buffer_size 16k;

设置用于使用 Fetch API 进行读写操作的缓冲区的 size。

js_fetch_ciphers HIGH:!aNULL:!MD5;

为使用 Fetch API 的 HTTPS 请求指定启用的密码。密码采用 OpenSSL 库理解的格式指定。

可以使用“openssl ciphers”命令查看完整列表。

js_fetch_max_response_buffer_size 1m;

设置使用 Fetch API 接收的响应的最大 size。

js_fetch_protocols TLSv1 TLSv1.1 TLSv1.2;

为使用 Fetch API 的 HTTPS 请求启用指定的协议。

js_fetch_timeout 60s;

定义 Fetch API 的读写超时。超时仅在两个连续的读/写操作之间设置，而不是针对整个响应设置。如果在此时间内未传输任何数据，则连接将关闭。

指定一个包含 PEM 格式的可信 CA 证书的 file，用于使用 Fetch API 验证 HTTPS 证书。

js_fetch_verify on;

启用或禁用使用 Fetch API 验证 HTTPS 服务器证书。

js_fetch_verify_depth 100;

设置使用 Fetch API 的 HTTPS 服务器证书链中的验证深度。

将 njs 函数设置为响应头过滤器。此指令允许更改响应头的任意头字段。

由于 js_header_filter 处理程序会立即返回其结果，因此它仅支持同步操作。因此，不支持异步操作，例如 r.subrequest() 或 setTimeout()。

自 0.7.7 版本起，此指令可以在 if 块内指定。

导入在 njs 中实现 location 和变量处理器的模块。export_name 用作访问模块函数的命名空间。如果未指定 export_name，则模块名称将用作命名空间。

js_import http.js;

此处，模块名称 http 用于在访问导出时用作命名空间。如果导入的模块导出 foo()，则使用 http.foo 来引用它。

可以指定多个 js_import 指令。

自 0.7.7 版本起，此指令可以在 server 和 location 级别指定。

指定在 njs 中实现 location 和变量处理器的文件

nginx.conf:
js_include http.js;
location   /version {
    js_content version;
}

http.js:
function version(r) {
    r.return(200, njs.version);
}

此指令在 0.4.0 版本中已弃用，并在 0.7.1 版本中删除。应改用 js_import 指令。

为 njs 模块设置其他路径。

自 0.7.7 版本起，此指令可以在 server 和 location 级别指定。

指定定期运行的内容处理器。处理器接收 会话对象 作为其第一个参数，它还可以访问全局对象，例如 ngx。

可选的 interval 参数设置两次连续运行之间的间隔，默认为 5 秒。

可选的 jitter 参数设置 location 内容处理器将随机延迟的时间，默认为没有延迟。

默认情况下，js_handler 在工作进程 0 上执行。可选的 worker_affinity 参数允许指定 location 内容处理器应在其中执行的特定工作进程。每个工作进程集都由允许的工作进程的位掩码表示。all 掩码允许在所有工作进程中执行处理器。

示例

example.conf:

location @periodics {
    # to be run at 1 minute intervals in worker process 0
    js_periodic main.handler interval=60s;

    # to be run at 1 minute intervals in all worker processes
    js_periodic main.handler interval=60s worker_affinity=all;

    # to be run at 1 minute intervals in worker processes 1 and 3
    js_periodic main.handler interval=60s worker_affinity=0101;

    resolver 10.0.0.1;
    js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;
}

example.js:

async function handler(s) {
    let reply = await ngx.fetch('https://nginx.ac.cn/en/docs/njs/');
    let body = await reply.text();

    ngx.log(ngx.INFO, body);
}

在配置时预加载 不可变对象。name 用作全局变量的名称，通过该变量可以在 njs 代码中访问该对象。如果未指定 name，则将使用文件名代替。

js_preload_object map.json;

此处，map 用于在访问预加载对象时用作名称。

可以指定多个 js_preload_object 指令。

为指定的 variable 设置 njs function。自 0.4.0 版本起，可以引用模块函数。

首次为给定请求引用变量时，会调用该函数。确切的时间取决于引用变量的 阶段。这可用于执行一些与变量评估无关的逻辑。例如，如果仅在 log_format 指令中引用变量，则其处理程序将不会在日志阶段之前执行。此处理程序可用于在释放请求之前进行一些清理工作。

自 0.8.6 版本起，如果指定了可选参数 nocache，则每次引用处理程序时都会调用它。由于 rewrite 模块的当前限制，当 set 指令引用 nocache 变量时，其处理程序应始终返回固定长度的值。

由于 js_set 处理程序会立即返回其结果，因此它仅支持同步操作。因此，不支持异步操作，例如 r.subrequest() 或 setTimeout()。

自 0.7.7 版本起，此指令可以在 server 和 location 级别指定。

设置共享内存区域的 name 和 size，该区域保存工作进程之间共享的键值 字典。

默认情况下，共享字典使用字符串作为键和值。可选的 type 参数允许将值类型重新定义为数字。

可选的 timeout 参数设置从区域中删除所有共享字典条目之前经过的时间（以毫秒为单位）。如果某些条目需要不同的删除时间，则可以使用 add、incr 和 set 方法的 timeout 参数进行设置（0.8.5）。

可选的 evict 参数在区域存储已满时删除最旧的键值对。

示例

example.conf:
    # Creates a 1Mb dictionary with string values,
    # removes key-value pairs after 60 seconds of inactivity:
    js_shared_dict_zone zone=foo:1M timeout=60s;

    # Creates a 512Kb dictionary with string values,
    # forcibly removes oldest key-value pairs when the zone is exhausted:
    js_shared_dict_zone zone=bar:512K timeout=30s evict;

    # Creates a 32Kb permanent dictionary with number values:
    js_shared_dict_zone zone=num:32k type=number;

example.js:
    function get(r) {
        r.return(200, ngx.shared.foo.get(r.args.key));
    }

    function set(r) {
        r.return(200, ngx.shared.foo.set(r.args.key, r.args.value));
    }

    function del(r) {
        r.return(200, ngx.shared.bar.delete(r.args.key));
    }

    function increment(r) {
        r.return(200, ngx.shared.num.incr(r.args.key, 2));
    }

声明 可写变量。该值可以包含文本、变量及其组合。与使用 set 指令创建的变量不同，重定向后不会覆盖该变量。

自 0.7.7 版本起，此指令可以在 server 和 location 级别指定。

每个 HTTP njs 处理程序接收一个参数，即请求 对象。