SQSのキュー登録とworkコマンドに関して

投稿日：2019年7月14日更新日：2020年5月9日

SQSでのキューの登録に関して以前やりましたが、再度扱うことがあったので、調査を。

リンク

SQSについて

Queueの登録と実際の処理に関して

Contents

1 キューの登録
2 キューの監視

キューの登録

実際の登録で以前はテストと言うこともあり、route.phpで下記の用に書きましたが、実際にこんな書き方をすることはあまりありませんね。

Route::get('/queue', function () {
    Queue::push(new \App\Jobs\SampleJob());
    return 'At ' . date('Y-m-d H:i:s') . ' - queue pushed.';
});

Route::get('/queue', function () {

Queue::push(new \App\Jobs\SampleJob());

return 'At ' . date('Y-m-d H:i:s') . ' - queue pushed.';

});

Controlleに下記の用に書いてJobを呼び出すことが一般的かと思われます。

app\Http\Controller\TestController.php

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Jobs\DispatchJobs;

class TestController extends Controller
{
    public function dispatch_queue()
    {
        DispatchJob::dispatch();
    }
}

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;

use App\Jobs\DispatchJobs;

class TestController extends Controller

{

public function dispatch_queue()

{

DispatchJob::dispatch();

}

おそらくdispatchの内部でQueueへの登録が起こっているのだと思われます。

app/Jobs/DispatchJobs.php

<?php
namespace App\Jobs;
 
use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Log;

 class DispatchJobs implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
     protected $params;
     /**
     * Create a new job instance.
     *
     * @return void
     */
    public function __construct($values = null)
    {
        $this->params = $values;
    }
     /**
     * Execute the job.
     *
     * @return void
     */
    public function handle()
    {
        $queued_at = date('Y-m-d H:i:s');
        sleep(5);
        $dispatched_at = date('Y-m-d H:i:s');
        \Log::info("処理開始 - {$queued_at} ... 処理終了 - {$dispatched_at}");
    }
}

<?php

namespace App\Jobs;

use Illuminate\Bus\Queueable;

use Illuminate\Queue\SerializesModels;

use Illuminate\Queue\InteractsWithQueue;

use Illuminate\Contracts\Queue\ShouldQueue;

use Illuminate\Foundation\Bus\Dispatchable;

use Log;

class DispatchJobs implements ShouldQueue

{

use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

protected $params;

/**

* Create a new job instance.

* @return void

public function __construct($values = null)

{

$this->params = $values;

}

/**

* Execute the job.

* @return void

public function handle()

{

$queued_at = date('Y-m-d H:i:s');

sleep(5);

$dispatched_at = date('Y-m-d H:i:s');

\Log::info("処理開始 - {$queued_at} ... 処理終了 - {$dispatched_at}");

}

あとはControllerのメソッドに直接アクセスすればOKです。

一度Job自体をUnitテストで呼び出そうとしたのですが、

Target [Illuminate\Contracts\Bus\Dispatcher] is not instantiable.

1	Target [Illuminate\Contracts\Bus\Dispatcher] is not instantiable.

なるエラーが出てしまいました。

ライブラリの依存関係か？とも思いましたが、上記の用にControllerから動かすと大丈夫だったため、何らかの引数がControllerに入っていたり、Requestに依存しているのかもしれません。

キュー登録だけではなく、一般に非同期でのタスク登録などをすることをdispatch(ディスパッチ)などと言うようです。一般的には時間差をつけて登録することも一般的なようです。

キューの監視

登録されたキューの監視です。

php artisan queue:work

1	php artisan queue:work

以前はこれだけで覚えていましたが、

リトライ数や常駐化、スリープ時間など様々な指定をしたいときには下記の用に指定することができます。

php artisan queue:work connection --daemon --sleep=3 --tries=3

1	php artisan queue:work connection --daemon --sleep=3 --tries=3

実際にはこのコマンド自体をsupervisordなのでデーモン化させる必要があるようです。

supervisorによるデーモン化