[原创]php任务调度器 hellogerard/jobby

一个强大的php层面上的定时任务调度器, 无需修改系统层面的crontab

实际中, php 结合 crontab 来实现定时任务是一种经得住考验的实践, 但每次新增/修改定时任务项时都需要去修改系统的crontab, 这会带来两个麻烦: 一个是繁琐, 一个是难以版本控制.

特点:

• 只需维护一个crontab主作业
• 子作业完全由PHP编写
• 支持标准crontab的调度时间格式
• 作业执行超时时可防止运行多个作业副本
• 作业执行出错退出时发送邮件通知
• 可以其他用户身份执行(若主crontab执行用户具有sudo权限)
• 支持仅在某个主机名上运行
• 理论上的Windows支持(包作者未测试过)

相关链接:

• https://packagist.org/packages/hellogerard/jobby
• https://github.com/jobbyphp/jobby

安装

php 5.4

composer require "hellogerard/jobby:3.4.1"

注意版本不要用3.4.1以上的, 会出问题(尽管packagist里3.4.2和3.4.3写着php>=5.4, 但实际会出问题)

php 更高版本

composer require hellogerard/jobby

配置crontab主作业

* * * * * cd /path/to/project && php jobby.php &>/dev/null

使用示例文件

cp vendor/hellogerard/jobby/resources/jobby.php .

标准使用

// 加载composer autoload
require_once __DIR__ . '/vendor/autoload.php';

// 创建Jobby实例
$jobby = new Jobby\Jobby();

// 每个job都有一个唯一名称
$jobby->add('CommandExample', [

    // 运行一个shell命令
    'command'  => 'ls',
    
    // 运行一个闭包(与 'command' 互斥)
    //'closure'  => function() {
    //    echo "I'm a function!\n";
    //    return true;
    //},

    // 支持通用调度配置
    'schedule' => '0 * * * *',
    
    // 可使用日期时间字符串
    //'schedule' => '2017-05-03 17:15:00',
    
    // 使用闭包返回boolean来确定是否执行
    //'schedule' => function(DateTimeImmutable $now) {
    //    // Run on even minutes
    //    return $now->format('i') % 2 === 0;
    //},

    
    // 标准输出/标准错误会写入到指定日志文件
    'output'   => 'logs/command.log',
    
    // 临时关闭某个任务
    'enabled'  => false,
]);

$jobby->run();

选项

每个任务的必须选项

以下的选项列表可应用于单个任务或全局任务(通过传入 Jobby构造器).

全局选项将会作为每个任务的默认配置, 单个任务可覆盖全局选项.

项目实践

项目存在多个不同游戏服, 且每个服使用的配置文件不一样, 因此执行定时任务时需对每个服单独执行, 特创建crontab.php 文件用于针对不同服分别调用 jobby.php

crontab配置

* * * * * cd /path/to/project && php crontab.php &>/dev/null

crontab.php

<?php
// 服务器列表, 实际是从其他地方读取的
$servers = ["s1", "s2", "s3", "s4"];
foreach ($servers as $server) {
    $cmd = sprintf("php jobby.php %s &>/dev/null &", $server);
    exec($cmd);
    var_dump(compact('cmd'));
}

jobby.php

<?php
// 环境配置
// ...

$server = $argv[1];    
 
$cmdPrefix = "php dispatcher.php $server ";

$jobby = new \Jobby\Jobby([
    'output' => "具体的日志输出文件路径",
]);
$jobs = require("jobby_config.php");
foreach ($jobs as $name => $job) {
    if (isset($config['command'])) {
        $config['command'] = $cmdPrefix.$config['command'];
    }
    $jobby->add($name, $job);
}
$jobby->run();

jobby_config.php

<?php
return [
    "check_index" => [
        'command' => "month_check_index",
        'schedule' => '30 5 1 * *',
        'maxRuntime' => 600,
    ],
    
    'minute_stats' => [
        'command' => "minute_stats",
        'schedule' => '* * * * *',
        'maxRuntime' => 300,
        'enabled' => true,
    ],
];

dispatcher.php 加载具体服的具体环境, 并调用实际要运行的php定时任务代码

$server = $argv[1];
$command = $argv[2];

// 加载具体服的环境配置
// ...

// 执行具体定时任务代码(此处忽略异常处理)
require __DIR__ . DIRECTORY_SEPARATOR . "jobs" . DIRECTORY_SEPARATOR . $command . ".php";

jobs/month_check_index.php

<?php
// 具体任务

jobs/minute_stats.php

<?php
// 具体任务