Apex トリガー入門

学習の目的

この単元を完了すると、次のことができるようになります。

• Salesforce オブジェクトのトリガーを作成する。
  
• トリガーコンテキスト変数を使用する。
  
• トリガーからクラスメソッドをコールする。
  
• トリガーで sObject addError() メソッドを使用して保存操作を制限する。
  

メモ

日本語で受講されている方へChallenge は日本語の Trailhead Playground で開始し、かっこ内の翻訳を参照しながら進めていってください。Challenge での評価は英語データを対象に行われるため、英語の値のみをコピーして貼り付けるようにしてください。日本語の組織で Challenge が不合格だった場合は、(1) この手順に従って [Locale (地域)] を [United States (米国)] に切り替え、(2) [Language (言語)] を [English (英語)] に切り替えてから、(3) [Check Challenge (Challenge を確認)] ボタンをクリックしてみることをお勧めします。

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

始める前に

Apex トリガーは楽しく便利で機能的です。このモジュールでは、Apex を使い始められるように基本を説明します。また、ほかの Salesforce 機能にも言及しながら Apex トリガーの力を紹介します。このモジュールを最大限に活かすには、次のモジュールを先に完了することをお勧めします。

• クイックスタート: Apex
  
• Apex の基本とデータベース
  
• システム管理者のための SOQL
  
• 開発者コンソールの基礎
  

Apex トリガーの作成

Apex トリガーを使用すると、Salesforce のレコードに対するイベント (挿入、更新、削除) の前または後にカスタムアクションを実行できます。データベースシステムでトリガーがサポートされるのと同様に、Apex においてもレコードを管理する目的でトリガーがサポートされています。

一般に、トリガーを使用するのは、特定の条件に基づいて操作を実行する場合、関連レコードを変更する場合、または特定の操作の実行を制限する場合です。SOQL および DML の実行や、カスタム Apex メソッドのコールなど、Apex で行えることはすべてトリガーを使って実行できます。

トリガーを使用するのは、Salesforce ユーザーインターフェースのポイント & クリックツールでは実行できないようなタスクを実行する場合です。たとえば、レコードの項目値の検証や項目の更新を行う場合、入力規則やフローを使用します。パフォーマンスと拡張性を重視する場合、ポイント & クリックツールのロジックが複雑すぎる場合、または CPU 使用率の高い操作を実行する場合は、Apex トリガーを使用します。

トリガーを定義できるのは、Account、Contact といった最上位の標準オブジェクト、カスタムオブジェクト、一部の子標準オブジェクトです。トリガーは作成時にデフォルトで有効になります。Salesforce では、指定したデータベースイベントが発生したときに有効なトリガーが自動的に実行されます。

トリガー構文

トリガー定義の構文は、クラス定義の構文とは異なります。トリガー定義は、trigger キーワードで開始します。その後に、トリガーの名前、トリガーが関連付けられている Salesforce オブジェクト、トリガーを実行する条件が続きます。トリガーの構文は次のとおりです。

trigger TriggerName on ObjectName (trigger_events) {
   code_block
}

挿入、更新、削除、復元操作の前または後にトリガーを実行する場合、カンマ区切りのリストで複数のトリガーイベントを指定します。指定できるのは次のイベントです。

• before insert
• before update
• before delete
• after insert
• after update
• after delete
• after undelete

トリガーの例

次の簡単なトリガーは、取引先を挿入する前に実行され、デバッグログにメッセージを書き込みます。

1. 開発者コンソールで、[File (ファイル)] | [New (新規)] | [Apex Trigger (Apex トリガー)] をクリックします。
   
2. トリガー名に HelloWorldTrigger と入力して、sObject に [Account (取引先)] を選択します。[Submit (送信)] をクリックします。
   
3. デフォルトのコードを次のコードに置き換えます。
   

trigger HelloWorldTrigger on Account (before insert) {
	System.debug('Hello World!');
}

