Laravel Queue Nedir ?

Laravel Queue, e-posta göndermek vb. gibi zaman alıcı bir görevin işlenmesini daha sonra işlenmek üzere ertelemenizi sağlayan yapıdır. Bu zaman alıcı görevlerin ertelenmesi, uygulamanıza yapılan web isteklerini büyük ölçüde hızlandırır. Laravel Queue (Kuyruklama / Sıralama), Beanstalk, Amazon SQS, Redis ve hatta ilişkisel bir veritabanı gibi çeşitli kuyruk arka uçlarında birleşik bir API sağlar.

Laravel Jobs Nedir ?

Laravel Jobs, uygulamamızın normalden farklı, özel olarak yapmasını istediğimiz işlerin, görevlerin tanımlandığı sınıf (class) yapısıdır. Laravel Jobs ile uygulamamızın yaptığı işleri ayrı ayrı tanımlayıp Laravel Queue ile de sıraya sokarak dilediğimiz bir zamanda yaptırabiliriz.

Sorun Yaratalım / Neden Kullanalım ?

Örnek vermek gerekirse bir sosyal medya uygulamamız var. Bir kullanıcı yeni bir gönderi oluşturduğunda tüm takipçilerine e-posta (e-mail) göndermek istiyorsunuz. Kullanıcının 1000 takipçisi olduğunu farz edersek. Kullanıcı gönderiyi paylaş butonuna bastıktan sonra 1000 adet e-postanın takipçilerine ulaşmasını beklemek zorunda. Zamanın çok önemli olduğu bir çağda kullanıcıyı o kadar süre bekletmek istemezsiniz. Bekletmek isteseniz bile muhtemelen zaman aşımı (timeout) hatası ile karşılaşacaksınız :). İşte tamda burda çözüm olarak devreye Laravel Queue giriyor.

Not: Laravel Jobs ile yapılacak bir iş / görev tanımlayıp daha sonra Laravel Queue ile de bu işleri, bir işlem kuyruğuna ekleyip istediğimiz bir zamanda sırayla yaptırabiliyoruz.

Yarattığımız Sorunu Çözelim

Örneğimiz üzerinden devam edersek, sorunumuz kullanıcı bir gönderi paylaştığında, kullanıcının tüm takipçilerine e-posta gönderirken kullacının takipçilerinin çok olması sebebiyle zaman aşımı (timeout) hatası ile karşılaşmamız. Peki Laravel Jobs ve Laravel Queue bu ile sorunu nasıl çözeriz ?

Kurulumları anlatıp uzun olan bir makaleyi daha da uzatmamak için örneği docker üzerinden vereceğim.

Yeni klasör oluşturup içerisine de Laradock projesini dahil edelim.

mkdir Laravel-Queue
cd Laravel-Queue
git clone https://github.com/Laradock/laradock.git

Laradock hakkında herhangi bir bilginiz yok ise Yeni Nesil Geliştirme Ortamı Docker Serisinin 3. Bölümünde Laradock’ tan bahsettim okuyabilirsiniz.

Laradock klasörüne içerisinde ki env-example dosyasını “.env” olarak kopyalayalım.

cd laradock
cp env-example .env

Gerekli servisleri(konteyner) başlatalım.

docker-compose up -d nginx mysql

Not : Laradock ‘ u ilk defa çalıştırdığınızda bu kısım biraz uzun sürebilir

Workspace servisimizin içerisine “laradock” kullanıcısı ile girelim.

docker-compose exec --user="laradock" workspace bash

Yeni Laravel projesi oluşturalım.

composer create-project --prefer-dist laravel/laravel laravel "5.8"

laravel klasörü içerisindeki dosyaları bir üst dizine taşıyalım.

mv laravel/{.,}* ./

veritabanı ayarlarımızı yapalım.

#.env
...
DB_CONNECTION=mysql
DB_HOST=mysql
DB_PORT=3306
DB_DATABASE=default
DB_USERNAME=root
DB_PASSWORD=root
...

