后台任务

说明

在后台任务中，因为是运行在task进程，所以无法使用协程和协程客户端。如果你要操作数据库或Redis，一定要配置同步的连接池。

配置

项目配置文件中mainServer.configs.task_worker_num一定要配置为大于0，否则无法使用后台任务。

定义任务执行类

  1. <?php
  2. namespace Test;
  4. use Imi\Task\TaskParam;
  5. use Imi\Task\Interfaces\ITaskHandler;
  7. class Test implements ITaskHandler
  8. {
  9.     /**
  10.      * 任务处理方法
  11.      * @param TaskParam $param
  12.      * @param \Swoole\Server $server
  13.      * @param integer $taskID
  14.      * @param integer $WorkerID
  15.      * @return void
  16.      */
  17.     public function handle(TaskParam $param, \Swoole\Server $server, int $taskID, int $WorkerID)
  18.     {
  19.         // 投递任务时的数据
  20.         $data = $param->getData();
  21.     }
  23.     /**
  24.      * 任务结束时触发
  25.      * @param \swoole_server $server
  26.      * @param int $taskId
  27.      * @param mixed $data
  28.      * @return void
  29.      */
  30.     public function finish(\Swoole\Server $server, int $taskID, $data)
  31.     {
  33.     }
  34. }

类名无所谓，实现ITaskHandler接口和两个方法即可。

投递任务

投递异步任务

  1. TaskManager::post(new TaskInfo(
  2.     // 上面定义的类的实例
  3.     new TestTask,
  4.     // 执行任务的参数，构造方法可以接收一个数组
  5.     new TaskParam([
  6.         'time'    =>    time(),
  7.     ])
  8. ));

调用后立即返回，不影响下面代码的执行

同步投递任务

  1. TaskManager::postWait(new TaskInfo(
  2.     // 上面定义的类的实例
  3.     new TestTask,
  4.     // 执行任务的参数，构造方法可以接收一个数组
  5.     new TaskParam([
  6.         'time'    =>    time(),
  7.     ]),
  8.     // 最长等待时间，单位：秒
  9.     0.5
  10. ));

投递任务后阻塞等待执行完毕或超时，返回值为任务执行结果或false

协程批量投递任务

  1. TaskManager::postCo([new TaskInfo(
  2.     // 上面定义的类的实例
  3.     new TestTask,
  4.     // 执行任务的参数，构造方法可以接收一个数组
  5.     new TaskParam([
  6.         'time'    =>    time(),
  7.     ])
  8. )],
  9. // 最长等待时间，单位：秒
  10. 0.5);

传入数组和超时时间，投递后挂起协程，当全部执行完毕或超时后返回结果。返回值为数组，对应每个任务的执行结果。

注解

定义任务执行类

  1. <?php
  2. namespace Test;
  4. use Imi\Task\TaskParam;
  5. use Imi\Task\Interfaces\ITaskHandler;
  7. /**
  8.  * @Task("testTask")
  9.  */
  10. class Test implements ITaskHandler
  11. {
  12.     /**
  13.      * 任务处理方法
  14.      * @param TaskParam $param
  15.      * @param \Swoole\Server $server
  16.      * @param integer $taskID
  17.      * @param integer $WorkerID
  18.      * @return void
  19.      */
  20.     public function handle(TaskParam $param, \Swoole\Server $server, int $taskID, int $WorkerID)
  21.     {
  22.         // 投递任务时的数据
  23.         $data = $param->getData();
  24.     }
  26.     /**
  27.      * 任务结束时触发
  28.      * @param \swoole_server $server
  29.      * @param int $taskId
  30.      * @param mixed $data
  31.      * @return void
  32.      */
  33.     public function finish(\Swoole\Server $server, int $taskID, $data)
  34.     {
  36.     }
  37. }

类名无所谓，实现ITaskHandler接口和两个方法即可。

投递任务

投递异步任务

  1. TaskManager::nPost(
  2. // 任务名称
  3. 'testTask'
  4. // 任务参数
  5. , [
  6.     'time'    =>    time(),
  7. ]
  8. );

调用后立即返回，不影响下面代码的执行

同步投递任务

  1. TaskManager::nPostWait(new TaskInfo(
  2.     // 任务名称
  3.     'testTask'
  4.     // 任务参数
  5.     , [
  6.         'time'    =>    time(),
  7.     ]
  8.     // 最长等待时间，单位：秒
  9.     0.5
  10. ));

投递任务后阻塞等待执行完毕或超时，返回值为任务执行结果或false

协程批量投递任务

  1. TaskManager::postWait([
  2. ['testTask', ['time'=>time()]],
  3. ['testTask', ['time'=>time()]],
  4. ],
  5. // 最长等待时间，单位：秒
  6. 0.5);