Mercurial > hg > nginx-site
view xml/ru/docs/http/ngx_http_js_module.xml @ 2664:9e39e64bff84
Documented the js_body_filter directive.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Thu, 04 Mar 2021 14:34:52 +0000 |
parents | b4991bbd64ee |
children | 893cd7724c8c |
line wrap: on
line source
<?xml version="1.0"?> <!-- Copyright (C) Nginx, Inc. --> <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> <module name="Модуль ngx_http_js_module" link="/ru/docs/http/ngx_http_js_module.html" lang="ru" rev="24"> <section id="summary"> <para> Модуль <literal>ngx_http_js_module</literal> позволяет задавать обработчики location и переменных на <link doc="../njs/index.xml">njs</link> — подмножестве языка JavaScript. </para> <para> Инструкция по сборке и установке доступны <link doc="../njs/install.xml">здесь</link>. </para> </section> <section id="example" name="Пример конфигурации"> <para> Пример работает начиная с версии <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link>. <example> 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; } } } </example> </para> <para> The <path>http.js</path> file: <example> 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}; </example> </para> </section> <section id="directives" name="Директивы"> <directive name="js_body_filter"> <syntax><value>функция</value> | <value>модуль.функция</value> [<value>buffer_type</value>=<value>строка</value> | <value>буфер</value>]</syntax> <default/> <context>location</context> <context>limit_except</context> <appeared-in>0.5.2</appeared-in> <para> Задаёт функцию njs в качестве фильтра тела ответа. Функция фильтра вызывается для каждого блока данных тела ответа со следующими аргументами: <list type="tag"> <tag-name><literal>data</literal></tag-name> <tag-desc> входящий блок данных может быть строкой или буфером в зависимости от значения <literal>buffer_type</literal>, по умолчанию является строкой. </tag-desc> <tag-name><literal>flags</literal></tag-name> <tag-desc> объект со следующими свойствами: <list type="tag"> <tag-name><literal>last</literal></tag-name> <tag-desc> логическое значение, true, если данные являются последним буфером. </tag-desc> </list> </tag-desc> </list> </para> <para> Функция фильтра может передавать свою модифицированную версию входящего блока данных следующему фильтру тела ответа при помощи вызова <link doc="../njs/reference.xml" id="r_sendbuffer"><literal>r.sendBuffer()</literal></link>. Пример преобразования букв в нижний регистр в теле ответа: <example> function filter(data, flags) { r.sendBuffer(data.toLowerCase(), flags); } </example> Для отмены фильтра (блоки данных будут передаваться клиенту без вызова <literal>js_body_filter</literal>), можно использовать <link doc="../njs/reference.xml" id="r_done"><literal>r.done()</literal></link>. </para> <para> Если функция фильтра изменяет длину тела ответа, то необходимо очистить заголовок ответа <header>Content-Length</header> (если присутствует) в <link id="js_header_filter"><literal>js_header_filter</literal></link>, чтобы применить поблочное кодирование. </para> </directive> <directive name="js_content"> <syntax><value>функция</value> | <value>модуль.функция</value></syntax> <default/> <context>location</context> <context>limit_except</context> <para> Задаёт функцию njs в качестве обработчика содержимого location. Начиная с версии <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link> можно ссылаться на функцию модуля. </para> </directive> <directive name="js_header_filter"> <syntax><value>функция</value> | <value>модуль.функция</value></syntax> <default/> <context>location</context> <context>limit_except</context> <appeared-in>0.5.1</appeared-in> <para> Задаёт функцию njs в качестве фильтра заголовка ответа. Директива позволяет менять произвольные поля заголовка ответа. </para> </directive> <directive name="js_import"> <syntax><value>модуль.js</value> | <value>имя_экспорта из модуль.js</value></syntax> <default/> <context>http</context> <appeared-in>0.4.0</appeared-in> <para> Импортирует модуль, позволяющий задавать обработчики location и переменных на njs. <literal>Имя_экспорта</literal> является пространством имён при доступе к функциям модуля. Если <literal>имя_экспорта</literal> не задано, то пространством имён будет являться имя модуля. <example> js_import http.js; </example> В примере при доступе к экспорту в качестве пространства имён используется имя модуля <literal>http</literal>. Если импортируемый модуль содержит <literal>foo()</literal>, то для доступа используется <literal>http.foo</literal>. </para> <para> Директив <literal>js_import</literal> может быть несколько. </para> </directive> <directive name="js_include"> <syntax><value>файл</value></syntax> <default/> <context>http</context> <para> Задаёт файл, позволяющий задавать обработчики location и переменных на njs: <example> nginx.conf: js_include http.js; location /version { js_content version; } http.js: function version(r) { r.return(200, njs.version); } </example> </para> <para> Директива устарела начиная с <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link>, вместо неё следует использовать директиву <link id="js_import"/>. </para> </directive> <directive name="js_path"> <syntax> <value>путь</value></syntax> <default/> <context>http</context> <appeared-in>0.3.0</appeared-in> <para> Задаёт дополнительный путь для модулей njs. </para> </directive> <directive name="js_set"> <syntax> <value>$переменная</value> <value>функция</value> | <value>модуль.функция</value></syntax> <default/> <context>http</context> <para> Задаёт функцию njs для указанной переменной. Начиная с <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link> можно ссылаться на функцию модуля. </para> </directive> </section> <section id="arguments" name="Аргумент запроса"> <para> Каждый HTTP-обработчик njs получает один аргумент, <link doc="../njs/reference.xml" id="http">объект</link> запроса. </para> </section> </module>