ngx_http_js_module モジュール

ngx_http_js_module モジュールはnjs - JavaScript言語のサブセット、での場所と変数のハンドラを実装するために使われます。

ダウンロードとインストールの説明はここで利用可能です。

この例は、0.4.0以降で動作します。

http {
    js_import http.js;

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

    server {
        listen 8000;

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

        location = /summary {
            return 200 $summary;
        }

        location = /hello {
            js_content http.hello;
        }
    }
}

The http.js file:

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

export default {foo, summary, baz, hello};

場所のコンテントハンドラとしてnjs関数を設定します。0.4.0以降、モジュール関数を参照できます。

njs内のlocationと変数を実装するモジュールをインポートします。export_nameは、モジュール関数にアクセスするための名前空間として使います。export_nameが指定されない場合、モジュール名が名前空間として使われます。

js_import http.js;

ここで、モジュール名httpはエクスポートにアクセスする時に名前空間として使われます。インポートされたモジュールがfoo()を含む場合、http.fooはそれを産法するために使われます。

いくつかのjs_importディレクティブを指定できます。

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以降非推奨で、代わりにjs_importディレクティブを使ってください。

njsモジュールの追加のパスをせっていします。

特定の変数のためにnjs関数を設定します。0.4.0以降、モジュール関数を参照できます。

各HTTP njsヘッダは1つの引数、リクエストオブジェクトを受け取ります。