BackEnd

Laravelで非同期実行する

投稿日:

はじめに

バックエンドの実装に関して、時間がかかる処理を行う場合、非同期に処理したいケースがあると思います。今回はLaravelで非同期に処理するための手軽な方法を紹介します。

動作環境

本記事ではPHP 7.2、Laravel 5.5の環境を想定しています。

準備

非同期に処理するに当たりジョブのキューを管理する方法としては、データベースを利用する方法やRedisを利用する方法などがあります。Laravelでは標準でデータベース、Redis、Amazon SQS、Beanstalkdを利用することができますが、今回は最も手頃なデータベースを使用する実装を紹介します。

デーブルの作成

以下のコマンドを実行してキューを管理するためのテーブルを作成します。

このコマンドを実行すると、以下ようなテーブルが作成されます。

.envの修正

ドライバはデフォルトでは sync になっていますので、 database に変更します。

ジョブの作成

それでは、非同期で処理するジョブを実装していきます。ユーザー登録時に何らかの処理を行う想定です。なお、ユーザーテーブルは既に定義してあるものとします。

以下のコマンドでジョブクラスを作成します。作成したクラスは app/Jobs ディレクトリに配置されます。

このコマンドで作成されるジョブクラスを見てみましょう。

見て分かる通り、ジョブクラスは実行時に呼び出されるhundleメソッドのみあります。なお、ジョブクラスにはEloquentモデルを渡すことができます。ディスパッチ時に渡される引数は以下のようにコンストラクタで取得できます。

ジョブのディスパッチ

ジョブのディスパッチには実装したジョブクラスの dispatch メソッドで行います。以下はコントローラでディスパッチする例です。

キューワーカーを起動

キューを処理するためにはキューワーカーを起動する必要があります。以下のコマンドでキューワーカーを起動します。

なお、キューワーカーは長時間起動しっぱなしのプロセスなので、コードを変更した場合はリスタートする必要があります。キューワーカーのリスタートは以下のコマンドで行います。

より細かな制御

ここまでで非同期にジョブを処理することができるようになりました。ここからは、より細かな制御について紹介します。

特定のキューにディスパッチする

ディスパッチするキューを指定することで、優先的に処理することがなどが可能です。キューの指定には onQueue メソッドを使います。

最大試行回数の指定

ジョブの最大試行回数は以下のように指定します。

タイムアウトの指定

ジョブの最大実効秒数は以下のように指定します。

ジョブ失敗時の処理

最大試行回数以上ジョブの実行に失敗した場合、そのジョブは failed_jobs テーブルに保存されます。以下のコマンドでテーブルを作成します。

失敗したジョブのクリーンアップ

失敗したジョブのクリーンアップはジョブクラスの failed メソッドで行います。なお、引数として失敗の原因となった Exception が渡されます。

失敗したジョブの再実行

failed_jobs テーブルに保存されたジョブは以下のコマンドで確認できます。

失敗したジョブの再実行は以下のコマンドで行います。

また、失敗したジョブの削除は以下のコマンドで行います。

さいごに

Laravelで非同期に処理を行う方法として、データベースを使う方法を紹介しました。

おすすめ書籍

初めてのPHP  PHPフレームワーク Laravel Webアプリケーション開発 バージョン5.5 LTS対応  スラスラ読める JavaScript ふりがなプログラミング (ふりがなプログラミングシリーズ)  Vue.js入門 基礎から実践アプリケーション開発まで

blog-page_footer_336




blog-page_footer_336




-BackEnd
-,

執筆者:


comment

メールアドレスが公開されることはありません。

CAPTCHA


関連記事

laravel logo

Laravelの基礎知識

1 はじめに2 Laravelの概要2.1 学習コストが低い2.2 Symfonyがベース2.3 DIを積極的に活用している3 ディレクトリ構成3.1 app3.2 bootstrap3.3 conf ...

rails

さらば「rails migrate」、よろしく「ridgepole」

1 はじめに2 Ridgepoleとは3 rails migrateではなく、Ridgepoleを選定した理由4 rails migrateからRidgepoleへの移行手順5 capistrano3 ...

js

GoogleAppsScriptを使ってmBaaSの定期実行処理を実装する

1 はじめに1.1 簡単な状況説明1.2 定期実行を行う方法2 実装2.1 実装の流れ2.2 JavaScriptの実装2.3 スクリプトをアップロードする2.4 Google Apps Script ...

rails

私たちのFactoryGirlとRspecの使用ルール その1

1 はじめに2 そもそもなぜ基本ルールなどを作成しようとしたのか?3 Rspec編3.1 describe、context、itの階層で使用する3.2 10個以上のテストレコードを作成したい場合は、ト ...

laravel logo

[Laravel] ログの扱い方 [5.8]

1 はじめに2 環境3 Monologについて4 コード上で設定する方法5 config/logging.phpで設定する方法6 おまけ:ログレベルについて7 さいごに8 おすすめ書籍 はじめに こん ...

フォロー

follow us in feedly

blog-page_side_responsive

東京改造計画(NewsPicks Book)
2019年5月
 1234
567891011
12131415161718
19202122232425
262728293031 

アプリ情報

私たちは無料アプリもリリースしています、ぜひご覧ください。 下記のアイコンから無料でダウンロードできます。