yzh52521 / yii2-scheduling
Yii2框架的调度扩展
Requires
- php: >=7.4.0
- dragonmantank/cron-expression: ^3.0
- nesbot/carbon: ^2.0
- symfony/process: >=5.4
- yiisoft/yii2: 2.0.*
Requires (Dev)
- phpunit/phpunit: 4.8.36
Suggests
- guzzlehttp/guzzle: Required to use the thenPing method on schedules (~6.0).
This package is auto-updated.
Last update: 2024-08-25 07:10:44 UTC
README
此扩展是Laravel的Schedule组件(https://laravel.net.cn/docs/master/scheduling#scheduling-artisan-commands)的移植。
安装
安装此扩展的最佳方式是通过 composer。
运行以下命令之一:
composer require yzh52521/yii2-scheduling "*"
或添加以下内容到您的 composer.json 的 require
部分。
"yzh52521/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)
在一个服务器上运行任务
要利用此功能,您必须在应用程序组件中配置mutex,除了FileMutex:
yii\mutex\MysqlMutex
、yii\mutex\PgsqlMutex
、yii\mutex\OracleMutex
或yii\redis\Mutex
。此外,所有服务器都必须与同一个中央数据库/缓存服务器通信。
以下显示了redis mutex演示
'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 \omnilight\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 中包含对 yzh52521\yii2-scheduling
的依赖项。
...
'require': {
"yzh52521/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 omnilight\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
组件
如果您只想在应用程序中使用调度(并且不想允许扩展注册它们自己的cron作业),则不需要直接使用 schedule
组件或将其定义为应用程序。但是,如果您想允许扩展注册cron作业,则应在应用程序配置中定义 schedule
组件。
'schedule' => 'omnilight\scheduling\Schedule',
使用附加功能
如果您想使用Event的 thenPing
方法,则应将以下字符串添加到您的应用 composer.json
中
"guzzlehttp/guzzle": "~6.0"
时区说明
请注意,这是一个PHP扩展,因此它使用PHP配置或您的Yii配置文件中定义的时区,因此请正确设置它们。