thinkphp6 消息隊列(queue)使用方法


安裝

composer require topthink/think-queue

配置

配置文件位於 config/queue.php

公共配置

[
    'default'=>'sync' //驅動類型,可選擇 sync(默認):同步執行,database:數據庫驅動,redis:Redis驅動//或其他自定義的完整的類名
]

創建任務類

單模塊項目推薦使用 app\job 作為任務類的命名空間 多模塊項目可用使用 app\module\job 作為任務類的命名空間 也可以放在任意可以自動加載到的地方

任務類不需繼承任何類,如果這個類只有一個任務,那么就只需要提供一個fire方法就可以了,如果有多個小任務,就寫多個方法,下面發布任務的時候會有區別
每個方法會傳入兩個參數 think\queue\Job $job(當前的任務對象) 和 $data(發布任務時自定義的數據)

還有個可選的任務失敗執行的方法 failed 傳入的參數為$data(發布任務時自定義的數據)

下面寫兩個例子

namespace app\job;

use think\queue\Job;

class Job1{
    
    public function fire(Job $job, $data){
    
            //....這里執行具體的任務 
            
             if ($job->attempts() > 3) {
                  //通過這個方法可以檢查這個任務已經重試了幾次了
             }
            
            
            //如果任務執行成功后 記得刪除任務,不然這個任務會重復執行,直到達到最大重試次數后失敗后,執行failed方法
            $job->delete();
            
            // 也可以重新發布這個任務
            $job->release($delay); //$delay為延遲時間
          
    }
    
    public function failed($data){
    
        // ...任務達到最大重試次數后,失敗了
    }

}


namespace app\lib\job;

use think\queue\Job;

class Job2{
    
    public function task1(Job $job, $data){
    
          
    }
    
    public function task2(Job $job, $data){
    
          
    }
    
    public function failed($data){
    
          
    }

}

發布任務

think\facade\Queue::push($job, $data = '', $queue = null) 和 think\facade\Queue::later($delay, $job, $data = '', $queue = null) 兩個方法,前者是立即執行,后者是在$delay秒后執行

$job 是任務名
單模塊的,且命名空間是app\job的,比如上面的例子一,寫Job1類名即可
多模塊的,且命名空間是app\module\job的,寫model/Job1即可
其他的需要些完整的類名,比如上面的例子二,需要寫完整的類名app\lib\job\Job2
如果一個任務類里有多個小任務的話,如上面的例子二,需要用@+方法名app\lib\job\Job2@task1app\lib\job\Job2@task2

$data 是你要傳到任務里的參數

$queue 隊列名,指定這個任務是在哪個隊列上執行,同下面監控隊列的時候指定的隊列名,可不填

監聽任務並執行

php think queue:listen

php think queue:work

兩種,具體的可選參數可以輸入命令加 --help 查看

可配合supervisor使用,保證進程常駐


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM