Laravel隊列服務為各種不同的後台隊列提供統一的API,以下這篇文章主要給大家介紹了關於Laravel中使用Queue的最基本操作教程,文中透過範例程式碼介紹的非常詳細,需要的朋友可以參考借鑒,下面來一起看看吧。
前言
laravel中的隊列服務跟其他隊列服務也沒有什麼不同,都是最符合人類思維的最簡單、最普遍的流程:有一個地方存放隊列信息,一個PHP進程在運行時將任務寫入,另外一個PHP守護程序輪詢隊列信息,將達到執行要求的任務執行並刪除。由於PHP是url驅動的同步語言,本身是阻塞的,所以laravel提供一個守護程序工具來查詢並執行佇列資訊也就不足為奇了。
這兩天初次接觸 Laravel 的隊列,也是搞了好一會。 。 。一番折騰下來還是感慨對 Laravel 不得其門,文檔寫的相對簡單和概括,看源碼又有些力不從心(不過看源碼慢慢調試驗證還是最可靠的)。
下面是我的一個簡單Demo,僅僅使用了隊列的最基本操作,偏高級的操作需要再去好好時間一番:)
和我一樣入門Laravel 的隊列有些困難的同學可以交流一下。
配置
#新增Redis 套件
在composer.json中require 部分加入"predis/predis": "~1.0",,然後composer up 更新一下即可。
database.php
在database.php 設定檔中對redis 資料庫部分進行配置,預設有一個default 連接,就用這個好了: )
根據這個預設連線中所需的設定項,編輯.env 設定文件,將其中的REDIS_HOST、REDIS_PASSWORD、REDIS_PORT 填入自己伺服器中Redis 的對應值。
queue.php
首先需要去 .env 設定 QUEUE_DRIVER,因為現在打算用 Redis,所以要設定成 redis。
接著配置 queue.php 裡 connections 部分的 redis 連接,其中 connection 對應的值就是 database.php 中 redis 的那個 default 連接。
任務類別
接下來就是寫實際的操作類別了,Laravel 提供了artisan 指令簡化建立任務類別:
php artisan make:job Demo
在app 目錄下會產生Jobs 目錄,裡面已經有Demo.php 任務類別了。
Lumen 可沒有這個 artisan 指令,不過也很方便,預設會有一個 ExampleJob.php 已經寫好了,拷貝一份改個名字即可。
先寫個簡單的日誌輸出測試一下好了,在handle 方法中:
Log::info('Hello, queue');
發放任務
現在寫個入口函數,推送任務到佇列。使用輔助函數dispatch():
Laravel 中使用以下方式:
Demo::dispatch();
Lumen 中使用以下方式:
#dispatch(new Demo);
開啟佇列
#順利的話,這是最後一步了。在命令列中執行:
php artisan queue:listen --queue=default
它會監聽佇列,並輸出簡單的執行情況,例如:
[2017-11-07 02:12:47] Processing: App\Jobs\Demo [2017-11-07 02:12:47] Processed: App\Jobs\Demo
沒啥問題後就可以讓這個佇列腳本執行在背景:
#php artisan queue:work --daemon --quiet --queue=default 1>> /dev/null 2>&1
進階一下:)
推送到佇列時,一般會有傳參的需求,那這裡怎麼傳呢?
參數傳遞
傳入
在入口函數中傳入參數方式如下:
Laravel 中使用以下方式:
$param = 'Stephen'; Demo::dispatch($param);
#Lumen 中使用以下方式:
$param = 'Stephen'; dispatch(new Demo($param));
接收
在任務類別中接收參數方式如下:
protected $param; /** * Create a new job instance. * * @return void */ public function __construct($param) { $this->param = $param; } /** * Execute the job. * * @return void */ public function handle() { Log::info('Hello, ' . $this->param); }
初次嘗試到此為止,還有許多高階用法,例如延遲分發、錯誤處理、優先權、失敗處理等,後續會繼續寫:)
多隊列
這是一個必然需要考慮到的問題,我不可能將所有任務都放在一個叫default 的佇列中,這樣不容易對佇列進行管理。
要指定不同的佇列,非常簡單,在dispatch() 後緊接著跟上onQueue() 方法即可:
Demo::dispatch()->onQueue('emails');
不對啊,我好像沒有定義過這個叫emails 的queue。嗯,自然需要做一點改動,在queue.php 設定檔中的redis 設定queue 從default 改為{default},而這樣做的效果就是佇列的名稱可以從執行的時候動態拿到,而不是寫死的。
如果使用 Lumen 框架,那麼直接這麼寫會報錯:Call to a member function onQueue() on string。
原因在于 Lumen 的 Job 基类中并没有使用 Illuminate\Foundation\Bus\Dispatchable 这个 trait,而是直接使用 Illuminate\Bus\Queueable 中的 onQueue() 方法。
那么现在就很清楚了,我们的 Job 类使用了 Illuminate\Bus\Queueable 这个 trait,所以需要在 Job 类上调用这个 onQueue() 方法。
$job = new XXXJob(); dispatch($job->onQueue('queue-name'));
当我们在开启队列的时候:
php artisan queue:work --queue=emails
这里指定的队列名 emails 和 dispatch 时指定的队列名保持一致即可。
总结
以上是Laravel中使用Queue的最基本操作教學來講解的詳細內容。更多資訊請關注PHP中文網其他相關文章!