proxy-cache

注意
  • 对于基于磁盘的缓存，不能动态配置缓存的过期时间，只能通过后端服务响应头 Expires 或 Cache-Control 来设置过期时间，当后端响应头中没有 Expires 或 Cache-Control 时，默认缓存时间为 10 秒钟
  • 当上游服务不可用时， APISIX 将返回 502 或 504 HTTP 状态码，默认缓存时间为 10 秒钟；
  • 变量以 $ 开头，不存在时等价于空字符串。也可以使用变量和字符串的结合，但是需要以数组的形式分开写，最终变量被解析后会和字符串拼接在一起。

你可以在 APISIX 配置文件 conf/config.yaml 中添加你的缓存配置，示例如下：

conf/config.yaml

以下示例展示了如何在指定路由上启用 proxy-cache 插件，cache_zone 字段默认设置为 disk_cache_one：

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  3. {
  4.     "plugins": {
  5.         "proxy-cache": {
  6.             "cache_key":  ["$uri", "-cache-id"],
  7.             "cache_method": ["GET"],
  8.             "cache_http_status": [200],
  9.             "hide_cache_headers": true,
  10.             "no_cache": ["$arg_test"]
  11.         }
  12.     },
  13.     "upstream": {
  14.         "nodes": {
  15.             "127.0.0.1:1999": 1
  16.         },
  17.         "type": "roundrobin"
  18.     },
  19.     "uri": "/hello"
  20. }'
  1. curl http://127.0.0.1:9080/hello -i

如果返回 200 HTTP 状态码，并且响应头中包含 Apisix-Cache-Status字段，则表示该插件已启用：

如果你是第一次请求该路由，数据未缓存，那么 Apisix-Cache-Status 字段应为 MISS。此时再次请求该路由：

如果返回的响应头中 Apisix-Cache-Status 字段变为 HIT，则表示数据已被缓存，插件生效：

  1. ···
  2. Apisix-Cache-Status: HIT
  4. hello
proxy-cache - 图2提示

为了清除缓存数据，你只需要指定请求的 method 为 PURGE：

HTTP 响应码为 200 即表示删除成功，如果缓存的数据未找到将返回 404：

  1. HTTP/1.1 200 OK

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

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  3. {
  4.     "uri": "/hello",
  5.     "plugins": {},
  6.     "upstream": {
  7.         "type": "roundrobin",
  8.         "nodes": {
  9.             "127.0.0.1:1999": 1
  10.         }
  11.     }