php Swoole實現毫秒級定時任務

項目開發中，如果有定時任務的業務要求，我們會使用linux的crontab來解決，但是它的最小粒度是分鍾級別，如果要求粒度是秒級別的，甚至毫秒級別的，crontab就無法滿足，值得慶幸的是swoole提供的強大的毫秒定時器。

應用場景舉例
我們可能會遇到這樣的場景：

• 場景一：每隔30秒獲取一次本機內存使用率
• 場景二：2分鍾后執行報表發送任務
• 場景三：每天凌晨2點鍾定時請求第三方接口，如果接口有數據返回則停止任務，如果接口由於某種原因沒有響應或者沒有數據返回則5分鍾后繼續嘗試請求該接口，嘗試5次后仍然失敗則停止該任務

以上的三個場景我們都可以歸納為定時任務的范疇。

Swoole毫秒定時器
Swoole提供了異步毫秒定時器函數：

swoole_timer_tick(int $msec, callable $callback)：設置一個間隔時鍾定時器，每隔$msec毫秒執行一次$callback，類似於javascript中的setInterval()。

swoole_timer_after(int $after_time_ms, mixed $callback_function)：在指定的時間$after_time_ms后執行$callback_function，類似於javascript的setTimeout()。

swoole_timer_clear(int $timer_id)：刪除指定id的定時器，類似於javascript的clearInterval()。

解決方案

對於場景一，經常用在系統檢測統計方面，實時性要求比較高，但又能控制好頻率，多用於后台服務器性能監控，可以生成可視化圖表。可以是30秒獲取一次內存使用率，也可以是10秒，而crontab最小粒度只能設置為1分鍾。

swoole_timer_tick(30000, function($timer) use ($task_id) { // 啟用定時器，每30秒執行一次
    $memPercent = $this->getMemoryUsage(); //計算內存使用率
    echo date('Y-m-d H:i:s') . '當前內存使用率：'.$memPercent."\n";
});

 

 

對於場景二，直接定義xx時間后執行某項任務的話，貌似crontab比較困難，而使用swoole的swoole_timer_after可以實現：

swoole_timer_after(120000, function() use ($str) { //2分鍾后執行
    $this->sendReport(); //發送報表
    echo "send report, $str\n";
});

 

對於場景三，用來作嘗試請求，請求失敗后繼續，如果成功則停止請求。用crontab也能解決，但是比較傻，比如設置每隔5分鍾請求一次，不管成功會失敗都會去執行一次。而用swoole定時器則智能多了。

swoole_timer_tick(5*60*1000, function($timer) use ($url) { // 啟用定時器，每5分鍾執行一次
    $rs = $this->postUrl($url);

    if ($rs) {
        //業務代碼...
        swoole_timer_clear($timer); // 停止定時器
        echo date('Y-m-d H:i:s'). "請求接口任務執行成功\n";
    } else {
        echo date('Y-m-d H:i:s'). "請求接口失敗，5分鍾后再次嘗試\n";
    }
});

 

示例代碼

新建文件\src\App\Task.php：

<?php 
namespace Helloweba\Swoole;

use swoole_server;

/**
* 任務調度
*/
class Task
{
    protected $serv;
    protected $host = '127.0.0.1';
    protected $port = 9506;
    // 進程名稱
    protected $taskName = 'swooleTask';
    // PID路徑
    protected $pidPath = '/run/swooletask.pid';
    // 設置運行時參數
    protected $options = [
        'worker_num' => 4, //worker進程數,一般設置為CPU數的1-4倍  
        'daemonize' => true, //啟用守護進程
        'log_file' => '/data/log/swoole-task.log', //指定swoole錯誤日志文件
        'log_level' => 0, //日志級別 范圍是0-5，0-DEBUG，1-TRACE，2-INFO，3-NOTICE，4-WARNING，5-ERROR
        'dispatch_mode' => 1, //數據包分發策略,1-輪詢模式
        'task_worker_num' => 4, //task進程的數量
        'task_ipc_mode' => 3, //使用消息隊列通信，並設置為爭搶模式
    ];

    public function __construct($options = [])
    {
        date_default_timezone_set('PRC'); 
        // 構建Server對象，監聽127.0.0.1:9506端口
        $this->serv = new swoole_server($this->host, $this->port);

        if (!empty($options)) {
            $this->options = array_merge($this->options, $options);
        }
        $this->serv->set($this->options);

        // 注冊事件
        $this->serv->on('Start', [$this, 'onStart']);
        $this->serv->on('Connect', [$this, 'onConnect']);
        $this->serv->on('Receive', [$this, 'onReceive']);
        $this->serv->on('Task', [$this, 'onTask']);  
        $this->serv->on('Finish', [$this, 'onFinish']);
        $this->serv->on('Close', [$this, 'onClose']);
    }

    public function start()
    {
        // Run worker
        $this->serv->start();
    }

