跳转到主内容
趣航编程网 - 趣学编程,启航技术之路!

Laravel如何对API响应结果进行缓存_Laravel对API响应结果进行缓存方法【接口】

Laravel中可通过Cache::remember封装、中间件统一拦截、Redis标签批量管理、代理层缓存第三方API及响应头协同CDN五种方式缓存API响应;需确保键唯一、数据脱敏、驱动支持标签、避免缓存敏感或动态内容,并合理设置TTL。

如果您在 Laravel 应用中频繁返回相同结构的 API 响应,但每次请求都重新查询数据库或调用外部服务,则可能造成不必要的性能损耗。以下是针对 API 响应结果实施缓存的具体操作方法:

一、使用 Cache::remember 封装响应数据

该方法适用于控制器中直接缓存查询结果并构造响应,避免重复执行耗时逻辑,同时自动处理缓存命中与未命中的全流程。

1、在控制器方法中定义唯一缓存键,例如

"api_products_list_page_{$request->input('page', 1)}";

2、调用

Cache::remember($key, $seconds, function () use ($request) { ... }),闭包内执行 Eloquent 查询或 HTTP 客户端调用;

3、确保闭包返回原始数组或集合,而非

response()->json()或 Resource 实例;

4、将闭包返回的数据传入

response()->json()构造最终响应。

二、在中间件中统一拦截并缓存 GET 请求

该方式无需修改每个控制器,适合对所有符合条件的只读 API 自动启用缓存,尤其适用于无用户上下文依赖的公开接口。

1、创建中间件类

ApiCacheMiddleware并注册为全局或路由组中间件;

2、在 handle 方法中判断请求是否为 GET、路径是否匹配白名单(如/api/products、/api/settings);

3、生成基于请求 URL 和查询参数哈希的缓存键,例如sha1($request->fullUrl());

4、尝试从缓存获取响应内容,若存在则直接返回

response($cached, 200)->header('X-Cache', 'HIT');

5、若未命中,继续执行后续逻辑,并在响应发送前将内容写入缓存(需监听kernel.handled事件或使用响应修饰器)。

三、使用 Redis 标签对关联 API 缓存进行批量管理

当多个 API 接口共享同一组底层数据(如商品、分类、品牌),某条数据更新时需同步失效所有相关缓存,标签机制可精准控制清除范围。

1、在缓存写入时使用

Cache::tags(['product', 'category'])->put($key, $data, $ttl);

2、在模型观察器中监听 Product::updated 事件;

Laravel 13.2.0 PHP中文网提供Laravel 13.2.0版本下载,Laravel框架 是基于 PHP 8.3+ 的高性能框架,官方推荐通过 Composer 安装。它内置 AI SDK、JSON:API Resources 及原生向量搜索,支持属性驱动开发与队列路由,大幅提升开发效率。相比旧版,13.2.0 优化了缓存 TTL 管理与实时通信,无需 Redis 即可横向扩展。作为现代 Web 开发首选,它兼顾安全与极速体验,助您快速构建企业级应用。

下载

3、触发

Cache::tags(['product'])->flush()清除全部带 product 标签的缓存项;

4、确保缓存驱动配置为 Redis 或 Memcached,因文件驱动不支持标签功能。

四、通过代理层统一缓存第三方 API 响应

当 Laravel 作为网关调用外部服务(如地图 API、支付回调验证接口),可在应用层前置代理逻辑,避免下游服务被高频重放请求。

1、封装一个

ThirdPartyApiClient类,所有对外请求经由此类发出;

2、在发送请求前检查

Cache::get("external_{$service}_{$hash}")是否存在;

3、若存在,直接返回解码后的 JSON 数组;

4、若不存在,发起真实 HTTP 请求,成功后将json_encode($response->body())写入缓存;

5、对敏感字段(如 token、session_id)在缓存前做脱敏处理,禁止缓存含email、phone的响应体。

五、基于响应头控制客户端与 CDN 缓存行为

该方法不改变 Laravel 内部缓存逻辑,而是协同前端与边缘节点减少回源次数,适用于静态程度高、时效要求宽松的接口。

1、在控制器响应中添加标准 HTTP 缓存头:Cache-Control: public, max-age=3600;

2、配合

Expires头指定绝对过期时间,格式为 RFC 7231 兼容的日期字符串;

3、对需区分用户身份的接口,设置

Vary: Authorization, X-User-ID头以支持多版本缓存;

4、确认 Web 服务器(Nginx/Apache)或 CDN 配置未覆盖或禁用这些响应头。

相关文章