Laravel 使用 Queue

QUEUE_CONNECTION=sync

QUEUE_CONNECTION=database

• sync是local queue，指當job被push到queue後(程式中執行dispatch())，會馬上執行job，而且是用main thread執行job，因此在開發階段才有用。

$ php artisan queue:table

$ php artisan migrate

$ php artisan make:job ${name}

$ php artisan make:job SendEmail

• Queue Jobs在這個路徑: app/Jobs。
• handle()就是執行這個job的進入點。
• 當在執行job過程中有exception發生時，這個job會被釋放出來，再重新丟回Queue中retry，直到設定的最大重試次數為止，指定最大重試次數--tries後面會再提到。
• 如果想手動釋放job，可以使用InteractsWithQueue這個 trait提供的release method:

public function handle()
{
　　if (condition) {
　　　　$this->release(10);
　　}
}

• 檢查重試次數: 可以用attempts method:

public function handle()
{
　　if ($this->attempts() > 3) {
　　　　//
　　}
}

use App\Jobs\SendEmail;
$job = (new SendEmail())->onQueue('email');
$this->dispatch($job);

• 由於我們.env中的QUEUE_CONNECTION設定為database，所以執行dispatch後，job會被push到database driver中。
• BTW，如果.env中QUEUE_CONNECTION設定為sync，則會馬上執行SendEmail這個job，並不會塞資料進jobs這張表。

• ->onQueue('email') 這邊其實是對應到jobs這張表的queue欄位，也就是把job push到email這個queue中。
• 注意，如果沒有->onQueue('email')這行，預設塞進去的queue name會是default，如下圖。

$job = (new SendEmail())->onQueue('email');
dispatch($job);

• 事實上，dispatch是一個全域的method，所以可以直接這樣用。
• 甚至是在Route中，也可以使用dispatch:

Route::get('/user', function () {
　　dispatch(new App\Jobs\SendEmail);
　　return 'Done!';
});

$ php artisan queue:listen

• 這邊預設會優先執行default queue的jobs。
• Queue是先進先出的概念，先塞進來的job優先處理。

• attempts是指執行次數。
• created_at是指job被建立的時間。
• available_at是指job預計執行的時間。
• reserved_at是指job開始執行的時間。

$ php artisan queue:listen --queue=email,default

php artisan queue:listen --queue=email,default --tries=3

• 當job發生exception時，這個job會從queue中被釋放(這個job的row會從jobs table中被刪除)然後重新塞一個new job到queue中retry(重新塞一個job row 到jobs table中)。
• 這個範例表示job執行3次如果還是failed，就不會再重試了。

$ php artisan queue:listen --queue=email

• 從console可以發現這三個job被依序處理了。
• 由於已經啟動queue listener，這時候如果又有job被塞進email queue，若舊的job都被執行完畢了，就會馬上執行這個job。
• 經過實測，如果沒有加上 --queue=email，會發現都沒反應，應該是因為只會處理default queue jobs，這邊需特別注意。
• 需特別注意，執行完成的job，該row data會從jobs table中被移除。

$job = (new SendEmail())->onQueue('email')->delay(60 * 5);
$this->dispatch($job);

• 這時候塞進去jobs table中的available_at欄位時間就會晚五分鐘。

處理失敗的job

• failed job相關設定在這:

• 建立fail job migrations & table:

$ php artisan queue:failed-table
$ php artisan migrate

• trigger這段程式，將job塞入queue中:

use App\Jobs\SendEmail;
$job = (new SendEmail())->onQueue('email');
$this->dispatch($job);

• 啟動queue listener，用--tries 來指定job的最大重試次數:

$ php artisan queue:listen --queue=email --tries=3

• 可以看到，SendEmail job執行了三次都failed，所以最終會把fail job紀錄在failed_jobs表，會記錄失敗時間及exception，方便查問題。

• 查看所有失敗jobs:

$ php artisan queue:failed

• ID就是table中紀錄的uuid，可以用來重試job:

$ php artisan queue:retry ${ID}

• 重試所有failed job:

$ php artisan queue:retry all

• 刪除某個失敗的job: 這筆job會從failed_jobs表中刪除。

$ php artisan queue:forget ${ID}

• 刪除所有失敗的job: 所有job會從failed_jobs表中刪除。

$ php artisan queue:flush

• 如同上面的例子，--tries=3 表示若job fail會retry3次，如果第3次還是失敗，就視為真正失敗，會trigger這個failed() method。
• 如果沒有加--tries參數，則執行一次失敗就會trigger failed() method了。

在生產環境啟動Queue Listener

• 在production環境不要用queue:listen來啟動，queue:listen適合在local開發時候用，更動程式碼會馬上生效，不須重新啟動。
• 相反的，在production環境應該要用queue:work，queue:work有daemon選項可以在背景啟動，CPU用量也比較低。

$ php artisan queue:work --daemon --queue=email --tries=3

• queue:work指令用法跟listen幾乎是一樣的，可以用這個指令查看用法:

$ php artisan help queue:work

• 由於在背景執行的queue listener是一個長時間的process，啟動的應用程式狀態會被儲存在memory中，所以只要程式有更改，就必須重新啟動:

$ php artisan queue:restart

監控Queue Listener