proxy-cache

描述

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

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

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

参数

名称类型必选项默认值有效值描述
cache_strategystring可选disk[“disk”,”memory”]缓存策略，指定缓存数据存储在磁盘还是内存中
cache_zonestring可选disk_cache_one指定使用哪个缓存区域，不同的缓存区域可以配置不同的路径，在 conf/config.yaml 文件中可以预定义使用的缓存区域。当不使用默认值时，指定的缓存区域与 conf/config.yaml 文件中预定义的缓存区域不一致，缓存无效。
cache_keyarray[string]可选[“$host”, “$request_uri”]缓存key，可以使用变量。例如：[“$host”, “$uri”, “-cache-id”]
cache_bypassarray[string]可选是否跳过缓存检索，即不在缓存中查找数据，可以使用变量，需要注意当此参数的值不为空或非’0’时将会跳过缓存的检索。例如：[“$arg_bypass”]
cache_methodarray[string]可选[“GET”, “HEAD”][“GET”, “POST”, “HEAD”]根据请求method决定是否需要缓存
cache_http_statusarray[integer]可选[200, 301, 404][200, 599]根据响应码决定是否需要缓存
hide_cache_headersboolean可选false是否将 Expires 和 Cache-Control 响应头返回给客户端
cache_controlboolean可选false是否遵守 HTTP 协议规范中的 Cache-Control 的行为
no_cachearray[string]可选是否缓存数据，可以使用变量，需要注意当此参数的值不为空或非’0’时将不会缓存数据
cache_ttlinteger可选300 秒当选项 cache_control 未开启或开启以后服务端没有返回缓存控制头时，提供的默认缓存时间

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

在 conf/config.yaml 文件中的配置示例:

  1. proxy_cache:                       # 代理缓存配置
  2.     cache_ttl: 10s                 # 如果上游未指定缓存时间，则为默认缓存时间
  3.     zones:                         # 缓存的参数
  4.     - name: disk_cache_one         # 缓存名称(缓存区域)，管理员可以通过admin api中的 cache_zone 字段指定要使用的缓存区域
  5.       memory_size: 50m             # 共享内存的大小，用于存储缓存索引
  6.       disk_size: 1G                # 磁盘大小，用于存储缓存数据
  7.       disk_path: "/tmp/disk_cache_one" # 存储缓存数据的路径
  8.       cache_levels: "1:2"          # 缓存的层次结构级别

示例

启用插件

示例一：cache_zone 参数默认为 disk_cache_one

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_key":  ["$uri", "-cache-id"],
  6.             "cache_bypass": ["$arg_bypass"],
  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
  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
  12. 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
  12. hello

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

示例二：自定义 cache_zone 参数为 disk_cache_two

1、在 conf/config.yaml 文件中的指定缓存区域等信息:

  1. proxy_cache:
  2.     cache_ttl: 10s
  3.     zones:
  4.     - name: disk_cache_two
  5.       memory_size: 50m
  6.       disk_size: 1G
  7.       disk_path: "/tmp/disk_cache_one"
  8.       cache_levels: "1:2"

2、为特定路由启用 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_two",
  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
  12. hello

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

3、验证数据是否被缓存，再次请求上面的地址：

  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
  12. hello

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

示例3：指定 cache_zone 为 invalid_disk_cache 与 conf/config.yaml 文件中指定的缓存区域 disk_cache_one 不一致。

  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": "invalid_disk_cache",
  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. {"error_msg":"failed to check the configuration of plugin proxy-cache err: cache_zone invalid_disk_cache not found"}

响应错误信息，表示插件配置无效。

清除缓存数据

如何清理缓存的数据，只需要指定请求的 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。

再次请求，缓存数据未找到返回 404：

  1. $ curl -i http://127.0.0.1:9080/hello -X PURGE
  2. HTTP/1.1 404 Not Found
  3. Date: Wed, 18 Nov 2020 05:46:34 GMT
  4. Content-Type: text/plain
  5. Transfer-Encoding: chunked
  6. Connection: keep-alive
  7. Server: APISIX web server
  10. <html>
  11. <head><title>404 Not Found</title></head>
  12. <body>
  13. <center><h1>404 Not Found</h1></center>
  14. <hr><center>openresty</center>
  15. </body>
  16. </html>

禁用插件

移除插件配置中相应的 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. }'

这时该插件已被禁用。