模块 ngx_http_gzip_module
| 配置示例 指令 gzip gzip_buffers gzip_comp_level gzip_disable gzip_http_version gzip_min_length gzip_proxied gzip_types gzip_vary 内嵌变量 |
ngx_http_gzip_module 模块是一个使用“gzip”方法压缩响应的过滤器。这通常有助于将传输数据的大小减小一半或更多。
当使用 SSL/TLS 协议时,压缩的响应可能容易受到 BREACH 攻击。
配置示例
gzip on; gzip_min_length 1000; gzip_proxied expired no-cache no-store private auth; gzip_types text/plain application/xml;
$gzip_ratio 变量可用于记录实现的压缩比。
指令
| 语法 |
gzip |
|---|---|
| 默认值 |
gzip off; |
| 上下文 |
http, server, location, if in location |
启用或禁用响应的 gzip 压缩。
| 语法 |
gzip_buffers |
|---|---|
| 默认值 |
gzip_buffers 32 4k|16 8k; |
| 上下文 |
http, server, location |
设置用于压缩响应的缓冲区 number 和 size。默认情况下,缓冲区大小等于一个内存页。根据平台不同,这可以是 4K 或 8K。
在 0.7.28 版本之前,默认使用四个 4K 或 8K 缓冲区。
| 语法 |
gzip_comp_level |
|---|---|
| 默认值 |
gzip_comp_level 1; |
| 上下文 |
http, server, location |
设置响应的 gzip 压缩 level。可接受的值范围为 1 到 9。
| 语法 |
gzip_disable |
|---|---|
| 默认值 | — |
| 上下文 |
http, server, location |
此指令出现在 0.6.23 版本中。
对于“User-Agent”头字段与任何指定正则表达式匹配的请求,禁用响应的 gzip 压缩。
特殊掩码“msie6”(0.7.12)对应于正则表达式“MSIE [4-6]\.”,但速度更快。从 0.8.11 版本开始,“MSIE 6.0; ... SV1”被排除在此掩码之外。
| 语法 |
gzip_http_version |
|---|---|
| 默认值 |
gzip_http_version 1.1; |
| 上下文 |
http, server, location |
设置压缩响应所需的最低请求 HTTP 版本。
| 语法 |
gzip_min_length |
|---|---|
| 默认值 |
gzip_min_length 20; |
| 上下文 |
http, server, location |
设置将进行 gzip 压缩的响应的最小长度。长度仅由“Content-Length”响应头字段确定。
| 语法 |
gzip_proxied |
|---|---|
| 默认值 |
gzip_proxied off; |
| 上下文 |
http, server, location |
根据请求和响应,启用或禁用代理请求的响应 gzip 压缩。请求是否为代理请求取决于“Via”请求头字段是否存在。此指令接受多个参数:
off- 对所有代理请求禁用压缩,忽略其他参数;
expired- 如果响应头包含“Expires”字段,且其值禁用缓存,则启用压缩;
no-cache- 如果响应头包含“Cache-Control”字段,且带有“
no-cache”参数,则启用压缩; no-store- 如果响应头包含“Cache-Control”字段,且带有“
no-store”参数,则启用压缩; private- 如果响应头包含“Cache-Control”字段,且带有“
private”参数,则启用压缩; no_last_modified- 如果响应头不包含“Last-Modified”字段,则启用压缩;
no_etag- 如果响应头不包含“ETag”字段,则启用压缩;
auth- 如果请求头包含“Authorization”字段,则启用压缩;
any- 对所有代理请求启用压缩。
| 语法 |
gzip_types |
|---|---|
| 默认值 |
gzip_types text/html; |
| 上下文 |
http, server, location |
除了“text/html”之外,为指定的 MIME 类型启用响应的 gzip 压缩。特殊值“*”匹配任何 MIME 类型(0.8.29)。“text/html”类型的响应总是被压缩的。
| 语法 |
gzip_vary |
|---|---|
| 默认值 |
gzip_vary off; |
| 上下文 |
http, server, location |
如果 gzip、gzip_static 或 gunzip 指令处于活动状态,则启用或禁用插入“Vary: Accept-Encoding”响应头字段。
内嵌变量
$gzip_ratio- 实现的压缩比,计算方法是原始响应大小与压缩后响应大小之比。