4. 保存するには、[Ctrl+S] キーを押します。
   
5. トリガーをテストするには、取引先を作成します。
   

• [Debug (デバッグ)] | [Open Execute Anonymous Window (実行匿名ウィンドウを開く)] をクリックします。
  
• 新しいウィンドウで、次のコードを追加してから [Execute (実行)] をクリックします。
  

Account a = new Account(Name='Test Trigger');
insert a;

6. デバッグログで、Hello World! ステートメントを見つけます。ログには、トリガーが実行されたことも示されます。
   

トリガーの種類

トリガーには次の 2 種類があります。

• before トリガーは、レコードがデータベースに保存される前にレコードの値を更新または検証する場合に使用します。
  
• after トリガーは、システムによって設定された項目値 (レコードの Id 項目や LastModifiedDate 項目など) にアクセスする場合や、ほかのレコードの変更に影響を与える場合に使用します。after トリガーを実行するレコードは参照のみです。
  

コンテキスト変数の使用

トリガーを実行するレコードにアクセスするには、コンテキスト変数を使用します。たとえば、Trigger.new には、挿入または更新トリガーで挿入されたすべてのレコードが含まれます。Trigger.old には、更新トリガーで更新される前の sObject の旧バージョン、または削除トリガーで削除された sObject のリストがあります。1 つのレコードが挿入された場合や、API または Apex を使用して多数のレコードが一括して挿入され場合にトリガーが実行されます。したがって、Trigger.new などのコンテキスト変数には、1 つのレコードが含まれることもあれば、複数のレコードが含まれることもあります。Trigger.new に反復処理を行うと、個々の sObject を取得できます。

次の例は、HelloWorldTrigger のサンプルトリガーを変更したものです。for ループの各取引先に反復処理が行われ、それぞれの Description ([説明]) 項目が更新されます。

trigger HelloWorldTrigger on Account (before insert) {
    for(Account a : Trigger.new) {
        a.Description = 'New description';
    }
}

before トリガーを実行したレコードは、トリガーの実行が終了した後にシステムによって保存されます。DML の挿入または更新操作を明示的にコールせずに、トリガーのレコードを変更できます。これらのレコードに DML ステートメントを実行すると、エラーが表示されます。

ほかの一定のコンテキスト変数は、更新イベントや別の何らかのイベントによってトリガーが実行されたかどうかを示す Boolean 値を返します。これらの変数は、トリガーで複数のイベントを組み合わせるときに役立ちます。次に例を示します。

trigger ContextExampleTrigger on Account (before insert, after insert, after delete) {
    if (Trigger.isInsert) {
        if (Trigger.isBefore) {
            // Process before insert
        } else if (Trigger.isAfter) {
            // Process after insert
        }
    }
    else if (Trigger.isDelete) {
        // Process after delete
    }
}

次の表は、トリガーに使用可能なすべてのコンテキスト変数の包括的なリストです。

トリガーからのクラスメソッドのコール

トリガーから公開ユーティリティメソッドをコールできます。ほかのクラスのメソッドをコールすることで、コードを再利用でき、トリガーのサイズが縮小し、Apex コードのメンテナンスが向上します。また、オブジェクト指向プログラミングを利用できるようになります。

次のトリガー例は、トリガーから静的メソッドをコールする方法を示します。挿入イベントによってトリガーが実行された場合、この例では CustomContactNotification クラスで静的な notifyUsers() メソッドをコールします。このユーティリティメソッドは、トリガーで定義された Salesforce ユーザーにカスタム通知を送信します。通知には、挿入された取引先責任者レコードの件数が含まれます。

この例では、カスタム通知を作成します。カスタム通知は Lightning Experience でのみ利用可能です。通知の作成と編集には、「アプリケーションのカスタマイズ」ユーザー権限が必要です。詳細は「デスクトップまたはモバイル通知の作成」を参照してください。

