README

使用高性能的定时调度服务 forsun 的 Laravel/Lumen 组件。

主要特性

轻松支持千万级定时任务调度。
定时任务触发推送到 Queue，轻松支持跨机器和共性能分布式。
支持任务到期触发 command、Job、Shell、Http 和 Event。
支持驱动原生 Laravel Schedule 运行。
支持创建延时任务和定时到期任务，和原生 Laravel Schedule 保持相同接口，轻松使用。

安装

安装启动 forsun 服务，详情请看 forsun。
composer 安装 forsun-laravel。

composer require ericychu/forsun-laravel

配置

Laravel

在 config/app.php 注册 ServiceProvider 和 Facade

'providers' => [
    // ...
    Snower\LaravelForsun\ServiceProvider::class,
],
'aliases' => [
    // ...
    'Forsun' => Snower\LaravelForsun\Facade::class,
],

创建配置文件

php artisan vendor:publish --provider="Snower\LaravelForsun\ServiceProvider"

修改应用根目录下的 config/forsun.php 中对应的参数即可。

Lumen

在 bootstrap/app.php 注册 Service Provider 和 Facade

// 注册 Service Provider
$app->register(Snower\LaravelForsun\ServiceProvider::class);

// 注册 Facade
$app->withFacades(true, [
    ...,
    Snower\LaravelForsun\Facade::class => 'Forsun',
]);

拷贝配置文件

cp /PROJECT_DIRECTORY/vendor/ericychu/forsun-laravel/src/config.php /PROJECT_DIRECTORY/config/forsun.php

修改应用根目录下的 config/forsun.php 中对应的参数即可。

使用

定义调度

Artisan 命令调度。


//不指定 name 时自动生成
Forsun::plan()->command('emails:send --force')->daily();

//指定 name
Forsun::plan('email')->command(EmailsCommand::class, ['--force'])->daily();

队列任务调度

Forsun::plan()->job(new Heartbeat)->everyFiveMinutes();

Shell 命令调度

Forsun::plan()->exec('node /home/forge/script.js')->daily();

Event 事件调度

Forsun::plan()->fire('testevent', [])->everyMinute();

HTTP 事件调度

Forsun::plan()->http('https://www.google.com')->everyMinute();

注意：

每个任务只能设置一次调度频率。
不支持任务输出、任务钩子及维护模式。
Forsun::plan 是不指定任务名时自动生成，每个任务名必须唯一，相同任务名重复定义将会自动覆盖。

移除调度

$plan = Forsun::plan()->command('emails:send --force')->daily();
$plan->remove();

$plan = Forsun::plan()->command('emails:send --force')->daily();
$plan_name = $plan->getName();
Forsun::remove($plan_name);

调度频率设置

需要复杂定时控制建议生成多个定时任务或是在处理器中再次发起定时任务计划更简便同时也性能更高。

调度器应该尽可能使用Event或是Job通过Queue Work可以更高性能运行。

驱动原生Laravel Schedule运行

#注册
php artisan forsun:schedule:register

#取消注册
php artisan forsun:schedule:unregister

开发者

snower (twitter)

开源许可协议

The code for Predis is distributed under the terms of the MIT license (see LICENSE).

ericychu / forsun-laravel

Maintainers

Details