Module ngx_stream_js_module

• Example Configuration
• Directives
  • js_access
  • js_filter
  • js_import
  • js_include
  • js_path
  • js_preread
  • js_set
• 会话对象属性
  

ngx_stream_js_module模块用于以njs(JavaScript 语言的子集)实现处理程序。

here提供了下载和安装说明。

Example Configuration

该示例自0.4.0开始生效。

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;
}

// Read HTTP request line.
// Collect bytes in 'req' until
// request line is read.
// Injects HTTP header into a client's request

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.abort();
        return;
    }

    s.allow();
}

export default {bar, preread, req_line, access};

Directives

设置将在access阶段调用的 njs 函数。由于0.4.0，因此可以引用模块功能。

设置数据过滤器。由于0.4.0，因此可以引用模块功能。

该指令出现在版本 0.4.0 中。

导入在 njs 中实现位置和变量处理程序的模块。 export_name用作访问模块功能的名称空间。如果未指定export_name，则模块名称将用作命名空间。

js_import stream.js;

在这里，模块名称stream在访问导出时用作命名空间。如果导入的模块包含foo()，则使用stream.foo来引用它。

可以指定多个js_import指令。

指定一个在 njs 中实现服务器和变量处理程序的文件：

nginx.conf:
js_include stream.js;
js_set     $js_addr address;
server {
    listen 127.0.0.1:12345;
    return $js_addr;
}

stream.js:
function address(s) {
    return s.remoteAddress;
}

自0.4.0以来，该指令已弃用，而应改用js_import指令。

该指令出现在版本 0.3.0 中。

为 njs 模块设置附加路径。

设置将在preread阶段调用的 njs 函数。由于0.4.0，因此可以引用模块功能。

为指定变量设置 njs 函数。由于0.4.0，因此可以引用模块功能。

会话对象属性

每个流 njs 处理程序都接收一个参数，即流会话object。