1. デスクトップのカスタム通知を作成します。
   
   • [Setup (設定)] の [Quick Find (クイック検索)] ボックスに Notification Builder (通知ビルダー) と入力して、[Custom Notifications (カスタム通知)] を選択します。
     
   • [New (新規)] をクリックします。
     
   • Custom Notification Name (カスタム通知名) に New Contact Notification (新規取引先責任者の通知) と入力します。
     
   • API Name (API 参照名) に New_Contact_Notification と入力します。
     
   • Supported Channels (サポートされるチャネル) で [Desktop (デスクトップ)] を選択します。
     
   • [Save (保存)] をクリックします。
     
2. 開発者コンソールで、[File (ファイル)] | [New (新規)] | [Apex Class (Apex クラス)] をクリックします。
   
3. CustomContactNotification と入力して、[OK] をクリックします。
   
4. デフォルトのクラス本文を、以下の CustomContactNotification クラスの例で置き換えます。
   

public with sharing class CustomContactNotification {
    // Public method
    public static void notifyUsers(Set<String> recipientsIds, Integer recordCount) {
        

        // Get the ID for the custom notification type created in Setup
 		CustomNotificationType notificationType =
            [SELECT Id, DeveloperName
             FROM CustomNotificationType
             WHERE DeveloperName='New_Contact_Notification'];
        

        // Create a new custom notification
        Messaging.CustomNotification notification = new Messaging.CustomNotification();
        

        // Set the contents for the notification
        notification.setTitle('Trailhead Trigger Tutorial');
        notification.setBody(recordCount + ' contact(s) were inserted.');


        // Set the notification type and target
        notification.setNotificationTypeId(notificationType.Id);
        // '000000000000000AAA' is a dummy targetId value
        notification.setTargetId('000000000000000AAA');
        

       // Send the notification
       try {
           notification.send(recipientsIds);
           System.debug('Custom notification sent successfully.');
       }
       catch (Exception e) {
           System.debug('Problem sending notification: ' + e.getMessage());
        }
    }
}

5. 開発者コンソールで、[File (ファイル)] | [New (新規)] | [Apex Trigger (Apex トリガー)] をクリックします。
   
6. トリガー名に ContactNotificationTrigger と入力して、sObject に [Contact (取引先責任者)] を選択します。[Submit (送信)] をクリックします。
   
7. デフォルトのコードを次のコードに置き換えます。
   

trigger ContactNotificationTrigger on Contact (after insert, after delete) {
    if (Trigger.isInsert) {
        Integer recordCount = Trigger.new.size();
        

        // Set the recipientIDs to the current user
        Set<String> recipientIDs = new Set<String>{UserInfo.getUserId()};
      

        // Call a utility method from another class
        CustomContactNotification.notifyUsers(recipientIDs, recordCount);
    }
    else if (Trigger.isDelete) {
        // Process after delete
    }
}

8. 保存するには、[Ctrl+S] キーを押します。
   
9. トリガーをテストするには、取引先責任者を作成します。
   

• [Debug (デバッグ)] | [Open Execute Anonymous Window (実行匿名ウィンドウを開く)] をクリックします。
  
• 新しいウィンドウで、次のコードを追加してから [Execute (実行)] をクリックします。
  

Contact c = new Contact(LastName='Test Contact');
insert c;

10. デバッグログで、トリガーが実行されたことを確認します。ログの最後のほうにある、ユーティリティメソッドによって書き込まれたデバッグメッセージ (DEBUG|Custom notification sent successfully) を見つけます。
11. 通知を受信したことを確認します。通知パネルを開くには、 をクリックします。「Trailhead Trigger Tutorial (Trailhead トリガーチュートリアル)」というタイトルと、「1 contact(s) were inserted. (1 件の取引先責任者が挿入されました。)」という本文の通知が表示されることを確認します。
    

