Hyperf3.0 注解 @Cacheable 缓存注解,缓存 key 动态参数写法

冬杰同学_4561

冬杰同学_4561

2026-10-05

268人浏览

原创

hyperf 3.0 的 @cacheable 支持轻量级 spel 表达式,支持参数引用(#id、#p0)、对象属性(#user.id)、数组键(#filters['status'])、字符串拼接(. 或 +)、空值处理(?:)、数组序列化(json_encode/md5)、自定义工具函数及 #root 上下文访问。

hyperf3.0 注解 @cacheable 缓存注解,缓存 key 动态参数写法

Hyperf 3.0 的 @Cacheable 注解支持 SpEL 表达式(Spring Expression Language 风格),但注意:Hyperf 并非 Spring,其 SpEL 实现是轻量级兼容版本(由 hyperf/cache 和 hyperf/annotation 模块提供),语法高度相似,但不完全等同于 Spring Boot 的完整 SpEL 功能。动态 key 的核心在于正确引用方法参数、调用工具方法、处理数组或对象属性。

基础参数引用写法

直接使用 #参数名 或 #p0、#p1 索引方式是最常用且最稳妥的写法:

  • #[Cacheable(key: "#id")] → 引用名为 id 的参数
  • #[Cacheable(key: "#p0")] → 引用第一个参数(索引从 0 开始)
  • #[Cacheable(key: "#user.id")] → 引用 $user 对象的 id 属性(要求对象有 public 属性或 getter)
  • #[Cacheable(key: "#filters['status']")] → 引用关联数组中键为 status 的值(PHP 数组语法兼容)

组合多个参数生成 key

用字符串拼接可清晰表达业务语义,推荐用单引号包裹字面量,避免解析歧义:

Hyperframes Creative
Hyperframes Creative

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

下载
  • #[Cacheable(key: "'search_' + #page + '_' + #perPage + '_' + #filters.status")]
  • #[Cacheable(key: "#userId . '_' . #category . '_' . #sortBy")](Hyperf 支持 . 拼接,更符合 PHP 习惯)
  • 若含空值风险,建议配合 ?: 默认值:#[Cacheable(key: "#userId . '_' . (#filters.type ?: 'all')")]

安全处理数组参数(关键痛点)

Hyperf 默认对数组参数直接 implode(':',$args),易导致键冲突或过长。应显式控制序列化逻辑:

  • 用 json_encode 标准化(注意排序与键顺序):#[Cacheable(key: "'list_' . md5(json_encode(#filters, JSON_UNESCAPED_UNICODE | JSON_FORCE_OBJECT))")]
  • 提取关键字段再拼接,避免全量数组:#[Cacheable(key: "'user_list_' . (#filters['role'] ?: 'all') . '_' . (#filters['enabled'] ?? 'any'))"]
  • 自定义工具函数(需在注解上下文中可访问):#[Cacheable(key: "App\Helper\CacheKeyHelper::buildSearchKey(#filters, #page)")],前提是该静态方法已注册并被注解处理器支持

使用 root 对象获取上下文信息

Hyperf 的 #root 提供当前方法元信息,适合通用缓存策略:

  • #root.methodName → 当前方法名,如 "searchUsers"
  • #root.target → 当前类实例,可用于调用辅助方法:#[Cacheable(key: "#root.target.getCachePrefix() . '_' . #id")]
  • #root.args → 参数数组,可配合 array_slice 或 implode 使用(慎用于含数组的场景)

相关专题

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

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

2023.09.01

10104

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

3748

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万人学习