Hyperf 3.1 异步队列注解用法详解【技巧】

夜宇吖_5225

夜宇吖_5225

2026-08-08

152人浏览

原创

在hyperf 3.1中需启用注解扫描并配置async_queue.php的processes>0,使用@asyncqueuemessage注解方法,调用时由aop拦截自动投递至redis队列,消费者进程反序列化后反射执行。

hyperf 3.1 异步队列注解用法详解【技巧】

要在 Hyperf 3.1 中用注解方式快速投递异步任务,避免手动 new Job → push 的冗余流程,必须让框架自动识别方法并封装为队列任务,同时确保消费进程能正确加载和执行。

启用注解支持并确认基础配置

先检查项目是否已启用 Hyperf 的注解扫描机制:打开 config/autoload/annotations.php,确认 'scan' => ['paths' => [...]] 包含你的 app/app/Service 目录;若缺失,需手动补全,否则 @AsyncQueueMessage 注解不会被解析。

确保 config/autoload/async_queue.php'processes' 值大于 0,例如 'processes' => 1 —— 【这是消费者进程能否启动的硬性前提】,设为 0 将导致整个异步队列静默失效。

运行 php bin/hyperf.php start 后,控制台应出现 Process[AsyncQueueProcess] start 日志,否则说明进程未注册或配置未生效。

定义带 @AsyncQueueMessage 注解的方法

在任意 Service 类中(如 app/Service/OrderService.php),添加一个 public 方法,并在其上方标注 @AsyncQueueMessage

方法一:最简写法(无参数)
#[AsyncQueueMessage]
public function sendNotification(): void { echo '通知已异步发送'; }

方法二:带参数(参数会自动序列化进队列)
#[AsyncQueueMessage]
public function processOrder(int $orderId, string $status): void { // 处理逻辑 }

注意:参数类型必须是可序列化的(int/string/array/object),不能传 resource、Closure 或未实现 Serializable 的自定义对象——【传入 Closure 会导致反序列化失败并静默丢弃任务】

Hyperframes Creative
Hyperframes Creative

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

下载

调用注解方法触发投递

第一步:在控制器或任意业务代码中获取该 Service 实例:$orderService = $this->container->get(OrderService::class);

第二步:直接调用被注解的方法:$orderService->processOrder(1001, 'paid');

这一步不会同步执行方法体,而是由 Hyperf 的 AOP 拦截器捕获调用,自动将方法名、参数、类名打包成任务,推入 Redis 队列 channel。整个过程对业务代码完全透明,无需感知 Job 类或 push 操作。

第三步:消费者进程从 Redis 读取该任务,反序列化参数,再反射调用原方法——此时才真正执行 processOrder 内部逻辑。

定制投递行为(可选)

① 指定队列通道:#[AsyncQueueMessage(channel: 'order')],对应 async_queue.php 中同名配置项,用于隔离不同业务队列。

② 设置延迟执行(毫秒级):#[AsyncQueueMessage(delay: 60000)],表示 60 秒后执行;注意:Hyperf 3.1 默认使用 Redis ZSET 实现延时,需确保 delay_queue.php 已正确配置且专用 delayed 进程已启用。

③ 控制重试次数:#[AsyncQueueMessage(maxAttempts: 3)],失败后最多重试 2 次(即总共执行 3 次),超过则进入失败队列(需手动清理或监听失败事件)。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

hyperf异步队列 hyperf

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Hyperf协程并发编程实操指南
Hyperf协程并发编程实操指南

本专题深度解析 Hyperf 协程底层机制,解决协程环境下全局变量污染、Context 上下文丢失等核心痛点,提供规范化的 PHP 高并发编程实战代码建议。

2026.05.19

160

15

深入理解Hyperf AOP切面与注解使用
深入理解Hyperf AOP切面与注解使用

详尽介绍 Hyperf 依赖注入容器与 AOP 面向切面编程的使用技巧,包含自定义注解开发流程及注解不生效的排查方案,助力开发者掌握框架核心架构。

2026.05.19

404

16

Hyperf 数据库操作与连接池优化方案
Hyperf 数据库操作与连接池优化方案

针对 Hyperf Eloquent 模型在大数据量下的表现进行深度优化,讲解连接池断线重连、超时设置及事务处理等生产环境常见技术疑难。

2026.05.19

184

15

基于 Hyperf 的微服务架构集成实战
基于 Hyperf 的微服务架构集成实战

本专题涵盖 Hyperf 微服务全栈解决方案,包括服务注册与发现、配置中心集成、JsonRPC 调用以及分布式限流熔断的落地实践。

2026.05.19

196

18

Hyperf 高并发缓存与分布式系统应用
Hyperf 高并发缓存与分布式系统应用

讲解在协程模式下如何高效操作 Redis,实现高性能分布式锁、处理缓存击穿/雪崩问题,并提供基于 Hyperf 的分布式事务处理思路。

2026.05.19

388

15

Hyperf 项目部署运维与性能调优手册
Hyperf 项目部署运维与性能调优手册

聚焦 Hyperf 在生产环境的落地,包含 Docker 高效打包、Swoole 配置优化、常见的内存溢出(OOM)问题排查方法以及热更新方案。

2026.05.19

365

15

Hyperf PHP 微服务框架高性能开发实战
Hyperf PHP 微服务框架高性能开发实战

本专题围绕 Hyperf 框架展开,讲解微服务架构设计、协程异步处理、服务注册与发现、RPC 通信及性能优化策略。通过完整项目示例,帮助开发者构建高效、稳定、可扩展的 PHP 分布式服务系统。

2026.06.08

156

23

Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

2026.09.21

0

20

NumPy随机数文件读写与dtype数据类型
NumPy随机数文件读写与dtype数据类型

本专题整理 NumPy 随机数、文件读写与 dtype 数据类型相关教程,覆盖 Generator/random、随机数种子、正态分布采样、npy/npz/CSV/TXT 保存读取、loadtxt/savetxt、memmap、大文件处理、astype 类型转换、结构化 dtype、整数溢出和精度丢失等场景。

2026.09.21

0

24

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共29课时 | 2.2万人学习