QUEUE_CONNECTION “database” olarak ayarlıyalım.

#.env
...
QUEUE_CONNECTION=database
...

Artisan komutları ile Job (İş / Görev) oluşturalım.

php artisan make:job SendEmail

Yukarıda ki komut ile app\Jobs dizini altında SendEmail ismiyile bir job (iş/görev) oluşmuş oldu. SendEmail.php içerisine de ki handle methodtuna aşağıdaki komutları yerleştirelim.

#app\Jobs\SendEmail.php
...
    public function handle()
    {   
        # e-posta göndermek yerine 1 saniye gecikme ekliyoruz.
        sleep(1);
    }
...

routes\web.php içerisine de aşağıdaki komutları yerleştirelim.

Route::get('share-post', function() {
   /**
    * Post Oluşturma vb. diğer işlemler
    */
    for ($i=0; $i < 10; $i++) {
        # e-posta göndermek yerine 1 saniye gecikme ekliyoruz.
        sleep(1); 
    }

    return 'Gönderiniz yayınlandı';
});

Route::get('share-post-with-queue', function() {
    /**
    * Post Oluşturma vb. diğer işlemler
    */
    for ($i=0; $i < 10; $i++) { 
        App\Jobs\SendMail::dispatch();
    }

    return 'Gönderiniz yayınlandı.';
});

E-posta ayarları ile uğraşmamak için, e-posta göndermek yerine sleep() methodu ile 1 saniye gecikme ekliyoruz. Siz dilerseniz e-posta ayarlarını yapılandırıp e-posta gönderebilirsiniz.

Tarayıcıda 2 sekme veya pencere açarak birinden localhost/share-post adresine, diğerinde de localhost/share-post-with-queue adresine istek atalım.

localhost/share-post adresine attığınız istek ekrana 10 saniye sonra “Gönderiniz yayınlandı” çıktısını verirken, localhost/share-post-with-queue adresine attığınız istek ekrana direk “Gönderiniz yayınlandı” çıktısını verecektir.

Bunun sebebi “share-post” rotası(route) sleep(1) işlemini siz butona basar basmaz gerçekleştirirken, “share-post-with-queue” rotası siz istek yaptıktan sonra veritabanında ki jobs tablosuna daha sonra gerçekleştirilmek üzere 10 adet SendMail görevi ekler ve direk ekrana “Gönderiniz yayınlandı sonucunu basar”.

Veritabanına eklenen görevlerin gerçekleştirilmesi için terminalden php artisan queue:work komutu çalıştırılmalıdır. php artisan queue:work komutu ile birlikte Laravel Queue, jobs tablosundan daha önce eklenmiş ve gerçekleştirme zamanı gelmiş olan görevleri çeker. handle methodu içerisine yazılmış olan işlemleri sırayla gerçekleştirir.

Not: php artisan queue:work komutunu çalıştırmadan önce veritabanında “jobs” tablosuna bakarsanız. 10 adet kayıt göreceksiniz. php artisan queue:work komutu çalıştırdığınızda sırayla işler gerçekleştirilecek ve kayıtlar tablodan silinecektir.

Biraz karmaşık bir konu olduğu için daha rahat anlaşılması için küçük bir video hazırladım.

Video üzerine tıklayarak daha net bir şekilde videoyu görüntüleyebilirsiniz.

Örneği veritabanı üzerinden vermemin sebebi phpmyadmin vb. ile kolayca jobs tablosuna gidip olan biteni izlemeniz içindi. Ama gelin görünki gerçek hayatta bu tarz uygulamalar için ilişkisel veritabanları biraz hantal kalıyor, dolayısı ile redis vb. teknolojilere ihtiyaç duyuyoruz. Laravel, Beanstalk, Amazon SQS, Redis vb. teknolojilere tam destek sağlıyor. Biz genellikle tercih edilen Redis üzerinden devam edelim.

Laravel Queue Redis Entegrasyonu

Laravel ile Redis kullanabilmemiz için “predis” paketini kuralım.

composer require predis/predis

