Laravel任务调度的简单使用

创建任务

在命令行执行下面的命令生产自定义任务文件,比如说创建一个定时取消订单的任务OrderCancel

php artisan make:command OrderCancel

命令执行完后会生成app/Console/Commands/OrderCancel.php文件

编写任务

在上一步生成的文件中编写代码,signature变量为执行的命令,handle()方法中写具体的实现逻辑

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class OrderCancel extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'order:cancel';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = '30分钟未付款取消订单';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     * @throws
     */
    public function handle()
    {
        echo 'The order has been cancelled'.PHP_EOL;
        return true;
    }
}

启动调度器

执行单个任务

在命令行直接执行自定义的执行命令即可测试方法,例如

php artisan order:cancel

会在命令行输出The order has been cancelled

执行全部任务

app/Console/Kernel.phpschedule方法中添加需要执行的全部任务

$schedule->command('order:cancel')->everyMinute();

然后执行下面的命令即可

php artisan schedule:run

everyMinute()是任务调度的时间控制,更多用法可以参考 Laravel入坑指南(番外)——任务调度 - 咚..咚 - 博客园 (cnblogs.com)

注意事项:php artisan schedule:run这个命令下echo不会在控制台打印,可以使用laravel自带的Log记录

自动执行任务

linux系统的crontab中添加下面的任务,每秒执行一次

* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1

如果需要精确到毫秒级的定时任务,可以自己写shell脚本来执行任务调度

并行执行任务

如果有多个任务调度,一般是顺序执行的,也就是要等第一个任务执行完成第二个才会开始执行,如果要让任务并行执行的话,需要在schedule方法中调用runInBackground()方法,例如

$schedule->command('order:cancel')->everyMinute()->runInBackground();

任务重复处理

如果一个任务执行需要5秒时间,但是任务是每秒执行的,就会出现上一次任务还没执行完,同一个任务又开始了,为了避免这种情况,需要在schedule方法中调用withoutOverlapping()方法,例如

$schedule->command('order:cancel')->withoutOverlapping();      //锁默认24小时失效
$schedule->command('order:cancel')->withoutOverlapping(10);    //锁10分钟失效

在任务执行的时候会添加一个锁,在加锁状态下任务是不会执行的,知道任务执行完成。当然还可以使用外部的手段来加锁,比如文件锁flock,或者redis的setnx都可以

输出重定向

schedule方法中调用appendOutputTo()方法可以指定输出流的文件

$schedule->command('order:cancel')->appendOutputTo($filePath);

任务钩子

使用 beforeafter 方法,你可以指定在调度任务完成之前和之后要执行的代码

$schedule->command('order:cancel')
        ->daily()
         ->before(function () {
             // 任务即将开始...
         })
         ->after(function () {
             // 任务已经完成...
         });

参考文档

Laravel入坑指南(番外)——任务调度 - 咚..咚 - 博客园 (cnblogs.com)

任务调度 |《Laravel 5.5 中文文档 5.5》| Laravel China 社区 (learnku.com)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容