新しいトリガーが有効になっているため、1 件以上の取引先責任者を追加するたびに、カスタムデスクトップ通知が届くようになります。

関連レコードの追加

トリガーは多くの場合、トリガーコンテキストのレコード (トリガー起動の原因となったレコード) に関連するレコードのアクセスまたは管理に使用します。

このトリガーは、新しい取引先や更新された取引先にまだ商談が関連付けられていない場合に、各取引先に関連する商談を追加します。トリガーは最初に SOQL クエリを実行して、トリガーが実行された取引先のすべての子商談を取得します。次に、トリガーは Trigger.new で sObject のリストを反復処理して各取引先の sObject を取得します。取引先に関連する商談 sObject がない場合は、for ループによって 1 件が作成されます。トリガーで新しい商談が作成された場合、最後のステートメントでその商談が挿入されます。

1. 開発者コンソールを使用して次のトリガーを追加します (HelloWorldTrigger の例の手順に従いますが、トリガー名には AddRelatedRecord を使用します)。
   

trigger AddRelatedRecord on Account(after insert, after update) {
    List<Opportunity> oppList = new List<Opportunity>();
    // Get the related opportunities for the accounts in this trigger
    Map<Id,Account> acctsWithOpps = new Map<Id,Account>(
        [SELECT Id,(SELECT Id FROM Opportunities) FROM Account WHERE Id IN :Trigger.new]);
    // Add an opportunity for each account if it doesn't already have one.
    // Iterate through each account.
    for(Account a : Trigger.new) {
        System.debug('acctsWithOpps.get(a.Id).Opportunities.size()=' + acctsWithOpps.get(a.Id).Opportunities.size());
        // Check if the account already has a related opportunity.
        if (acctsWithOpps.get(a.Id).Opportunities.size() == 0) {
            // If it doesn't, add a default opportunity
            oppList.add(new Opportunity(Name=a.Name + ' Opportunity',
                                       StageName='Prospecting',
                                       CloseDate=System.today().addMonths(1),
                                       AccountId=a.Id));
        }
    }
    if (oppList.size() > 0) {
        insert oppList;
    }
}

2. トリガーをテストするには、Salesforce ユーザーインターフェースで取引先を作成して、Apples & Oranges という名前を付けます。
   
3. 取引先のページの [商談] 関連リストで、新しい商談を見つけます。トリガーによってこの商談が自動的に追加されています。
   

追加したトリガーが、トリガーコンテキストに属するすべてのレコードに反復処理を行います。つまり、for ループが Trigger.new を反復処理します。ただし、このトリガーのループはもっと効率化できます。実際にアクセスする必要があるのは、このトリガーコンテキストの全取引先ではなく、そのサブセット (商談のない取引先) のみです。次の単元では、このトリガーをさらに効率化する方法を説明します。「一括トリガーの設計パターン」単元では、SOQL クエリを変更して商談のない取引先のみを取得する方法を学習します。その後で、それらのレコードのみを反復処理する方法を学習します。

トリガーの例外の使用

特定の条件を満たしたときはレコードが保存されないようにするなど、場合によっては特定のデータベース操作に制限を加える必要があることがあります。トリガーにレコードが保存されないようにするには、問題の sObject で addError() メソッドをコールします。addError() メソッドは、トリガー内で致命的なエラーを生成します。このエラーメッセージがユーザーインターフェースに表示され、ログに記録されます。

次のトリガーは、取引先に関連する商談がある場合にはその取引先が削除されないようにします。デフォルトでは、取引先が削除されると、その関連するレコードがすべてカスケード削除されます。このトリガーは、商談がカスケード削除されないようにします。このトリガーを試してみましょう。前の例を実行した場合は、組織に Apples & Oranges という取引先と、関連する商談が存在します。この例ではそのサンプル取引先を使用します。

1. 開発者コンソールを使用して、次のトリガーを追加します。
   

