Nginx官方文档(二十二)【ngx_http_js_module|ngx_http_keyval_module】

素颜马尾好姑娘i 2021-07-04 21:00 479阅读 0赞

# ngx\_http\_js\_module #

*  指令
    
     *  js\_include
     *  js\_content
     *  \[ js\_set\](\# js\_set)
 *  请求与响应参数

`ngx_http_js_module` 模块用于在 nginScript 中实现 location 和变量处理器 — 它是 JavaScript 语言的一个子集。

此模块不是默构建，可以使用 `--add-module` 配置参数与 nginScript 模块一起编译：

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

可以使用以下命令克隆 nginScript 模块[仓库][Link 1]（需要 [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` 文件：

## 指令 ##

### js\_include ###

<table> 
 <thead> 
  <tr> 
   <th align="right">-</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="right"><strong>语法</strong></td> 
   <td><strong>js_include</strong> <code>file</code>;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>默认</strong></td> 
   <td>——</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>上下文</strong></td> 
   <td>http</td> 
  </tr> 
 </tbody> 
</table>

指定一个在 nginScript 中实现 location 和变量处理器的文件。

### hls\_buffers ###

<table> 
 <thead> 
  <tr> 
   <th align="right">-</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="right"><strong>语法</strong></td> 
   <td><strong>js_content</strong> <code>function</code>;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>默认</strong></td> 
   <td>——</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>上下文</strong></td> 
   <td>location、limit_except</td> 
  </tr> 
 </tbody> 
</table>

将 nginScript 函数设置为 location 内容处理器。

### js\_set ###

<table> 
 <thead> 
  <tr> 
   <th align="right">-</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="right"><strong>语法</strong></td> 
   <td><strong>js_set</strong> <code>$variable function</code>;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>默认</strong></td> 
   <td>——</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>上下文</strong></td> 
   <td>http</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>提示</strong></td> 
   <td>该指令在 1.5.12 版本中出现</td> 
  </tr> 
 </tbody> 
</table>

为指定变量设置 nginScript 函数。

## 请求与响应参数 ##

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

请求对象具有以下属性：

*  `uri`
    
    请求的当前 URI，只读
 *  `method`
    
    请求方法，只读
 *  `httpVersion`
    
    HTTP 版本，只读
 *  `remoteAddress`
    
    客户端地址，只读
 *  `headers{}`
    
    请求头对象，只读
    
    例如，可以使用语法 `headers['Header-Name']` 或 `headers.Header_name` 来访问 `Header-Name` 头
 *  `args{}`
    
    请求参数对象，只读
 *  `variables{}`
    
    nginx 变量对象，只读
 *  `log(string)`
    
    将 `string` 写入错误日志

响应对象具有以下属性：

*  `status`
    
    响应状态，可写
 *  `headers{}`
    
    响应头对象
 *  `contentType`
    
    响应的 `Content-Type` 头字段值，可写
 *  `contentLength`
    
    响应的 `Content-Length` 头字段值，可写

响应对象具有以下方法：

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

## 原文档 ##

[http://nginx.org/en/docs/http/ngx\_http\_js\_module.html][http_nginx.org_en_docs_http_ngx_http_js_module.html]

--------------------

# ngx\_http\_keyval\_module #

*  指令
    
     *  keyval
     *  keyval\_zone

`ngx_http_keyval_module` 模块（1.13.3）创建的带值变量从 API 管理的键值对中获取。

> 该模块可作为我们[商业订阅][Link 2]的一部分。

## 示例配置 ##

http {
    
        keyval_zone zone=one:32k state=one.keyval;
        keyval $arg_text $text zone=one;
        ...
        server {
            ...
            location / {
                return 200 $text;
            }
    
            location /api {
                api write=on;
            }
        }
    }

## 指令 ##

### keyval ###

<table> 
 <thead> 
  <tr> 
   <th align="right">-</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="right"><strong>语法</strong></td> 
   <td><strong>keyval</strong> <code>key $variable zone=name</code>;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>默认</strong></td> 
   <td>——</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>上下文</strong></td> 
   <td>http</td> 
  </tr> 
 </tbody> 
</table>

创建一个新的变量 `$variable`，该变量的值从键值数据库中通过 `key` 查找。字符串匹配忽略大小写。数据库存储在 `zone` 参数指定的共享内存区域中。

### keyval\_zone ###

<table> 
 <thead> 
  <tr> 
   <th align="right">-</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="right"><strong>语法</strong></td> 
   <td><strong>keyval_zone</strong> <code>zone=name:size [state=file]</code>;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>默认</strong></td> 
   <td>——</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>上下文</strong></td> 
   <td>http</td> 
  </tr> 
 </tbody> 
</table>

设置保存键值数据库的共享内存区域的名称（`name`）和大小（`size`）。键值对由 API 管理。

可选的 `state` 参数指定一个文件，该文件将键值数据库的当前状态保持为 JSON 格式，并使其在 nginx 重启时保持不变。

## 原文档 ##

[http://nginx.org/en/docs/http/ngx\_http\_keyval\_module.html][http_nginx.org_en_docs_http_ngx_http_keyval_module.html]

[Link 1]: http://hg.nginx.org/njs?_ga=2.21584507.1917722686.1520954456-1859001452.1520648382
[Mercurial]: https://www.mercurial-scm.org/
[http_nginx.org_en_docs_http_ngx_http_js_module.html]: http://nginx.org/en/docs/http/ngx_http_js_module.html
[Link 2]: http://nginx.com/products/?_ga=2.259594698.1917722686.1520954456-1859001452.1520648382
[http_nginx.org_en_docs_http_ngx_http_keyval_module.html]: http://nginx.org/en/docs/http/ngx_http_keyval_module.html