    public function onStart($serv)
    {
        // 設置進程名
        cli_set_process_title($this->taskName);
        //記錄進程id,腳本實現自動重啟
        $pid = "{$serv->master_pid}\n{$serv->manager_pid}";
        file_put_contents($this->pidPath, $pid);
    }

    //監聽連接進入事件
    public function onConnect($serv, $fd, $from_id)
    {
        $serv->send( $fd, "Hello {$fd}!" );
    }

    // 監聽數據接收事件
    public function onReceive(swoole_server $serv, $fd, $from_id, $data)
    {
        echo "Get Message From Client {$fd}:{$data}\n";
        //$this->writeLog('接收客戶端參數：'.$fd .'-'.$data);
        $res['result'] = 'success';
        $serv->send($fd, json_encode($res)); // 同步返回消息給客戶端
        $serv->task($data);  // 執行異步任務
    }

    /**
    * @param $serv swoole_server swoole_server對象
    * @param $task_id int 任務id
    * @param $from_id int 投遞任務的worker_id
    * @param $data string 投遞的數據
    */
    public function onTask(swoole_server $serv, $task_id, $from_id, $data)
    {
        swoole_timer_tick(30000, function($timer) use ($task_id) { // 啟用定時器，每30秒執行一次
            $memPercent = $this->getMemoryUsage();
            echo date('Y-m-d H:i:s') . '當前內存使用率：'.$memPercent."\n";
        });
    }


    /**
    * @param $serv swoole_server swoole_server對象
    * @param $task_id int 任務id
    * @param $data string 任務返回的數據
    */
    public function onFinish(swoole_server $serv, $task_id, $data)
    {
        //
    }


    // 監聽連接關閉事件
    public function onClose($serv, $fd, $from_id) {
        echo "Client {$fd} close connection\n";
    }

    public function stop()
    {
        $this->serv->stop();
    }

    private function getMemoryUsage()
    {
        // MEMORY
        if (false === ($str = @file("/proc/meminfo"))) return false;
        $str = implode("", $str);
        preg_match_all("/MemTotal\s{0,}\:+\s{0,}([\d\.]+).+?MemFree\s{0,}\:+\s{0,}([\d\.]+).+?Cached\s{0,}\:+\s{0,}([\d\.]+).+?SwapTotal\s{0,}\:+\s{0,}([\d\.]+).+?SwapFree\s{0,}\:+\s{0,}([\d\.]+)/s", $str, $buf);
        //preg_match_all("/Buffers\s{0,}\:+\s{0,}([\d\.]+)/s", $str, $buffers);

        $memTotal = round($buf[1][0]/1024, 2);
        $memFree = round($buf[2][0]/1024, 2);
        $memUsed = $memTotal - $memFree;
        $memPercent = (floatval($memTotal)!=0) ? round($memUsed/$memTotal*100,2):0;

        return $memPercent;
    }
}

 

 

我們以場景一為例，在onTask啟用定時任務，每隔30秒計算一次內存使用率。實際應用中可以把計算好的內存按時間寫入數據庫等存儲中，然后可以根據前端需求用來渲染成統計圖表，如：

​

接着服務端代碼 public\taskServer.php ：

<?php 
require dirname(__DIR__) . '/vendor/autoload.php';

use Helloweba\Swoole\Task;

$opt = [
    'daemonize' => false
];
$ser = new Task($opt);
$ser->start();

 

 

客戶端代碼 public\taskClient.php :

<?php 
class Client
{
    private $client;

    public function __construct() {
        $this->client = new swoole_client(SWOOLE_SOCK_TCP);
    }

    public function connect() {
        if( !$this->client->connect("127.0.0.1", 9506 , 1) ) {
            echo "Error: {$this->client->errMsg}[{$this->client->errCode}]\n";
        }
        fwrite(STDOUT, "請輸入消息 Please input msg：");
        $msg = trim(fgets(STDIN));
        $this->client->send( $msg );
        $message = $this->client->recv();
        echo "Get Message From Server:{$message}\n";
    }
}

$client = new Client();
$client->connect();

 

驗證效果

1.啟動服務端：

php taskServer.php

 

2.客戶端輸入：

另開命令行窗口，執行

[root@localhost public]# php taskClient.php 
請輸入消息 Please input msg：hello
Get Message From Server:{"result":"success"}
[root@localhost public]# 

 

3.服務端返回：

​

如果返回上圖中的結果，則定時任務正常運行，我們會發現每隔30秒會輸出一條信息。

 

很多PHPer在進階的時候總會遇到一些問題和瓶頸，業務代碼寫多了沒有方向感，不知道該從那里入手去提升，對此我整理了一些資料，包括但不限於：分布式架構、高可擴展、高性能、高並發、服務器性能調優、TP6，laravel，YII2，Redis，Swoole、Swoft、Kafka、Mysql優化、shell腳本、Docker、微服務、Nginx等多個知識點高級進階干貨需要的可以免費分享給大家，需要的加群（點擊→）677079770