eric28/dispatcher

在您的应用程序源代码中安排 artisan 命令

v1.4.3 2015-03-26 16:52 UTC

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 {

    //your command name, description etc.

	public function schedule(Schedulable $scheduler)
	{
        //every day at 4:17am
        return $scheduler
            ->daily()
            ->hours(4)
            ->minutes(17);
    }

}

Latest Stable Version Total Downloads Build Status Code Coverage Scrutinizer Code Quality

README 内容

## 特性
  • 自动运行 artisan 命令
  • 调度在版本控制系统中维护
  • 关于何时何地运行命令的单一真相来源
  • 计划带有参数和选项的命令运行
  • 以其他用户身份运行命令
  • 在特定环境中运行命令
  • 使用自定义驱动程序进行自定义调度上下文
## 教程

本教程由 Ben Kuhl 在 Laravel Louisville 线下聚会@lurvul)提供: 视频 - 幻灯片

本教程由 Jefferey Way 在 Laracasts 提供: Recurring Tasks the Laravel Way

## 安装

注意:Laravel 5 现已包含调度功能。此包将不再为 Laravel 5 及以上版本维护

如果您正在使用 Laravel 4,请查看 1.4 分支中的说明

将此行添加到您的 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,您需要在 * * * * * 之后立即指定一个用户。

您可以将其添加到任何用户的 crontab 中,但只有 root crontab 可以以其他用户身份运行命令。

### 从 1.4 升级到 2.0

在所有计划命令中...

  • 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 或遵循以下步骤。

  1. 在你的命令中添加使用语句。如果你使用的是自定义驱动,你将使用不同的 Scheduler 类。
use Indatus\Dispatcher\Scheduling\ScheduledCommand;
use Indatus\Dispatcher\Scheduling\Schedulable;
use Indatus\Dispatcher\Drivers\DateTime\Scheduler;
  1. 扩展 \Indatus\Dispatcher\Scheduling\ScheduledCommand
  2. 实现 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) { //每月第二和第三个星期二的午夜 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'
## 常见问题解答

我需要将部署到多个服务器,这些服务器代表单个环境。我如何确保我的命令只由一个服务器运行,而不是每个服务器都运行?

使用rcronscheduled:run安排为每分钟运行

* * * * * /usr/bin/rcron php /path/to/artisan scheduled:run 1>> /dev/null 2>&1

为什么我正确安排了命令,但它们没有运行?我也没有看到任何错误输出

  1. 通过命令php -i | mcrypt验证mcrypt是否已正确安装并运行。

  2. 使用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。