背景と応用シナリオ
Salesforceプラットフォームでアプリケーションを開発する私たちSalesforce開発者にとって、Governor Limits (ガバナ制限)は常に意識しなければならない重要な制約です。1つのトランザクション内で実行できるSOQLクエリの数、DMLステートメントの数、CPU時間などには厳しい制限が設けられています。これらの制限は、マルチテナント環境であるSalesforce全体のパフォーマンスと安定性を維持するために不可欠です。
しかし、複雑なビジネスロジックを実装しようとすると、この同期処理の壁に突き当たることがあります。例えば、トリガー内から外部システムのAPIを呼び出したり、大量の関連レコードに対して複雑な計算処理を行ったりする場合、同期実行ではすぐに制限を超えてしまいます。
このような課題を解決するためにSalesforceが提供しているのが、Asynchronous Apex (非同期Apex) です。非同期Apexを利用することで、時間のかかる処理やリソースを大量に消費する処理をバックグラウンドで実行させ、現在のトランザクションとは切り離すことができます。これにより、ユーザーは処理の完了を待つことなく次の操作に進むことができ、アプリケーションの応答性が向上します。
今回解説する Future Method (フューチャーメソッド) は、この非同期Apexの最も基本的で広く利用されている手法の一つです。Future Methodは、特定のアノテーションを付与するだけで簡単に非同期処理を実装できるため、多くの開発者にとって最初の選択肢となります。
主な応用シナリオ
- トリガーからのWebサービスコールアウト: Salesforceのトリガーコンテキスト内では、同期的なWebサービスコールアウトは許可されていません。これは、外部システムの応答遅延がデータベースのトランザクションを長時間ロックし、パフォーマンスに深刻な影響を与える可能性があるためです。Future Methodを使えば、コールアウト処理を非同期化し、この制限を安全に回避できます。
- リソースを大量に消費する処理の分離: 複雑な計算、多数のレコードに対するDML操作、高負荷なCPU処理などを同期トランザクションから切り離し、バックグラウンドで実行させることができます。これにより、ユーザーがレコードを保存する際の待ち時間を短縮し、ユーザーエクスペリエンスを大幅に向上させることが可能です。
- 混合DMLエラーの回避: 同じトランザクション内で、Userオブジェクトのような設定オブジェクト(Setup Object)と、AccountやContactのような非設定オブジェクト(Non-Setup Object)の両方を更新しようとすると、「mixed DML operation」エラーが発生します。Future Methodを使って一方のDML操作を別のトランザクションに分離することで、このエラーを回避できます。
原理説明
Future Methodの仕組みは非常にシンプルです。Apexクラスのメソッドに @future
アノテーションを付与するだけで、そのメソッドは非同期実行の対象となります。
同期的なコード(例えばトリガーやVisualforceコントローラー)から @future
アノテーションが付いたメソッドを呼び出すと、Salesforceプラットフォームはそのメソッドの実行リクエストを非同期処理キューに追加します。そして、呼び出し元の同期トランザクションは、非同期処理の完了を待たずに即座に終了します。
キューに追加されたFuture Methodは、プラットフォームのリソースが利用可能になった時点で、システムによって自動的に実行されます。これは、独自の独立したトランザクションとして処理されるため、独自のガバナ制限セットが適用されます。一般的に、非同期トランザクションのガバナ制限は、同期トランザクションよりも緩和されています(例:CPU時間の上限が60,000ミリ秒、ヒープサイズの上限が12MBなど)。
メソッドのシグネチャに関する制約
Future Methodとして定義するメソッドには、以下の厳格なルールがあります。
- メソッドは必ず
static
でなければなりません。 - 戻り値の型は必ず
void
でなければなりません。 - 引数として受け取れるのは、プリミティブデータ型(Integer, String, Booleanなど)、プリミティブデータ型の配列、またはプリミティブデータ型のコレクション(
List<String>
など)のみです。
特に重要なのは、引数にsObject(Account, Contactなど)を直接渡すことができない点です。これは、メソッドが呼び出されてから実際に実行されるまでの間に、元のsObjectレコードがデータベース上で変更されたり削除されたりする可能性があるためです。もしsObjectを渡せてしまうと、メソッド実行時にはデータが古くなっているかもしれず、データの不整合を引き起こす原因となります。
この制約を回避するためのベストプラクティスは、sObjectのIDを引数として渡し、Future Methodの内部でそのIDを使って改めてSOQLクエリを発行し、最新のレコードデータを取得することです。このアプローチにより、常に最新の状態で処理を開始できます。
サンプルコード
ここでは、最も一般的なユースケースである「複数の取引先レコードIDを受け取り、外部サービスに情報を送信する」というシナリオを想定した公式ドキュメントのサンプルコードを見ていきましょう。
このコードは、取引先(Account)のIDリストを引数として受け取り、それらの取引先に関する情報を外部のWebサービスに送信する非同期処理を実装しています。
AccountProcessor.cls
public class AccountProcessor { // @future アノテーションを付与し、このメソッドが非同期で実行されることを示す // (callout=true) パラメータは、このメソッドが外部Webサービスへのコールアウトを行うことを許可するために必須 @future(callout=true) public static void processAccounts(List<Id> accountIds) { // 引数として受け取った取引先IDのリストを使用して、 // データベースから最新の取引先情報を取得する // フューチャーメソッドではsObjectを直接引数に取れないため、 // このようにIDを元に再クエリするのがベストプラクティス List<Account> accounts = [SELECT Id, Name, AccountNumber FROM Account WHERE Id IN :accountIds]; // 取得した取引先リストをループ処理 for(Account acc : accounts) { // ここで外部サービスへのコールアウト処理を実装する // 例: REST APIを呼び出し、取引先情報をJSON形式で送信する // String requestBody = '{"name": "' + acc.Name + '", "accountNumber": "' + acc.AccountNumber + '"}'; // Http http = new Http(); // HttpRequest request = new HttpRequest(); // request.setEndpoint('https://api.example.com/accounts'); // request.setMethod('POST'); // request.setHeader('Content-Type', 'application/json;charset=UTF-8'); // request.setBody(requestBody); // HttpResponse response = http.send(request); // このサンプルでは、実際のコールアウトの代わりにデバッグログを出力 System.debug('Processing Account: ' + acc.Name); } } }
呼び出し側のコード例 (例: トリガーから呼び出す場合)
trigger AccountTrigger on Account (after insert) { List<Id> newAccountIds = new List<Id>(); for (Account a : Trigger.new) { newAccountIds.add(a.Id); } // トリガーのコンテキストから直接コールアウトはできないが、 // 以下のようにFuture Methodを呼び出すことで非同期にコールアウトを実行できる if (!newAccountIds.isEmpty()) { AccountProcessor.processAccounts(newAccountIds); } }
注意事項
Future Methodは非常に便利ですが、その特性を理解せずに使用すると予期せぬ問題を引き起こす可能性があります。開発者として以下の点に注意する必要があります。
ガバナ制限
Future Methodは独自のガバナ制限を持ちますが、無制限ではありません。
- 呼び出し回数の制限: 1つのApexトランザクションから呼び出せるFuture Methodは最大50回までです。
- 24時間あたりの実行数制限: 24時間以内にキューに追加できる非同期Apexジョブ(Future, Queueable, Batch Apexの合計)の数には上限があります。上限は、Salesforceの組織エディションやライセンスによって異なり、通常は250,000件またはユーザーライセンス数 × 200のいずれか大きい方です。
実行順序の非保証
Future Methodは、呼び出された順序で実行されるとは限りません。 Salesforceはリソースの可用性に基づいてキューからジョブを取り出して実行するため、複数のFuture Methodを連続して呼び出した場合、その実行順序は保証されません。処理の順序性が重要なシナリオでは、Future Methodではなく、ジョブのチェイニングが可能な Queueable Apex (キュー可能Apex) を検討すべきです。
テストに関する考慮事項
Future Methodを含むコードをテストするには、特別な考慮が必要です。非同期処理はテストメソッドの実行とは別のスレッドで行われるため、そのままではテストコードが非同期処理の完了を待たずに終了してしまいます。
これを解決するには、テストメソッド内で非同期処理の呼び出しを Test.startTest()
と Test.stopTest()
のブロックで囲みます。Test.stopTest()
が実行されると、Salesforceはそれまでにキューに追加されたすべての非同期ジョブを同期的に実行し、完了させます。これにより、Future Methodの実行結果(DML操作の結果など)をテストメソッド内で検証できるようになります。
@isTest private class AccountProcessorTest { @isTest static void testProcessAccounts() { // 1. テストデータの準備 List<Account> testAccounts = new List<Account>(); for(Integer i=0; i<10; i++) { testAccounts.add(new Account(Name = 'Test Account ' + i)); } insert testAccounts; List<Id> accountIds = new List<Id>(); for(Account acc : testAccounts) { accountIds.add(acc.Id); } // 2. テストの開始 Test.startTest(); // 3. Future Methodの呼び出し AccountProcessor.processAccounts(accountIds); // 4. テストの停止(ここでFuture Methodが同期的に実行される) Test.stopTest(); // 5. 結果の検証 // この例では具体的な検証はありませんが、もしFuture Methodが // レコードの項目を更新するなどの処理を行っていれば、 // ここでSOQLを発行して結果が正しいことをAssertで検証します。 System.assertEquals(10, [SELECT count() FROM Account WHERE Name LIKE 'Test Account %']); } }
監視とデバッグ
実行されたFutureジョブの状態は、[設定] > [環境] > [ジョブ] > [Apexジョブ] ページで確認できます。「処理中」「完了」「失敗」などのステータスや、エラーが発生した場合はその詳細を追跡できます。デバッグログも、呼び出し元のトランザクションとは別に生成されるため、監視の際は注意が必要です。
まとめとベストプラクティス
Future Methodは、Salesforceプラットフォームにおける非同期処理の基本であり、多くの一般的な問題を解決するための強力なツールです。そのシンプルさから、特にトリガーからのコールアウトといった特定のシナリオで非常に有効です。
Future Methodの使いどころ
- ✅ トリガーや一括処理から外部APIを呼び出したい場合。
- ✅ 同期トランザクションのガバナ制限に抵触する可能性がある、比較的単純な処理を分離したい場合。
- ✅ 処理の実行順序が重要ではない場合。
Future Methodを避けるべきケース
- ❌ 大量のレコード(数千、数万件以上)を処理する必要がある場合。この場合は、専用に設計された Batch Apex (バッチApex) を使用すべきです。
- ❌ 複数の非同期ジョブを連続して実行するなど、複雑な処理フローが必要な場合。この場合は、ジョブのチェイニングや状態の保持が可能な Queueable Apex がより適しています。
- ❌ 処理の実行状況を追跡するためのジョブIDが必要な場合。Future MethodはジョブIDを返さないため、Queueable Apexの方が優れています。
結論として、私たち開発者は、利用可能な非同期処理の選択肢(Future, Batch, Queueable, Schedulable)それぞれの特性を深く理解し、解決しようとしている課題に最も適したツールを選択することが求められます。Future Methodは、その手軽さから今でも多くの場面で活躍しますが、より柔軟性や制御性が求められる現代の複雑な要件に対しては、Queueable Apexがより優れた選択肢となることが多いでしょう。
Future Methodを非同期Apexへの入門としてしっかりとマスターし、その限界を理解した上で、他の非同期パターンへとスキルを広げていくことが、スケーラブルで堅牢なSalesforceアプリケーションを構築するための鍵となります。
コメント
コメントを投稿