README

本扩展是 Laravel 的 Schedule 组件（https://laravel.net.cn/docs/master/scheduling#scheduling-artisan-commands）的移植

安装

安装此扩展的最佳方式是通过 composer。

运行以下命令之一：

php composer.phar require rubarbs/yii2-scheduling "*"

或者将以下内容添加到您的 composer.json 文件的 require 部分：

"rubarbs/yii2-scheduling": "*"

描述

本项目受 Laravel 的 Schedule 组件启发，旨在将它的简洁性引入 Yii 框架。引用自 Laravel 文档

In the past, developers have generated a Cron entry for each console command they wished to schedule.
However, this is a headache. Your console schedule is no longer in source control,
and you must SSH into your server to add the Cron entries. Let's make our lives easier.

安装后，您只需在 crontab 中添加一行即可

* * * * * php /path/to/yii yii schedule/run --scheduleFile=@path/to/schedule.php 1>> /dev/null 2>&1

您可以将您的调度放入 schedule.php 文件中，或者在其扩展或应用程序启动时添加

调度示例

此扩展支持 Laravel 的 Schedule 所有功能，除了环境和维护模式。

调度闭包

$schedule->call(function()
{
    // Do some task...

})->hourly();

调度终端命令

$schedule->exec('composer self-update')->daily();

运行应用程序的命令

$schedule->command('migrate')->cron('* * * * *');

频繁任务

$schedule->command('foo')->everyFiveMinutes();

$schedule->command('foo')->everyTenMinutes();

$schedule->command('foo')->everyThirtyMinutes();

每日任务

$schedule->command('foo')->daily();

每日特定时间（24 小时制）的任务

$schedule->command('foo')->dailyAt('15:00');

每日两次任务

$schedule->command('foo')->twiceDaily();

每周工作日运行的任务

$schedule->command('foo')->weekdays();

每周任务

$schedule->command('foo')->weekly();

// Schedule weekly job for specific day (0-6) and time...
$schedule->command('foo')->weeklyOn(1, '8:00');

每月任务

$schedule->command('foo')->monthly();

在特定日期运行的任务

$schedule->command('foo')->mondays();
$schedule->command('foo')->tuesdays();
$schedule->command('foo')->wednesdays();
$schedule->command('foo')->thursdays();
$schedule->command('foo')->fridays();
$schedule->command('foo')->saturdays();
$schedule->command('foo')->sundays();

仅在回调为真时允许任务运行

$schedule->command('foo')->monthly()->when(function()
{
    return true;
});

将调度任务的输出通过电子邮件发送

$schedule->command('foo')->sendOutputTo($filePath)->emailOutputTo('foo@example.com');

防止任务冲突

$schedule->command('foo')->withoutOverlapping();

默认使用 yii\mutex\FileMutex 或 'mutex' 应用组件（https://yiiframework.cn/doc-2.0/yii-mutex-mutex.html）

在单个服务器上运行任务

要利用此功能，您必须在应用程序组件中配置互斥锁，除了 FileMutex：yii\mutex\MysqlMutex、yii\mutex\PgsqlMutex、yii\mutex\OracleMutex 或 yii\redis\Mutex。此外，所有服务器都必须与同一个中央数据库/缓存服务器通信。

以下展示 Redis 互斥锁的示例

'components' => [
    'mutex' => [
        'class' => 'yii\redis\Mutex',
        'redis' => [
            'hostname' => 'localhost',
            'port' => 6379,
            'database' => 0,
        ]
    ],
],

$schedule->command('report:generate')
                ->fridays()
                ->at('17:00')
                ->onOneServer();

如何在您的应用程序中使用此扩展？

您应该在 @console/config/schedule.php 下创建以下文件（注意：您可以在服务器上的任何位置创建任何名称和扩展名的文件，只需调整下面命令中的 scheduleFile 名称即可）

<?php
/**
 * @var \rubarbs\scheduling\Schedule $schedule
 */

// Place here all of your cron jobs

// This command will execute ls command every five minutes
$schedule->exec('ls')->everyFiveMinutes();

// This command will execute migration command of your application every hour
$schedule->command('migrate')->hourly();

// This command will call callback function every day at 10:00
$schedule->call(function(\yii\console\Application $app) {
    // Some code here...
})->dailyAt('10:00');

接下来，您应该在 crontab 中添加以下命令

* * * * * php /path/to/yii yii schedule/run --scheduleFile=@console/config/schedule.php 1>> /dev/null 2>&1

这就完成了！现在，所有的 cron 作业都将按照您在 schedule.php 文件中配置的方式运行。

如何在您的扩展中使用此扩展？

首先，您应该在您的 composer.json 中包含对 rubarbs\yii2-scheduling 的依赖

...
'require': {
    "rubarbs/yii2-schedule": "*"
}
...

接下来，您应该创建您扩展的启动类，如 https://yiiframework.cn/doc-2.0/guide-structure-extensions.html#bootstrapping-classes 中所述

在启动方法中放置以下代码

public function bootstrap(Application $app)
{
    if ($app instanceof \yii\console\Application) {
        if ($app->has('schedule')) {
            /** @var rubarbs\scheduling\Schedule $schedule */
            $schedule = $app->get('schedule');
            // Place all your shedule command below
            $schedule->command('my-extension-command')->dailyAt('12:00');
        }
    }
}

在您的扩展的 README 中添加用户注册 schedule 组件以及将 schedule/run 命令添加到 crontab 的信息，如上所述。

使用 schedule 组件

如果您仅在应用程序中使用 schedule（并且不想让扩展注册它们自己的 cron 作业），则无需直接使用 schedule 组件或将其定义在应用程序中。但如果您想让扩展注册 cron 作业，则应在应用程序配置中定义 schedule 组件

'schedule' => 'rubarbs\scheduling\Schedule',

使用附加函数

如果您想使用 Event 的 thenPing 方法，应将以下字符串添加到您应用的 composer.json 文件中

"guzzlehttp/guzzle": "~5.0"

关于时区说明

请注意，这是一个 PHP 扩展，因此它使用 php 配置或您的 Yii 配置文件中定义的时区，所以请正确设置它们。