gzip

描述

gzip 插件能动态设置 NGINX 的压缩行为。 当启用 gzip 插件时，客户端在发起请求时需要在请求头中添加 Accept-Encoding: gzip，以表明客户端支持 gzip 压缩。APISIX 在接收到请求后，会根据客户端的支持情况和服务器配置动态判断是否对响应内容进行 gzip 压缩。如果判定条件得到满足，APISIX 将在响应头中添加 Content-Encoding: gzip 字段，以指示响应内容已经通过 gzip 压缩。在客户端接收到响应后，根据响应头中的 Content-Encoding 字段使用相应的解压缩算法对响应内容进行解压，从而获取原始的响应内容。

IMPORTANT

该插件要求 Apache APISIX 运行在 APISIX-Runtime 上。

属性

名称	类型	必选项	默认值	有效值	描述
types	array[string] or "*"	否	["text/html"]		动态设置 gzip_types 指令，特殊值 "*" 匹配任何 MIME 类型。
min_length	integer	否	20	>= 1	动态设置 gzip_min_length 指令。
comp_level	integer	否	1	[1, 9]	动态设置 gzip_comp_level 指令。
http_version	number	否	1.1	1.1, 1.0	动态设置 gzip_http_version 指令。
buffers.number	integer	否	32	>= 1	动态设置 gzip_buffers 指令 参数 number。
buffers.size	integer	否	4096	>= 1	动态设置 gzip_buffers 指令参数 size。单位为字节。
vary	boolean	否	false		动态设置 gzip_vary 指令。

启用插件

以下示例展示了如何在指定路由中启用 gzip 插件：

note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量：

admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')

curl -i http://127.0.0.1:9180/apisix/admin/routes/1  \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "uri": "/index.html",
    "plugins": {
        "gzip": {
            "buffers": {
                "number": 8
            }
        }
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'

测试插件

通过上述命令启用插件后，可以使用如下命令测试插件是否启用成功：

curl http://127.0.0.1:9080/index.html -i -H "Accept-Encoding: gzip"

HTTP/1.1 404 Not Found
Content-Type: text/html; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Date: Wed, 21 Jul 2021 03:52:55 GMT
Server: APISIX/2.7
Content-Encoding: gzip

Warning: Binary output can mess up your terminal. Use "--output -" to tell
Warning: curl to output it to your terminal anyway, or consider "--output
Warning: <FILE>" to save to a file.

删除插件

当你需要禁用 gzip 插件时，可以通过以下命令删除相应的 JSON 配置，APISIX 将会自动重新加载相关配置，无需重启服务：

curl http://127.0.0.1:9180/apisix/admin/routes/1  \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "uri": "/index.html",
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'