如何在Hyperf中通过注解实现方法缓存_使用Cacheable注解配置value及key

星辰君_1403

星辰君_1403

2026-05-23

293人浏览

原创

cacheable注解的value填缓存命名空间(如"user:profile"),必须是字符串字面量,用于redis键前缀或逻辑分组;key才决定唯一性,需用spel表达式(如"#userid"或"'user:'+ #id")动态生成。

如何在hyperf中通过注解实现方法缓存_使用cacheable注解配置value及key

Cacheable注解的value参数到底填什么

value 参数不是缓存值本身,而是缓存的「存储命名空间」,对应 Redis 中的 key 前缀或 Swoole Table 的逻辑分组。它必须是字符串字面量(不能是变量或表达式),且通常建议与业务域强相关,比如 "user:profile" 或 "order:list"。

填错最常见的后果是:多个方法共用同一 value,导致缓存互相覆盖;或者填了空字符串/纯空格,触发框架默认行为(如 fallback 到类名+方法名),造成预期外的 key 冲突。

  • ✅ 推荐写法:@Cacheable(value="article:detail", ttl=3600)
  • ❌ 错误写法:@Cacheable(value=$this->cachePrefix, ...)(PHP 不支持注解里用变量)
  • ⚠️ 注意:value 不参与 key 计算,它只是分类标识;真正决定缓存唯一性的,是下面说的 key 参数

key参数怎么写才能正确区分不同参数调用

key 是生成最终缓存键的核心,必须是 SpEL(Spring Expression Language)风格的字符串表达式,Hyperf 会用反射提取方法参数并求值。它决定了“同一个方法、不同入参”是否命中不同缓存项。

常见错误是直接写死字符串(如 key="'user'"),结果所有调用都写进同一个 key;或者误以为能用 PHP 数组语法,实际只能用 SpEL 的 #p0、#p1、#userId 等占位符。

  • ✅ 按第一个参数生成 key:@Cacheable(key="#p0", value="user:info")
  • ✅ 按命名参数生成复合 key:@Cacheable(key="'user:' + #userId + ':profile'", value="user:profile")
  • ✅ 多参数拼接(注意单引号包裹整个表达式):@Cacheable(key="'order:' + #uid + ':' + #status", value="order:list")
  • ❌ 错误:key="user:#userId"(缺少引号,SpEL 解析失败,抛 ParseErrorException)

缓存失效和手动清除时,value和key怎么配合

用 @CacheEvict 清除缓存时,value 必须和 @Cacheable 完全一致,而 key 表达式也需保持逻辑对称——否则清不掉。

Hyperframes Creative
Hyperframes Creative

HyperFrames视频非动画创意指导,包括设计规范(frame.md/design.md)处理、配色、字体设计、旁白及节奏规划等。

下载

例如,某个方法用 @Cacheable(key="'user:' + #id", value="user:info") 缓存,那么清除时就得写 @CacheEvict(key="'user:' + #id", value="user:info")。如果清除方法的 key 写成 #id,那实际删的是 "123" 而不是 "user:123",缓存就漏了。

  • ✅ 清除单个:@CacheEvict(key="'user:' + #id", value="user:info")
  • ✅ 清除整个命名空间(慎用):@CacheEvict(allEntries=true, value="user:info")
  • ⚠️ 注意:Hyperf 默认不支持通配符清除(如 key="user:*"),Redis 后端需自行扩展或改用 allEntries

为什么有时候缓存没生效,但日志也没报错

最常被忽略的是方法可见性 —— @Cacheable 只对 public 方法 生效。如果目标方法是 protected 或 private,AOP 代理无法拦截,注解完全静默失效,也不会报错。

另一个隐蔽点是返回值类型:Hyperf 的缓存序列化依赖 serialize(),如果方法返回对象且该对象含闭包、资源句柄或未实现 __serialize(),缓存写入会静默失败(Redis 存的是空或 false)。

  • ✅ 确保方法为 public:public function getUserInfo(int $id): array { ... }
  • ✅ 返回简单数组、标量或可序列化对象(避免 StdClass 套嵌资源)
  • ✅ 开启调试:在 config/autoload/cache.php 中确认 'default' => 'redis' 配置正确,且 Redis 连接可达

缓存键生成逻辑藏在代理层,不打日志就看不到真实 key;真要排查,得在 CacheAspect 相关源码里加临时 var_dump,或者用 redis-cli monitor 抓命令流。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10124

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

5981

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2075

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3768

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4454

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3491

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

4977

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3902

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11862

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Hyperf官方中文手册(3.1)
Hyperf官方中文手册(3.1)

共0课时 | 0人学习

Swoole系列-从0到1-新手进阶
Swoole系列-从0到1-新手进阶

共29课时 | 2.3万人学习