基础进阶 - 异步任务

优质
小牛编辑
132浏览
2023-12-01

参考DEMO:异步任务处理

异步任务管理器类:EasySwoole\Core\Swoole\Task\TaskManager

在服务启动后的任意一个地方,都可以进行异步任务的投递,为了简化异步任务的投递,框架封装了任务管理器,用于投递同步/异步任务,投递任务有两种方式,一是直接投递闭包,二是投递任务模板类

直接投递闭包

任务比较简单的情况下可以直接投递闭包,任意地方包括控制器/定时器/服务启动后的各种回调中均可进行投递

  1. // 在控制器中投递的例子
  2. function index()
  3. {
  4. \EasySwoole\Core\Swoole\Task\TaskManager::async(function () {
  5. echo "执行异步任务...\n";
  6. return true;
  7. }, function () {
  8. echo "异步任务执行完毕...\n";
  9. });
  10. }
  11. // 在定时器中投递的例子
  12. \EasySwoole\Core\Swoole\Time\Timer::loop(1000, function () {
  13. \EasySwoole\Core\Swoole\Task\TaskManager::async(function () {
  14. echo "执行异步任务...\n";
  15. });
  16. });

投递任务模板类

当任务比较复杂,逻辑较多而且固定时,可以预先创建任务模板,并直接投递任务模板,以简化操作和方便在多个不同的地方投递相同的任务,首先需要创建一个任务模板

异步任务模板类:EasySwoole\Core\Swoole\Task\TaskManager

  1. class Task extends \EasySwoole\Core\Swoole\Task\AbstractAsyncTask
  2. {
  3. /**
  4. * 执行任务的内容
  5. * @param mixed $taskData 任务数据
  6. * @param int $taskId 执行任务的task编号
  7. * @param int $fromWorkerId 派发任务的worker进程号
  8. * @author : evalor <master@evalor.cn>
  9. */
  10. function run($taskData, $taskId, $fromWorkerId)
  11. {
  12. // 需要注意的是task编号并不是绝对唯一
  13. // 每个worker进程的编号都是从0开始
  14. // 所以 $fromWorkerId + $taskId 才是绝度唯一的编号
  15. // !!! 任务完成需要 return 结果
  16. }
  17. /**
  18. * 任务执行完的回调
  19. * @param mixed $result 任务执行完成返回的结果
  20. * @param int $task_id 执行任务的task编号
  21. * @author : evalor <master@evalor.cn>
  22. */
  23. function finish($result, $task_id)
  24. {
  25. // 任务执行完的处理
  26. }
  27. }

然后同上例,一样可以在服务启动后的任何地方进行投递,只是将闭包换成任务模板类的实例进行投递

  1. // 在控制器中投递的例子
  2. function index()
  3. {
  4. // 实例化任务模板类 并将数据带进去 可以在任务类$taskData参数拿到数据
  5. $taskClass = new Task('taskData');
  6. \EasySwoole\Core\Swoole\Task\TaskManager::async($taskClass);
  7. }
  8. // 在定时器中投递的例子
  9. \EasySwoole\Core\Swoole\Time\Timer::loop(1000, function () {
  10. \EasySwoole\Core\Swoole\Task\TaskManager::async($taskClass);
  11. });

任务并发执行

有时需要同时执行多个异步任务,最典型的例子是数据采集,采集完多个数据后集中进行处理,这时可以进行并发任务投递,底层会将任务逐个进行投递并执行,所有任务执行完后返回一个结果集

  1. $tasks[] = function () { sleep(50000); }; // 任务1
  2. $tasks[] = function () { sleep(2); }; // 任务2
  3. $tasks[] = function () { sleep(50000); }; // 任务3
  4. $results = \EasySwoole\Core\Swoole\Task\TaskManager::barrier($tasks, 0.5);

注意:Barrier为阻塞等待执行,所有的任务会被分发到不同Task进程同步执行, 直到所有的任务执行结束或超时才返回全部结果,默认的任务超时为0.5秒,所以只有任务1和任务3能成功执行并返回结果

类函数参考

  1. /**
  2. * 投递一个异步任务
  3. * @param mixed $task 需要投递的异步任务
  4. * @param mixed $finishCallback 任务执行完后的回调函数
  5. * @param int $taskWorkerId 指定投递的Task进程编号 (默认随机投递给空闲进程)
  6. * @return bool 投递成功 返回整数 $task_id 投递失败 返回 false
  7. */
  8. static function async($task,$finishCallback = null,$taskWorkerId = -1)
  1. /**
  2. * 投递一个同步任务
  3. * @param mixed $task 需要投递的异步任务
  4. * @param float $timeout 任务超时时间
  5. * @param int $taskWorkerId 指定投递的Task进程编号 (默认随机投递给空闲进程)
  6. * @return bool|string 投递成功 返回整数 $task_id 投递失败 返回 false
  7. */
  8. static function sync($task, $timeout = 0.5, $taskWorkerId = -1)
  1. /**
  2. * 并发执行多个任务
  3. * @param array $taskList 需要执行的任务列表
  4. * @param float $timeout 任务执行超时
  5. * @return array|bool 每个任务的执行结果
  6. */
  7. static function barrier(array $taskList, $timeout = 0.5)