trigger AccountDeletion on Account (before delete) {
    // Prevent the deletion of accounts if they have related opportunities.
    for (Account a : [SELECT Id FROM Account
                     WHERE Id IN (SELECT AccountId FROM Opportunity) AND
                     Id IN :Trigger.old]) {
        Trigger.oldMap.get(a.Id).addError(
            'Cannot delete account with related opportunities.');
    }
}

2. Salesforce ユーザーインターフェースで、Apples & Oranges 取引先のページに移動して、[Delete (削除)] をクリックします。
   
3. 確認ポップアップで [OK] をクリックします。
   

「Cannot delete account with related opportunities (関連する商談がある取引先は削除できません)」というカスタムエラーメッセージの検証エラーが表示されることを確認します。

4. AccountDeletion トリガーを無効にします。このトリガーを有効のままにすると、問題をチェックできません。
   

• [Setup (設定)] から Apex Triggers (Apex トリガー) を検索します。
  
• [Apex Triggers (Apex トリガー)] ページで、AccountDeletion トリガーの横にある [Edit (編集)] をクリックします。
  
• [Is Active (有効)] をオフにします。
  
• [Save (保存)] をクリックします。
  

トリガーで addError() をコールすると、一括 DML のコールが部分的に完了している場合を除いて、一連の操作全体がロールバックされます。

• Lightning Platform API の一括 DML コールがトリガーを実行すると、ランタイムエンジンは不正なレコードを除外します。次に、ランタイムエンジンは、エラーが発生しなかったレコードのみを保存しようとします。
  
• Apex の DML ステートメントがトリガーを実行する場合、エラーが発生すると操作全体がロールバックされます。ただし、ランタイムエンジンはすべてのレコードを処理して、完全なエラーリストをコンパイルします。
  

トリガーとコールアウト

Apex を使用すると、外部 Web サービスへのコールが可能になり、Apex コードを外部 Web サービスと統合できるようになります。外部 Web サービスへの Apex コールをコールアウトといいます。たとえば、株価情報サービスへのコールアウトを実行して、最新の株価情報を取得できます。トリガーからコールアウトを実行するときは、外部サービスからの応答を待機中に、トリガープロセスによって操作がブロックされないように、コールアウトを非同期に行う必要があります。非同期コールアウトをバックグラウンドプロセスで実行して、外部サービスから応答が返されたら受信します。

トリガーからコールアウトを実行するには、非同期に実行するクラスメソッドをコールします。このようなメソッドは future メソッドと呼ばれ、@future(callout=true) アノテーションが付加されます。次のクラスの例には、コールアウトを実行する future メソッドが含まれます。

この例では、説明目的で架空のエンドポイント URL を使用しています。したがって、エンドポイントを有効な URL に変更して、Salesforce にエンドポイントのリモートサイトを追加しない限り、この例を実行することはできません。

public class CalloutClass {
    @future(callout=true)
    public static void makeCallout() {
        HttpRequest request = new HttpRequest();
        // Set the endpoint URL.
        String endpoint = 'http://yourHost/yourService';
        request.setEndPoint(endpoint);
        // Set the HTTP verb to GET.
        request.setMethod('GET');
        // Send the HTTP request and get the response.
        HttpResponse response = new HTTP().send(request);
    }
}

次の例は、クラスでメソッドをコールして、コールアウトを非同期で実行するトリガーを示しています。

trigger CalloutTrigger on Account (before insert, before update) {
    CalloutClass.makeCallout();
}

このセクションは、コールアウトの概要のみを示し、詳述はいたしません。詳細は、『Apex 開発者ガイド』の「Apex を使用したコールアウトの呼び出し」を参照してください。

リソース

• Apex 開発者ガイド: トリガー
• Apex 開発者ガイド: Apex を使用したコールアウトの呼び出し
• Apex リファレンスガイド: CustomNotification クラス
• Trailhead: Apex インテグレーションサービス