Mercurial > hg > nginx-site
diff xml/ru/docs/njs/examples.xml @ 2245:87a0e2c73a25
Refactored njs documentation.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Mon, 24 Sep 2018 19:10:29 +0300 |
parents | |
children | 32ba43abf9cd |
line wrap: on
line diff
new file mode 100644 --- /dev/null +++ b/xml/ru/docs/njs/examples.xml @@ -0,0 +1,438 @@ +<?xml version="1.0"?> + +<!-- + Copyright (C) Nginx, Inc. + --> + +<!DOCTYPE article SYSTEM "../../../../dtd/article.dtd"> + +<article name="Примеры использования" + link="/ru/docs/njs/examples.html" + lang="ru" + rev="1"> + +<section id="helloword" name="Hello World"> + +<para> +<path>nginx.conf</path>: +<example> +load_module modules/ngx_http_js_module.so; + +events {} + +http { + js_include hello_world.js; + + server { + listen 8000; + + location / { + js_content hello; + } + } +} + +</example> +</para> + +<para> +<literal>hello_world.js</literal>: +<example> +function hello(r) { + r.return(200, “Hello world!”); +} +</example> +</para> + +</section> + + +<section id="urldecode" name="Декодирование URL"> + +<para> +<path>nginx.conf</path>: +<example> +js_include urldecode.js; + +js_set $decoded_foo decoded_foo; +</example> +</para> + +<para> +<path>urldecode.js</path>: +<example> +function decoded_foo(r) { + return decodeURIComponent(r.args.foo); +} +</example> +</para> + +</section> + + +<section id="urlencode" name="Кодирование URL"> + +<para> +<path>nginx.conf</path>: +<example> +js_include urlencode.js; + +js_set $encoded_foo encoded_foo; +... + +location / { + proxy_pass http://example.com?foo=$encoded_foo; +} +</example> +</para> + +<para> +<path>urlencode.js</path>: +<example> +function encoded_foo(r) { + return encodeURIComponent('foo & bar?'); +} +</example> +</para> + +</section> + + +<section id="redirect" name="Внутренняя переадресация"> + +<para> +<path>nginx.conf</path>: +<example> +js_include redirect.js; + +location /redirect { + js_content redirect; +} + +location @named { + return 200 named; +} +</example> +</para> + +<para> +<path>redirect.js</path>: +<example> +function redirect(r) { + r.internalRedirect('@named'); +} +</example> +</para> + +</section> + + +<section id="fast_response" name="Возвращение самого быстрого ответа от прокси"> + +<para> +<path>nginx.conf</path>: +<example> +js_include fastresponse.js; + +location /start { + js_content content; +} + +location /foo { + proxy_pass http://backend1; +} + +location /bar { + proxy_pass http://backend2; +} +</example> +</para> + +<para> +<path>fastresponse.js</path>: +<example> +function content(r) { + var n = 0; + + function done(res) { + if (n++ == 0) { + r.return(res.status, res.responseBody); + } + } + + r.subrequest('/foo', r.variables.args, done); + r.subrequest('/bar', r.variables.args, done); +} +</example> +</para> + +</section> + + +<section id="jwt" name="Создание HS JWT"> + +<para> +<path>nginx.conf</path>: +<example> +js_include hs_jwt.js; + +js_set $jwt jwt; +</example> +</para> + +<para> +<path>hs_jwt.js</path>: +<example> +function create_hs256_jwt(claims, key, valid) { + var header = { "typ" : "JWT", "alg" : "HS256", "exp" : Date.now() + valid }; + + var s = JSON.stringify(header).toBytes().toString('base64url') + '.' + + JSON.stringify(claims).toBytes().toString('base64url'); + + var h = require('crypto').createHmac('sha256', key); + + return s + '.' + h.update(s).digest().toString('base64url'); +} + +function jwt(r) { + var claims = { + "iss" : "nginx", + "sub" : "alice", + "foo" : 123, + "bar" : "qq", + "zyx" : false + }; + + return create_hs256_jwt(claims, 'foo', 600); +} +</example> +</para> + +</section> + + +<section id="subrequest" name="Доступ к API из подзапроса"> + +<para> +<path>nginx.conf</path>: +<example> +js_include subrequest.js; + +keyval_zone zone=foo:10m; +... + +location /keyval { + js_content set_keyval; +} + +location /version { + js_content version; +} + +location /api { + api write=on; +} +</example> +</para> + +<para> +<path>subrequest.js</path>: +<example> +function set_keyval(r) { + r.subrequest('/api/3/http/keyvals/foo', + { method: 'POST', + body: JSON.stringify({ foo: 789, bar: "ss dd 00" })}, + + function(res) { + if (res.status >= 300) { + r.return(res.status, res.responseBody); + return; + } + r.return(500); + }); +} + +function version(r) { + r.subrequest('/api/3/nginx', { method: 'GET' }, function(res) { + if (res.status != 200) { + r.return(res.status); + return; + } + + var json = JSON.parse(res.responseBody); + r.return(200, json.version); + }); +} +</example> +</para> + +</section> + + +<section id="secure_link" name="Создание secure_link хэша"> + +<para> +<path>nginx.conf</path>: +<example> +js_include hash.js; + +js_set $new_foo create_secure_link; +... + +location / { + secure_link $cookie_foo; + secure_link_md5 "$uri mykey"; + ... +} + +location @login { + add_header Set-Cookie "foo=$new_foo; Max-Age=60"; + return 302 /; +} +</example> +</para> + +<para> +<path>hash.js</path>: +<example> +function create_secure_link(r) { + return require('crypto').createHash('md5') + .update(r.uri).update(" mykey") + .digest('base64url'); +} +</example> +</para> + +</section> + + +<section id="legacy" name="Устаревшие примеры"> + +<section id="legacy_stream" name="Внедрение HTTP-заголовка при помощи stream proxy"> + +<para> +Начиная с версии njs <link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link> +<link doc="../stream/ngx_stream_js_module.xml" id="example">пример</link> +конфигурации в stream +был изменён. +Для njs <link doc="../njs/njs_changes.xml" id="njs0.2.3">0.2.3</link> +и более ранних версий необходимо использовать следующий пример конфигурации: +<example> +load_module modules/ngx_stream_js_module.so; +... + +stream { + js_include stream.js; + + js_set $foo foo; + js_set $bar bar; + + server { + listen 12345; + + js_preread qux; + return $foo; + } + + server { + listen 12346; + + js_access xyz; + proxy_pass 127.0.0.1:8000; + js_filter baz; + } +} + +http { + server { + listen 8000; + location / { + return 200 $http_foo\n; + } + } +} +</example> +</para> + +<para> +Файл <path>stream.js</path>: +<example> +var req = ''; +var matched = 0; +var line = ''; + +function qux(s) { + var n = s.buffer.indexOf('\n'); + if (n == -1) { + return s.AGAIN; + } + + line = s.buffer.substr(0, n); +} + +function foo(s) { + return line; +} + +function bar(s) { + var v = s.variables; + s.log("hello from bar() handler!"); + return "foo-var" + v.remote_port + "; pid=" + v.pid; +} + +// Фильтр обрабатывает один буфер за вызов. +// Буфер недоступен в s.buffer для +// чтения и записи. Вызывается в обоих направлениях. + +function baz(s) { + if (s.fromUpstream || matched) { + return; + } + + // Отключение определённых адресов. + + if (s.remoteAddress.match('^192.*')) { + return s.ERROR; + } + + // Чтение строки HTTP-запроса. + // Получение байт в 'req' до того как + // будет прочитана строка запроса. Очистка текущего буфера + // для отключения вывода. + + req = req + s.buffer; + s.buffer = ''; + + var n = req.search('\n'); + + if (n != -1) { + // Inject a new HTTP header. + var rest = req.substr(n + 1); + req = req.substr(0, n + 1); + + var addr = s.remoteAddress; + + s.log('req:' + req); + s.log('rest:' + rest); + + // Вывод результата и пропуск дальнейшей + // обработки. + + s.buffer = req + 'Foo: addr_' + addr + '\r\n' + rest; + matched = 1; + } +} + +function xyz(s) { + if (s.remoteAddress.match('^192.*')) { + return s.ABORT; + } +} +</example> +</para> + +</section> + +</section> + +</article>