Hyperf2.1框架定时任务的创建流程步骤

swoole  /  管理员 发布于 3年前   3069

hyperf定时任务官方手册上讲的很详细，我这里相当于把手册上的步骤流程重现了一遍，反正学习一个框架的东西你总要亲自敲一遍的

来段官方描述

通常来说，执行定时任务会通过 Linux 的 crontab 命令来实现，但现实情况下，并不是所有开发人员都能够拥有生产环境的服务器去设置定时任务的，这里 hyperf/crontab 组件为您提供了一个 秒级 定时任务功能，只需通过简单的定义即可完成一个定时任务的定义。

开始

安装  crontab组件包

[root@hyperf hyperf-skeleton]# composer require hyperf/crontab

注册定时任务 自定义进程

/hyperf/config/autoload/processes.php

return [
    //定时任务 自定义进程
    Hyperf\Crontab\Process\CrontabDispatcherProcess::class,
];

创建定时任务配置文件

/hyperf/config/autoload/crontab.php

<?php
/**
 * Created by PhpStorm.
 * User: houtizong
 * Date: 2021\4\23 0023
 * Time: 17:43
 */
use Hyperf\Crontab\Crontab;
return [
    // 是否开启定时任务
    'enable' => true,
    //通过配置文件定义定时任务
    'crontab' => [
        //Callback类型定时任务(默认)
        (new Crontab())->setName('Foo')->setRule('* * * × ×')->setCallback([App\Task\FooTask::class,'execute'])->setMemo('这是一个示例的定时任务'),
    ],
];

创建定时任务目录及控制器

/hyperf/app/Task/

创建定时任务控制器

/hyperf/app/Task/FooTask.php

通过注解定义

通过 @Crontab 注解可以快速完成对一个任务的定义，以下的定义示例与配置文件定义所达到的目的都是一样的。定义一个名为 Foo 每分钟执行一次 AppTaskFooTask::execute() 的定时任务。

<?php
/**
 * Created by PhpStorm.
 * User: houtizong
 * Date: 2021\4\23 0023
 * Time: 17:48
 */
namespace App\Task;
use Hyperf\Contract\StdoutLoggerInterface;
use Hyperf\Crontab\Annotation\Crontab;
use Hyperf\Di\Annotation\Inject;
/**
 * @Crontab(name="Foo", rule="* * * * *", callback="execute", memo="这是一个示例的定时任务")
 */
class FooTask
{
    /**
     * @Inject()
     * @var \Hyperf\Contract\StdoutLoggerInterface
     */
    private $logger;
    public function execute()
    {
        $this->logger->info(date('Y-m-d H:i:s', time()));
    }
}

启动框架   看看效果

[root@hyperf hyperf-skeleton]# php bin/hyperf.php start

...

[DEBUG] Crontab Foo have been registered.
[DEBUG] Crontab dispatcher sleep 28s.

...

[DEBUG] Crontab dispatcher sleep 59s.

...

[INFO] 2021-04-23 17:50:02
[INFO] Crontab task [Foo] executed successfully at 2021-04-23 17:50:02.
[DEBUG] Crontab dispatcher sleep 60s.

...

[INFO] 2021-04-23 17:51:00
[INFO] Crontab task [Foo] executed successfully at 2021-04-23 17:51:00.

如果进行数据库操作  或者 其他操作直接use 模型或其他类 进行调用

完