Apex 一括処理の使用

• Apex 一括処理を使用する場合。
• 一括処理使用時の Apex 制限の引き上げ。
• Apex 一括処理構文。
• Apex 一括処理のベストプラクティス。

メモ

このバッジのハンズオン Challenge は日本語、スペイン語 (LATAM)、ポルトガル語 (ブラジル) に対応しています。Playground の言語を変更するには、こちらの指示に従ってください。日本語等、翻訳された言語と英語に差異がある可能性があります。英語以外の言語での指示に従って Challenge に合格できなかった場合は、[言語] と [地域] をそれぞれ [English]、[アメリカ合衆国] に切り替えてからもう一度お試しください。

翻訳版 Trailhead を活用する方法の詳細は、自分の言語の Trailhead バッジを参照してください。

• 各トランザクションは新しいガバナ制限のセットで開始されるため、コードをガバナ実行制限内に抑えやすくなります。
• いずれかのバッチが処理に失敗しても、他のすべての正常に処理された一括処理トランザクションはロールバックされません。

• Database.BatchableContext オブジェクトへの参照。
• List<sObject> などの sObject のリストまたはパラメーター化された型のリスト。Database.QueryLocator を使用している場合は、返されたリストを使用します。

public class MyBatchClass implements Database.Batchable<sObject> {
    public (Database.QueryLocator | Iterable<sObject>) start(Database.BatchableContext bc) {
        // collect the batches of records or objects to be passed to execute
    }
    public void execute(Database.BatchableContext bc, List<P> records){
        // process each batch of records
    }
    public void finish(Database.BatchableContext bc){
        // execute any post-processing operations
    }
}

MyBatchClass myBatchObject = new MyBatchClass();
Id batchId = Database.executeBatch(myBatchObject);

Id batchId = Database.executeBatch(myBatchObject, 100);

AsyncApexJob job = [SELECT Id, Status, JobItemsProcessed, TotalJobItems, NumberOfErrors FROM AsyncApexJob WHERE ID = :batchId ];

Apex 一括処理のサンプルコード

Apex 一括処理クラスの記述方法がわかったので、実用的な例を見てみましょう。米国内の企業のすべての取引先責任者は、郵送先住所として親会社の請求先住所が設定されていなければならないと定めるビジネス要件があるとします。ところが、ユーザーは正しい住所なしで新規取引先責任者を入力しています。要件はわかっているはずです。そこで、この要件が必ず適用されるようにする Apex 一括処理クラスを記述します。

次のサンプルクラスでは、QueryLocator を使用する start() メソッドによって渡されたすべての取引先レコードを検出し、関連付けられた取引先責任者を取引先の郵送先住所で更新します。最後に、一括ジョブの結果と、Database.Stateful を使用して追跡した状態に基づく更新済みレコード数を含むメールを送信します。

public class UpdateContactAddresses implements
    Database.Batchable<sObject>, Database.Stateful {
    // instance member to retain state across transactions
    public Integer recordsProcessed = 0;
    public Database.QueryLocator start(Database.BatchableContext bc) {
        return Database.getQueryLocator(
            'SELECT ID, BillingStreet, BillingCity, BillingState, ' +
            'BillingPostalCode, (SELECT ID, MailingStreet, MailingCity, ' +
            'MailingState, MailingPostalCode FROM Contacts) FROM Account ' +
            'Where BillingCountry = \'USA\''
        );
    }
    public void execute(Database.BatchableContext bc, List<Account> scope){
        // process each batch of records
        List<Contact> contacts = new List<Contact>();
        for (Account account : scope) {
            for (Contact contact : account.contacts) {
                contact.MailingStreet = account.BillingStreet;
                contact.MailingCity = account.BillingCity;
                contact.MailingState = account.BillingState;
                contact.MailingPostalCode = account.BillingPostalCode;
                // add contact to list to be updated
                contacts.add(contact);
                // increment the instance member counter
                recordsProcessed = recordsProcessed + 1;
            }
        }
        update contacts;
    }
    public void finish(Database.BatchableContext bc){
        System.debug(recordsProcessed + ' records processed. Shazam!');
        AsyncApexJob job = [SELECT Id, Status, NumberOfErrors,
            JobItemsProcessed,
            TotalJobItems, CreatedBy.Email
            FROM AsyncApexJob
            WHERE Id = :bc.getJobId()];
        // call some utility to send email
        EmailUtils.sendMessage(job, recordsProcessed);
    }
}

@isTest
private class UpdateContactAddressesTest {
    @testSetup
    static void setup() {
        List<Account> accounts = new List<Account>();
        List<Contact> contacts = new List<Contact>();
        // insert 10 accounts
        for (Integer i=0;i<10;i++) {
            accounts.add(new Account(name='Account '+i,
                billingcity='New York', billingcountry='USA'));
        }
        insert accounts;
        // find the account just inserted. add contact for each
        for (Account account : [select id from account]) {
            contacts.add(new Contact(firstname='first',
                lastname='last', accountId=account.id));
        }
        insert contacts;
    }
    @isTest static void test() {
        Test.startTest();
        UpdateContactAddresses uca = new UpdateContactAddresses();
        Id batchId = Database.executeBatch(uca);
        Test.stopTest();
        // after the testing stops, assert records were updated properly
        System.assertEquals(10, [select count() from contact where MailingCity = 'New York']);
    }
}

• レコードのバッチが複数ある場合は、必ず Apex 一括処理を使用します。複数のバッチを実行するにはレコード数が足りない場合は、Queueable Apex を使用することをお勧めします。
• できるだけ迅速にレコードを収集して実行できるようにすべての SOQL クエリを調整します。
• 遅延する可能性を最小限に抑えるには、作成する非同期要求の数を最小限に抑えます。
• 一括処理ジョブをトリガーから開始する場合は、細心の注意を払ってください。制限を超える数の一括処理ジョブをトリガーで追加しないようにする必要があります。

• Apex 開発者ガイド: Apex の一括処理
• Apex 開発者ガイド: Apex 一括処理の使用
• Apex 開発者ガイド: カスタムイテレーター