ngx_http_js_module

ngx_http_js_module模块

示例配置

指令

js_include

js_content

js_set

请求和响应参数

该ngx_http_js_module模块用于实现nginScript中的位置和变量处理程序 - JavaScript语言的一个子集。

此模块不是默认生成的，它应该使用--add-module配置参数与nginScript模块一起编译：

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

具有nginScript模块的存储库可以使用以下命令克隆（需要Mercurial客户端）：

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

该模块也可以构建为动态：

./configure --add-dynamic-module=path-to-njs/nginx

示例配置

js_include http.js;

js_set $foo     foo;
js_set $summary summary;

server {
    listen 8000;

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

    location /summary {
        return 200 $summary;
    }
}

该http.js文件中：

function foo(req, res) {
    req.log("hello from foo() handler"
    return "foo";
}

function summary(req, res) {
    var a, s, h;

    s = "JS summary\n\n";

    s += "Method: " + req.method + "\n";
    s += "HTTP version: " + req.httpVersion + "\n";
    s += "Host: " + req.headers.host + "\n";
    s += "Remote Address: " + req.remoteAddress + "\n";
    s += "URI: " + req.uri + "\n";

    s += "Headers:\n";
    for (h in req.headers) {
        s += "  header '" + h + "' is '" + req.headers[h] + "'\n";
    }

    s += "Args:\n";
    for (a in req.args) {
        s += "  arg '" + a + "' is '" + req.args[a] + "'\n";
    }

    return s;
}

function baz(req, res) {
    res.headers.foo = 1234;
    res.status = 200;
    res.contentType = "text/plain; charset=utf-8";
    res.contentLength = 15;
    res.sendHeader(
    res.send("nginx"
    res.send("java"
    res.send("script"

    res.finish(
}

指令

句法：	js_include文件;
默认：	—
语境：	HTTP

指定一个在nginScript中实现位置和变量处理程序的文件。

句法：	js_content函数;
默认：	—
语境：	位置，limit_except

将nginScript函数设置为位置内容处理程序。

句法：	js_set $ variable函数;
默认：	—
语境：	HTTP

为指定变量设置nginScript函数。

请求和响应参数

每个HTTP nginScript处理程序接收两个参数，请求和响应。

请求对象具有以下属性：

请求中的uri当前URI，只读方法请求方法，只读httpVersion HTTP版本，只读remoteAddress客户端地址，只读标头{}请求标头对象。

例如，Header-Name头可以通过语法headers['Header-Name']或者headers.Header_name 访问

args{}请求参数对象，只读variables{}nginx变量对象，只读写入错误日志log(string)string

响应对象具有以下属性：

状态响应状态，可写标题{}响应标题对象contentType响应“Content-Type”标题字段值，可写contentLength响应“Content-Length”标题字段

响应对象具有以下方法：

sendHeader()将HTTP头发送给客户端将响应主体的一部分发送给客户端完成向客户端发送响应send(string)finish()