indatus / dispatcher
在您的应用程序源代码中安排 artisan 命令
Requires
- php: >=5.3.2
- mtdowling/cron-expression: ~1.0.3
- wp-cli/php-cli-tools: v0.9.4-patch46
Requires (Dev)
- mockery/mockery: ~0.9
- orchestra/testbench: ~2.1.1
- phpunit/phpunit: ~4.0
README
Dispatcher 允许您在 Laravel 项目中安排 artisan 命令,消除部署时需要触摸 crontab 的需求。它还允许命令按环境运行,并将您的调度逻辑保留在版本控制中。
use Indatus\Dispatcher\Scheduling\ScheduledCommand; use Indatus\Dispatcher\Scheduling\Schedulable; use Indatus\Dispatcher\Drivers\DateTime\Scheduler; class MyCommand extends ScheduledCommand { public function schedule(Schedulable $scheduler) { //every day at 4:17am return $scheduler ->daily() ->hours(4) ->minutes(17); } }
README 内容
## 特性- 自动运行 artisan 命令
- 调度在版本控制系统内维护
- 命令运行的时间和地点的单一来源
- 带参数和选项的计划命令
- 以其他用户身份运行命令
- 在特定环境中运行命令
- 使用自定义驱动程序进行自定义调度上下文
由 Ben Kuhl 在Laravel Louisville 线下活动(@lurvul)发表: 视频 - 幻灯片
由 Jefferey Way 在Laracasts发表:使用 Laravel 的方式处理重复任务
## 安装注意:Laravel 5 现在默认包含调度功能。此包将不再维护 Laravel 5 及以上版本
如果您正在使用 Laravel 4,请参阅 1.4 分支的 readme 文件
将此行添加到您的 config/app.php
文件中的 providers 数组中
'Indatus\Dispatcher\ServiceProvider',
将以下内容添加到您的根 Crontab 中(通过 sudo crontab -e
)
* * * * * php /path/to/artisan scheduled:run 1>> /dev/null 2>&1
如果您要将此添加到 /etc/cron.d
,您需要在 * * * * *
之后立即指定用户。
### 从 1.4 升级到 2.0您可以将此添加到任何用户的 Crontab 中,但只有 root crontab 可以以其他用户身份运行命令。
在所有计划命令中...
- 将
use Indatus\Dispatcher\Drivers\Cron\Scheduler
替换为use Indatus\Dispatcher\Drivers\DateTime\Scheduler
- 将
Scheduler::[DAY_OF_WEEK]
的使用替换为Day::[DAY_OF_WEEK]
,将Scheduler::[MONTH_OF_YEAR]
的使用替换为Month::[MONTH_OF_YEAR]
- 已删除
executable
配置选项。现在,Dispatcher 继承了最初用于运行scheduled:run
的二进制文件的路径。
scheduled:scheduled:make 创建一个新的计划 artisan 命令 scheduled:run 运行计划命令 scheduled:summary 查看所有计划 artisan 命令的摘要
如果命令通过 php artisan
不可见,则无法进行计划。
使用 php artisan scheduled:make
生成一个新的计划命令,这与使用 artisan 的 command:make
相同。然后 在 Laravel 中注册您的命令。
您可以实现 \Indatus\Dispatcher\Scheduling\ScheduledCommandInterface
或遵循以下步骤。
- 在您的命令中添加 use 语句。如果您使用的是自定义驱动程序,则将使用不同的
Scheduler
类。
use Indatus\Dispatcher\Scheduling\ScheduledCommand; use Indatus\Dispatcher\Scheduling\Schedulable; use Indatus\Dispatcher\Drivers\DateTime\Scheduler;
- 扩展
\Indatus\Dispatcher\Scheduling\ScheduledCommand
- 实现 schedule()
/** * When a command should run * * @param Scheduler $scheduler * * @return Scheduler */ public function schedule(Schedulable $scheduler) { return $scheduler; }
有关如何计划的详细信息以及示例,请参阅 DateTime 驱动程序。
### 以用户身份运行命令您可以通过覆盖 user()
来以特定用户身份运行指定的 artisan 命令。请确保您的 scheduled:run
artisan 命令是以 root 身份运行的。
public function user() { return 'backup'; }
### 环境特定命令注意:此功能可能不被所有驱动支持。
您可以通过覆盖 environment()
来确保您的命令仅在特定的环境中进行调度。它应该提供单个环境或一组环境。
public function environment() { return ['development','staging']; }### 维护模式
默认情况下,当应用程序处于维护模式时,cron 命令将 不会 运行。这可以防止在迁移数据库或进行 composer 更新时,运行 cron 命令可能出现的各种奇怪输出。
您可以通过覆盖 runInMaintenanceMode()
来强制在应用程序处于维护模式时仍运行您的命令。
public function runInMaintenanceMode() { return true; }### 高级调度
您可以通过 schedule()
返回多个 Schedulable
实例来将给定的命令调度到多个时间点。
public function schedule(Schedulable $scheduler) { return [ // 5am Mon-Fri $scheduler->everyWeekday()->hours(5), // 2am every Saturday App::make(get_class($scheduler)) ->daysOfTheWeek(Scheduler::SATURDAY) ->hours(2) ]; }
您还可以使用参数和选项来调度命令的运行。
public function schedule(Schedulable $scheduler) { return [ // 相当于:php /path/to/artisan command:name /path/to/file $scheduler->args(['/path/to/file']) ->everyWeekday() ->hours(5), // 相当于:php /path/to/artisan command:name /path/to/file --force --toDelete="expired" --exclude="admins" --exclude="developers" $scheduler->args(['/path/to/file']) ->opts([ 'force', 'toDelete' => 'expired', 'exclude' => [ 'admins', 'developers' ] ]) ->daysOfTheMonth([1, 15]) ->hours(2) ]; }
## 驱动程序注意:无论是先调用
args()
还是opts()
,都会内部为您创建一个新的Schedulable
实例,因此您不需要调用App::make()
。
驱动程序提供添加额外上下文到您调度的能力。构建自定义驱动程序 是根据您应用程序的需求自定义此上下文的绝佳方式。
### 日期时间(默认)如何安排的示例:
public function schedule(Schedulable $scheduler) { //每天早上4:17 return $scheduler->daily()->hours(4)->minutes(17); }
public function schedule(Schedulable $scheduler) { //每周二/周四早上5:03 return $scheduler->daysOfTheWeek([ Scheduler::TUESDAY, Scheduler::THURSDAY ])->hours(5)->minutes(3); }
public function schedule(Schedulable $scheduler) { //每月第二个和第三个星期二午夜12点 return $scheduler->monthly()->week([2, 3])->daysOfTheWeek(Day::TUESDAY); }## 自定义驱动程序
自定义驱动程序允许你在安排中提供应用程序上下文。例如,一个基于教育的应用程序可能包含像inServiceDays()
、springBreak()
和christmasBreak()
这样的安排方法,在这些时间段内运行或停止运行命令。
创建一个包路径,例如\MyApp\ScheduleDriver\
,并创建两个类:
Scheduler
实现Indatus\Dispatcher\Scheduling\Schedulable
。这个类应该为程序员提供一个有用的接口来安排他们的命令。ScheduleService
扩展\Indatus\Dispatcher\Services\ScheduleService
。这个类包含逻辑,以确定一个命令是否应该运行。
使用php artisan config:publish indatus/dispatcher
发布配置。然后更新你的驱动程序配置,以引用包含这两个类的包(不要包含末尾的反斜杠):
'driver' => '\MyApp\ScheduleDriver'
## 常见问题解答 我需要将部署到代表单个环境的多个服务器。我如何确保我的命令只由单个服务器运行,而不是在每台服务器上运行?
使用rcron将scheduled:run
安排为每分钟运行。
* * * * * /usr/bin/rcron php /path/to/artisan scheduled:run 1>> /dev/null 2>&1
为什么我的命令在正确安排后没有运行?我也没有看到任何错误输出。
-
通过命令
php -i | mcrypt
验证是否已安装并正确配置了mcrypt。 -
使用
php artisan scheduled:run --debug
将告诉你为什么它们没有运行。如果你没有看到你的命令在这里列出,那么它没有被正确设置。
示例
$ php artisan scheduled:run --debug
Running commands...
backup:avatars: No schedules were due
command:name: No schedules were due
myTestCommand:name: No schedules were due
cache:clean: /usr/bin/env php /Users/myUser/myApp/artisan cache:clean > /dev/null &
mail:subscribers: /usr/bin/env php /Users/myUser/myApp/artisan mail:subscribers > /dev/null &
我的命令扩展了ScheduledCommand
,但为什么它们没有在运行scheduled:summary
时出现?
禁用的命令将不会出现在这里。请检查并确保在这些命令上isEnabled()
返回true。