Apache APISIX API响应缓存实战指南

Apache APISIX API响应缓存实战指南

apisix The Cloud-Native API Gateway 项目地址: https://gitcode.com/gh_mirrors/ap/apisix

前言：为什么需要API响应缓存

在现代分布式系统中，API网关作为流量入口，其性能直接影响整个系统的响应速度。当面对以下场景时，引入缓存机制将显著提升系统性能：

• 高并发读取相同数据的场景
• 后端服务响应延迟明显的接口
• 数据更新频率较低的查询接口
• 需要减轻数据库压力的高频查询

API网关缓存机制解析

缓存层级架构

1. 边缘缓存：CDN层面的缓存
2. 数据库缓存：查询结果缓存
3. 服务端缓存：应用层缓存
4. 浏览器缓存：客户端本地缓存
5. 反向代理缓存：API网关层缓存

Apache APISIX提供的proxy-cache插件正是基于反向代理缓存机制，能够在网关层对API响应进行高效缓存。

Apache APISIX缓存实战

环境准备

假设我们已经有一个运行中的ASP.NET Core Web API服务，提供一个获取产品列表的接口/api/products。该接口数据每天仅更新一次，但会被频繁调用。

配置proxy-cache插件

1. 启用插件：在APISIX配置文件中添加proxy-cache插件

plugins:
  - http-logger
  - ip-restriction
  - proxy-cache

2. 缓存区配置（可选）：

proxy_cache:
  cache_ttl: 10s # 默认缓存时间
  zones:
    - name: disk_cache_one
      memory_size: 50m # 共享内存大小
      disk_size: 1G # 磁盘缓存大小
      disk_path: "/tmp/disk_cache_one" # 缓存路径
      cache_levels: "1:2" # 缓存层级

3. 动态重载插件：

curl http://127.0.0.1:9180/apisix/admin/plugins/reload \
  -H "X-API-KEY: $admin_key" -X PUT

创建上游和路由

1. 配置上游服务：

curl "http://127.0.0.1:9180/apisix/admin/upstreams/1" \
  -H "X-API-KEY: edd1c9f034335f136f87ad84b625c8f1" \
  -X PUT -d '
{
  "type": "roundrobin",
  "nodes": {
    "productapi:80": 1
  }
}'

2. 创建带缓存的路由：

curl "http://127.0.0.1:9180/apisix/admin/routes/1" \
  -H "X-API-KEY: edd1c9f034335f136f87ad84b625c8f1" \
  -X PUT -d '{
  "name": "产品API缓存路由",
  "methods": ["GET"],
  "uri": "/api/products",
  "plugins": {
    "proxy-cache": {
      "cache_key": ["$uri", "-cache-id"],
      "cache_bypass": ["$arg_bypass"],
      "cache_method": ["GET"],
      "cache_http_status": [200],
      "hide_cache_headers": true,
      "no_cache": ["$arg_test"]
    }
  },
  "upstream_id": 1
}'

关键配置说明

• cache_key: 定义缓存键的组成要素
• cache_bypass: 指定绕过缓存的参数
• cache_method: 仅缓存GET请求
• cache_http_status: 只缓存200状态码的响应
• hide_cache_headers: 隐藏缓存相关头信息
• no_cache: 指定不缓存的参数条件

缓存效果验证

首次请求（缓存未命中）

curl http://localhost:9080/api/products -i

响应头中包含：

Apisix-Cache-Status: MISS

后续请求（缓存命中）

curl http://localhost:9080/api/products -i

响应头中包含：

Apisix-Cache-Status: HIT

缓存过期后请求

当缓存TTL过期后：

Apisix-Cache-Status: EXPIRED

性能对比测试

为了直观展示缓存效果，可以在后端API中添加延迟：

[HttpGet]
public IActionResult GetAll()
{
    Thread.Sleep(5000); // 5秒延迟
    return Ok(_productsService.GetAll());
}

测试响应时间：

curl -i 'http://localhost:9080/api/products' \
  -s -o /dev/null \
  -w "Response time: %{time_starttransfer} seconds\n"

• 无缓存时：响应时间约5秒
• 有缓存时：响应时间毫秒级

高级应用场景

1. 条件缓存：基于请求参数、头信息等条件决定是否缓存
2. 缓存分区：对不同业务数据使用不同的缓存区
3. 缓存清理：通过管理API主动清理特定缓存
4. 多级缓存：结合内存和磁盘缓存优化性能

最佳实践建议

1. 对GET请求优先考虑启用缓存
2. 根据数据更新频率设置合理的TTL
3. 对敏感数据谨慎使用缓存
4. 监控缓存命中率指标
5. 定期评估缓存配置效果

总结

通过Apache APISIX的proxy-cache插件，我们能够轻松实现API响应缓存，显著提升系统性能。这种网关层缓存方案具有以下优势：

• 实施简单，无需修改业务代码
• 性能提升明显，降低后端压力
• 配置灵活，支持多种缓存策略
• 易于维护，可动态调整配置

对于高并发系统中的读多写少场景，合理使用API网关缓存是提升系统性能的有效手段。

apisix The Cloud-Native API Gateway 项目地址: https://gitcode.com/gh_mirrors/ap/apisix