Queueable インターフェース

監視可能な Apex ジョブの非同期実行を有効にします。

名前空間

System

使用方法

Apex を非同期ジョブとして実行するには、Queueable インターフェースを実装し、execute メソッドの実装に処理ロジックを追加します。

Queueable インターフェースを実装するには、最初に implements キーワードでクラスを次のように宣言する必要があります。

次に、クラスで次のメソッドの実装を提供する必要があります。

クラスとメソッドの実装は、public または global として宣言する必要があります。

クラスを非同期実行するために送信するには、Queueable インターフェースのクラス実装のインスタンスを次のように渡して System.enqueueJob をコールします。

Queueable のメソッド

Queueable のメソッドは次のとおりです。

execute(context)

キュー可能ジョブを実行します。

署名

public void execute(QueueableContext context)

パラメータ

context: 型: QueueableContext; ジョブ ID が含まれます。

戻り値

型: Void

Queueable の実装例

これは、Queueable インターフェースの実装例です。この例の execute メソッドは、新規取引先を挿入します。

このクラスをジョブとしてキューに追加するには、次のメソッドをコールします。

キュー可能クラスを実行のために送信すると、ジョブはキューに追加され、システムリソースが使用可能になると処理されます。ジョブの状況を監視するには、プログラムで AsyncApexJob をクエリするか、ユーザインターフェースの [設定] から、[クイック検索] ボックスに「Apex ジョブ」と入力して [Apex ジョブ] を選択します。

送信したジョブに関する情報をクエリするには、System.enqueueJob メソッドが返したジョブ ID で絞り込んで AsyncApexJob に対する SOQL クエリを実行します。次の例では、前の例で取得された jobID 変数を使用します。

future ジョブと同様、キュー可能ジョブはバッチを処理しません。そのため、処理されたバッチ数と合計バッチ数は常に 0 です。

キュー可能ジョブのテスト

次の例では、テストメソッドでキュー可能ジョブの実行する方法を示します。キュー可能ジョブは、非同期プロセスです。このプロセスがテストメソッド内で実行されるようにするには、ジョブを Test.startTest と Test.stopTest 間のブロック内でキューに送信する必要があります。システムは、テストメソッドで開始されたすべての非同期プロセスを、Test.stopTest ステートメントの後に同期して実行します。次に、テストメソッドは、ジョブで作成された取引先をクエリして、キュー可能ジョブの結果を検証します。

キュー可能 Apex ジョブの ID はテストコンテキスト内では返されません。実行テストで System.enqueueJob は null を返します。

メモ

Apex 開発者ガイド