proxy-cache

代理缓存插件，该插件提供缓存后端响应数据的能力，它可以和其他插件一起使用。该插件支持基于磁盘的缓存，未来也会支持基于内存的缓存。目前可以根据响应码、请求 Method 来指定需要缓存的数据，另外也可以通过 no_cache 和 cache_bypass 配置更复杂的缓存策略。

基于磁盘的缓存需要注意：

  1. 不能动态配置缓存的过期时间，只能通过后端服务响应头 Expires 或 Cache-Control 来设置过期时间，如果后端响应头中没有 Expires 或 Cache-Control，那么 APISIX 将默认只缓存10秒钟
  2. 如果后端服务不可用， APISIX 将返回502或504，那么502或504将被缓存10秒钟

参数

名称必须类型描述
cache_zone是string指定使用哪个缓存区域，不同的缓存区域可以配置不同的路径，在conf/config.yaml文件中可以预定义使用的缓存区域
cache_key是array[string]缓存key，可以使用变量。例如：[“$host”, “$uri”, “-cache-id”]
cache_bypass否array[string]是否跳过缓存检索，即不在缓存中查找数据，可以使用变量，需要注意当此参数的值不为空或非’0’时将会跳过缓存的检索。例如：[“$arg_bypass”]
cache_method否array[string]根据请求method决定是否需要缓存
cache_http_status否array[integer]根据响应码决定是否需要缓存
hide_cache_headers否boolean是否将 Expires 和 Cache-Control 响应头返回给客户端，默认为 false
no_cache否array[string]是否缓存数据，可以使用变量，需要注意当此参数的值不为空或非’0’时将不会缓存数据。

注：变量以$开头，也可以使用变量和字符串的结合，但是需要以数组的形式分开写，最终变量被解析后会和字符串拼接在一起。

示例

启用插件

示例1：为特定路由启用 proxy-cache 插件：

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "plugins": {
  4.         "proxy-cache": {
  5.            "cache_zone": "disk_cache_one",
  6.            "cache_key":  ["$uri", "-cache-id"],
  7.            "cache_bypass": ["$arg_bypass"],
  8.            "cache_method": ["GET"],
  9.            "cache_http_status": [200],
  10.            "hide_cache_headers": true,
  11.            "no_cache": ["$arg_test"]
  12.         }
  13.     },
  14.     "upstream": {
  15.         "nodes": {
  16.             "127.0.0.1:1999": 1
  17.         },
  18.         "type": "roundrobin"
  19.     },
  20.     "uri": "/hello"
  21. }'

测试：

  1. $ curl http://127.0.0.1:9080/hello -i
  2. HTTP/1.1 200 OK
  3. Content-Type: application/octet-stream
  4. Content-Length: 6
  5. Connection: keep-alive
  6. Server: APISIX web server
  7. Date: Tue, 03 Mar 2020 10:45:36 GMT
  8. Last-Modified: Tue, 03 Mar 2020 10:36:38 GMT
  9. Apisix-Cache-Status: MISS
  11. hello

http status 返回200并且响应头中包含Apisix-Cache-Status，表示该插件已启用。

示例2：验证文件是否被缓存，再次请求上边的地址：

测试：

  1. $ curl http://127.0.0.1:9080/hello -i
  2. HTTP/1.1 200 OK
  3. Content-Type: application/octet-stream
  4. Content-Length: 6
  5. Connection: keep-alive
  6. Server: APISIX web server
  7. Date: Tue, 03 Mar 2020 11:14:46 GMT
  8. Last-Modified: Thu, 20 Feb 2020 14:21:41 GMT
  9. Apisix-Cache-Status: HIT
  11. hello

响应头 Apisix-Cache-Status 值变为了 HIT，说明文件已经被缓存

示例3：如何清理缓存的文件，只需要指定请求的 method 为 PURGE：

测试：

  1. $ curl -i http://127.0.0.1:9080/hello -X PURGE
  2. HTTP/1.1 200 OK
  3. Date: Tue, 03 Mar 2020 11:17:35 GMT
  4. Content-Type: text/plain
  5. Transfer-Encoding: chunked
  6. Connection: keep-alive
  7. Server: APISIX web server

响应码为200即表示删除成功，如果文件未找到将返回404

禁用插件

移除插件配置中相应的 JSON 配置可立即禁用该插件，无需重启服务：

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

这时该插件已被禁用。