启动调度器
* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1
定义调度
call(function () {
DB::table('recent_users')->delete();
})->daily();
}
}
// 闭包执行调度
$schedule->call(function () {})->daily();
// Artisan 命令调度
$schedule->command('emails:send Taylor --force')->daily();
// Artisan 命令调度,另一种写法
$schedule->command(EmailsCommand::class, ['Taylor', '--force'])->daily();
// Shell 调度命令
$schedule->exec('node /home/forge/script.js')->daily();
// 队列任务调度
$schedule->job(new Heartbeat)->everyFiveMinutes();
// 分发任务到「heartbeats」队列
$schedule->job(new Heartbeat, 'heartbeats')->everyFiveMinutes();
调度频率
调度计划:
->cron('* * * * *'); 自定义 Cron 计划执行任务
->everyMinute(); 每分钟执行一次任务
->everyTwoMinutes(); 每两分钟执行一次任务
->everyFiveMinutes(); 每五分钟执行一次任务
->everyTenMinutes(); 每十分钟执行一次任务
->everyThirtyMinutes(); 每三十分钟执行一次任务
->hourly(); 每小时执行一次任务
->hourlyAt(17); 每小时第 17 分钟执行一次任务
->everyTwoHours(); 每两小时执行一次任务
->daily(); 每天 0 点执行一次任务
->dailyAt('13:00'); 每天 13:00 执行一次任务
->twiceDaily(1, 13); 每天 01:00 和 13:00 各执行一次任务
->weekly(); 每周日 00:00 执行一次任务
->weeklyOn(1, '8:00'); 每周一的 08:00 执行一次任务
->monthly(); 每月第一天 00:00 执行一次任务
->monthlyOn(4, '15:00'); 每月 4 号的 15:00 执行一次任务
->lastDayOfMonth('15:00'); 每月最后一天 15:00 执行一次任务
->quarterly(); 每季度第一天 00:00 执行一次任务
->yearly(); 每年第一天 00:00 执行一次任务
其他约束条件:
->weekdays(); 限制任务在工作日执行
->weekends(); 限制任务在周末执行
->sundays(); 限制任务在周日执行
->mondays(); 限制任务在周一执行
->tuesdays(); 限制任务在周二执行
->wednesdays(); 限制任务在周三执行
->thursdays(); 限制任务在周四执行
->fridays(); 限制任务在周五执行
->saturdays(); 限制任务在周六执行
->days(array|mixed); 限制任务在每周的指定日期执行
->between($start, $end); 限制任务在 $start 和 $end 区间执行
->unlessBetween($start, $end); 限制任务不在 $start 和 $end 区间执行
->when(Closure); 限制任务在闭包返回为真时执行
->skip(Closure); 限制任务在闭包返回为真时不执行
->environments(array|mixed); 限制任务在特定环境中执行
避免任务重复执行
$schedule->command('emails:send')->withoutOverlapping();
withoutOverlapping 会对任务进行加锁,默认24小时过期,可通过参数传入过期时间。
限制单个服务器执行任务
应用默认缓存驱动必须是database
、memcached
或redis
才能使用这个特性。并且所有服务器必须使用同一台中央缓存服务器。
$schedule->command('report:generate')
->fridays()
->at('17:00')
->onOneServer();
后台执行任务
默认情况下,任务是顺序串行执行的。使用 runInBackground
方法可以让命令在后台同时运行。
$schedule->command('analytics:report')
->daily()
->runInBackground();
该方法只支持通过command
和exec
方法执行的任务。
任务输出
$schedule->command('emails:send')
->daily()
->appendOutputTo($filePath)
->emailOutputTo('[email protected]');
$schedule->command('foo')
->daily()
->emailOutputOnFailure('[email protected]');
任务输出只支持command
和exec
方法执行的任务。
任务钩子
$schedule->command('emails:send')
->daily()
->before(function () {
// 任务即将开始...
})
->after(function () {
// 任务结束...
});
$schedule->command('emails:send')
->daily()
->onSuccess(function () {
// 任务成功...
})
->onFailure(function () {
// 任务失败...
});