定時器任務,在WEB應用比較常見,如何使用PHP實現定時器任務,大致有兩種方案:1)使用Crontab命令,寫一個shell腳本,在腳本中調用PHP文件,然後定期執行該腳本;2)配合使用ignore_user_abort()和set_time_limit(),使腳本脫離浏覽器運行。前者是利用Linux的特性,和PHP本身沒有多大關系,後者使用場景有限,且只能由一次HTTP請求觸發該腳本,執行完後退出。那麼我們如何使用純PHP實現純粹的定時器任務,且能適應認識任務業務需求?
基礎知識
此程序在Linux下開發,以cli模式運行,一下是基本知識的簡要介紹。
實現原理
用一個三維數組保存所有需要執行的任務,一級索引為時間戳,值為執行任務的方法、回調參數等,具體數組形式如下:
array( '1438156396' => array( array(1,array('Class','Func'), array(), true), ) ) 說明: 1438156396 時間戳 array(1,array('Class','Func'), array(), true) 參數依次表示: 執行時間間隔,回調函數,傳遞給回調函數的參數,是否持久化(ture則一直保存在數據中,否則執行一次後刪除)
這些任務可以是任意類的方法。既然是定時任務,我們需要一個類似計時的東東,此方案采用信號量去做,每一秒向當前進程發送SIGALRM信號,並捕獲該信號,觸發信號處理函數,循環遍歷數據,判斷是否有當前時間需要執行的任務。如果有則采用回調方式觸發,並把參數傳遞給該方法。
1 <?php 2 /** 3 *定時器 4 */ 5 class Timer 6 { 7 //保存所有定時任務 8 public static $task = array(); 9 10 //定時間隔 11 public static $time = 1; 12 13 /** 14 *開啟服務 15 *@param $time int 16 */ 17 public static function run($time = null) 18 { 19 if($time) 20 { 21 self::$time = $time; 22 } 23 self::installHandler(); 24 pcntl_alarm(1); 25 } 26 /** 27 *注冊信號處理函數 28 */ 29 public static function installHandler() 30 { 31 pcntl_signal(SIGALRM, array('Timer','signalHandler')); 32 } 33 34 /** 35 *信號處理函數 36 */ 37 public static function signalHandler() 38 { 39 self::task(); 40 //一次信號事件執行完成後,再觸發下一次 41 pcntl_alarm(self::$time); 42 } 43 44 /** 45 *執行回調 46 */ 47 public static function task() 48 { 49 if(empty(self::$task)) 50 {//沒有任務,返回 51 return ; 52 } 53 foreach(self::$task as $time => $arr) 54 { 55 $current = time(); 56 57 foreach($arr as $k => $job) 58 {//遍歷每一個任務 59 $func = $job['func']; /*回調函數*/ 60 $argv = $job['argv']; /*回調函數參數*/ 61 $interval = $job['interval']; /*時間間隔*/ 62 $persist = $job['persist']; /*持久化*/ 63 64 if($current == $time) 65 {//當前時間有執行任務 66 67 //調用回調函數,並傳遞參數 68 call_user_func_array($func, $argv); 69 70 //刪除該任務 71 unset(self::$task[$time][$k]); 72 } 73 if($persist) 74 {//如果做持久化,則寫入數組,等待下次喚醒 75 self::$task[$current+$interval][] = $job; 76 } 77 } 78 if(empty(self::$task[$time])) 79 { 80 unset(self::$task[$time]); 81 } 82 } 83 } 84 85 /** 86 *添加任務 87 */ 88 public static function add($interval, $func, $argv = array(), $persist = false) 89 { 90 if(is_null($interval)) 91 { 92 return; 93 } 94 $time = time()+$interval; 95 //寫入定時任務 96 self::$task[$time][] = array('func'=>$func, 'argv'=>$argv, 'interval'=>$interval, 'persist'=>$persist); 97 } 98 99 /** 100 *刪除所有定時器任務 101 */ 102 public function dellAll() 103 { 104 self::$task = array(); 105 } 106 }
這是定時器類核心部分,有一個靜態變量保存有所有需要執行的任務,這裡為什麼是靜態的呢?大家自行思考.當進程接受到 SIGALRM 信號後,觸發 signalHandler 函數,隨後循序遍歷數組查看是否有當前時間需要執行的任務,有則回調,並傳遞參數,刪除當前job,隨後檢查是否要做持久化任務,是則繼續將當前job寫入事件數組等待下次觸發,最後再為當前進程設置一個鬧鐘信號.可以看出這個定時器,只要觸發一次就會從內部再次觸發,得到自循環目的.
1 <?php 2 3 class DoJob 4 { 5 public function job( $param = array() ) 6 { 7 $time = time(); 8 echo "Time: {$time}, Func: ".get_class()."::".__FUNCTION__."(".json_encode($param).")\n"; 9 } 10 }
這是回調類及函數,為方便說明,加入不少調試信息.Timer類及回調都有了,我們看看使用場景是怎麼樣的.
1 <?php 2 3 require_once(__DIR__."/Timer.php"); 4 require_once(__DIR__."/DoJob.php"); 5 6 7 Timer::dellAll(); 8 9 Timer::add( 1, array('DoJob','job'), array(),true); 10 11 Timer::add( 3, array('DoJob','job'),array('a'=>1), false); 12 13 echo "Time start: ".time()."\n"; 14 Timer::run(); 15 16 while(1) 17 { 18 sleep(1); 19 pcntl_signal_dispatch(); 20 }
代碼非常短,這裡注冊了兩個job,隨後運行定時器,在一個無限循環裡捕捉信號觸發動作,如果不捕獲將無法觸發事先注冊的處理函數.這樣一個自循環的定時器開發完成.運行結果如下:
如我們場景類添加的任務一樣,在90的時候執行了兩個任務,一個為持久化的不帶參數的job,一個為非持久化帶參數的job,隨後非持久化job不再執行.
總結