Redis ayarlarını yapınlandıralım.

#.env
...
REDIS_HOST=redis
REDIS_PASSWORD=null
REDIS_PORT=6379
...

QUEUE_CONNECTION “redis” olarak ayarlıyalım.

#.env
...
QUEUE_CONNECTION=redis
...

Redis servisimizi ayağa kaldıralım.

docker-compose up -d redis

Redis yapılandırması ve entegrasyonu Bu kadar basit :)

Laravel Queue Gecikme (Delay)

İşlerimize gecikme eklemek istersek, delay() methodunuz kullanabiliriz.

App\Jobs\SendMail::dispatch()->delay(now()->addMinutes(1));

Eş Zamanlı İşler (Synchronous Dispatching)

Bir işi derhal (eşzamanlı olarak) göndermek istiyorsak, dispatchNow methodunu kullanabilirsiniz. Bu methodu kullanırken, iş kuyruğa alınmayacak ve hemen geçerli işlem içinde çalıştırılacaktır.

App\Jobs\SendMail::dispatchNow()

İş Zincirilemesi (Job Chaining) nedir ?

İş zincirlemesi, sırayla çalıştırılması gereken işlem kuyruğuna alınmış işlerin bir listesini belirlememiz sağlar. Sıradaki bir iş başarısız olursa, işlerin geri kalanı çalışmayacaktır. Kuyruğa alınmış bir iş zincirini yürütmek için, withChain methodunu kullanabiliriz.

App\Jobs\SendMail::withChain([
    new IkinciBirIs,
    new UcuncuBirIs,
])->dispatch()

Job Events (İş Etkinlikleri)

Laravel Queue ile işlem kuyruğuna aldığımız işler/görevler işlenirken. JobProcessing, JobProcessed ve JobFailed olmak üzere 3 adet etkinlik(event) tetikler. Bizde bu etkinlikleri dinleyerek(listening), Bir iş işlenirken, işlendikten sonra veya başarısız olduğunda yapılacak işlemleri tanımlayabiliriz.

#App/Providers/AppServiceProvider.php
...
use Illuminate\Support\Facades\Queue;
use Illuminate\Support\ServiceProvider;
use Illuminate\Queue\Events\JobFailed;
use Illuminate\Queue\Events\JobProcessed;
use Illuminate\Queue\Events\JobProcessing;
...

...
public function boot()
{   
    # İşler işlenirken
    Queue::before(function (JobProcessing $event) {
        // $event->connectionName
        // $event->job
        // $event->job->payload()
    });

    #İşler işlendikten sonra
    Queue::after(function (JobProcessed $event) {
        // $event->connectionName
        // $event->job
        // $event->job->payload()
    });

    #İşler başarısız olduğunda
    Queue::failing(function (JobFailed $event) {
        // $event->connectionName
        // $event->job
        // $event->exception
    });
}
...

Başarısız İşler (Failed Jobs)

Laravel Queue’ da herhangi bir sebepten dolayı iş başarısız olursa, iş sınıfı içerisindeki failed methodu tetiklenir(çağırılır/çalıştırılır). Tanımladığımız iş başarısız olduğunda yapılacak işlemleri failed methodu altında tanımlayabiliriz.

/**
* The job failed to process.
*
* @param  Exception  $exception
* @return void
*/
public function failed(Exception $exception)
{
    // işlem başarısız olunca gerçekleştirilecek işlemler
}

Sonuç

Sonuç olarak, Laravel Queue nedir? ne değildir? Laravel Queue nasıl kullanırız? vb. soruların cevaplarını öğrendik. İyi hoş güzelde gerçek hayatta ne işimize yarayacak dememeniz için, gerçek hayatta karşılaşabileceğimiz örnek bir sorun yaratıp çözdük. Umarım Laravel Queue hakkında kafanızda soru işareti kalmamıştır. Herhangi bir sorunuz var ise yorumlar bölümünden belirtebilirsiniz. Bir sonraki makalede görüşmek üzere.

Kaynak:

• Laravel Queue