[Apex] 開発者コンソールのチェックポイントを利用したデバッグ方法 #Salesforce

チェックポイントとは

チェックポイントは開発者コンソールの機能で、Apexクラスおよびトリガのデバッグを行います。Apexコードの特定の行にチェックポイントを設定することで、行に到達した時点でのメモリやデータベースの状態を確認することができます。

一般的なデバッグの手段としては System.debug() メソッドがありますが、チェックポイントを利用したデバッグでは特定のApexコードの記述を必要としません。よって、デバッグのためにわざわざApexコードを変更する必要は無くなります。

本記事ではチェックポイントの基本的な使い方を説明します。

準備

チェックポイントを使用するには、Apexログレベルを [Finer] または [Finest] に設定する必要があります。詳細はログレベルの設定を参照して下さい。
動作確認用のサンプルコードとして、取引先レコード3件を作成するメソッドを用意します。

CheckpointSample.cls

public class CheckpointSample {

    public static List<Account>createAccounts(){
        List<Account>acclist = new List<Account>();

        for(Integer i = 0; i < 3; i++){
            String accNumber = String.valueOf(i + 1);
            Account acc = new Account(
                Name = 'サンプル取引先' + accNumber,
                AccountNumber = accNumber
            );
            acclist.add(acc);
        }

        insert acclist;
        return acclist;
    }

}

チェックポイント実行手順

チェックポイントの登録

サンプルコードのデバッグを行うためのチェックポイントを登録します。

開発者コンソールを開きます。　（参考:開発者コンソールの開き方）
コードエディタでサンプルコードを開きます。メニューから File > Open > Classes > CheckpointSample を選択し、Openボタンをクリックします。
コードの16行目にチェックポイントを登録します。行番号の左側の余白部分をクリックします。
赤いマークが付き、チェックポイントの登録が完了しました。（赤いマークをクリックすると削除されます）

デバッグが行われるタイミングは、厳密にはチェックポイントを登録した行が実行される直前の時点です。今回はinsert実行後の状態を見るため、16行目（insert文の次の行）に登録しています。

後はこのまま開発者コンソールを開いた状態にしておくと、Apexコード実行時にチェックポイントに到達したタイミングで自動的にデバッグが行われ、結果が保存されていきます。
（実行および結果の確認については後で説明します）

登録したチェックポイントの一覧は、[Checkpoints]タブ > [Checkpoint Locations]リストに表示されます。

チェックポイント実行プロパティの確認

登録したチェックポイントにはそれぞれプロパティを設定することができ、設定によってデバッグの内容が変わります。
ここではプロパティの設定画面を確認します。

[Checkpoint Locations]リストでチェックポイントを選択し、 Edit Properties ボタンをクリックします。
プロパティの設定画面が表示されます。デフォルトでは以下のような設定になっています。

チェックポイントの実行

デバッグの内容に応じてプロパティの設定を変更します。

メモリ内のオブジェクト・変数の状態を参照する

チェックポイント到達時点でのオブジェクト・変数の状態を参照します。

チェックポイントのプロパティ設定画面を開き、以下のとおり設定します。
- Dump Heap: チェックする
- Apex Script Type: None を選択
メニューから [Debug] > [Open Execute Anonymous Window] を開き、以下のコードを入力して実行します。
CheckPointSample.createAccounts();
デバッグが行われ、[Checkpoints]タブ > [Checkpoints]リストに結果が表示されます。ダブルクリックすると詳細が表示されます。
[Symbols]タブを開くと、オブジェクトや変数の一覧がツリー構造で表示されます。展開すると詳細が表示されます。　　
[Heap]タブを開くと、メモリ内にあるすべてのオブジェクト情報が表示され、[Types]リストに項目がデータ型別に分類されています。項目をクリックすると、より詳細な情報が表示されます。

データベースの状態を参照する

チェックポイント到達時点でSOQLを実行し、データベースのレコードを参照します。

チェックポイントのプロパティ設定画面を開き、以下のとおり設定します。
- Dump Heap: （ON/OFFどちらでも可）
- Action Script Type: SOQL を選択
- Action Script: 以下のSOQL文を入力
  SELECT Id, Name, AccountNumber, CreatedDate FROM Account ORDER BY CreatedDate
メニューから [Debug] > [Open Execute Anonymous Window] を開き、以下のコードを入力して実行します。 CheckPointSample.createAccounts();
デバッグが行われ、[Checkpoints]タブ > [Checkpoints]リストに結果が表示されます。ダブルクリックすると詳細が表示されます。
[Query Results]タブを開くとSOQLの実行結果が表示されます。 CheckPointSample.createAccounts() で作成した取引先レコードが表示されていることが確認できます。

Apexコードを実行する

チェックポイント到達時点でApexコードを実行し、実行結果を参照します。

チェックポイントのプロパティ設定画面を開き、以下のとおり設定します。
- Dump Heap: （ON/OFFどちらでも可）
- Action Script Type: Apex Code を選択
- Action Script: 以下のApexコードを入力¹ System.assertNotEquals(0, [SELECT COUNT() FROM Account]);
メニューから [Debug] > [Open Execute Anonymous Window] を開き、以下のコードを入力して実行します。
CheckPointSample.createAccounts();
デバッグが行われ、[Checkpoints]タブ > [Checkpoints]リストに結果が表示されます。ダブルクリックすると詳細が表示されます。
[Apex Execution Results]タブが表示され、Apexコードの成否を確認することができます。

Apexコードがエラーになった場合は、結果が以下のように表示されます。

なお、ここで System.debug() を実行しても出力結果を確認することはできませんでした。

チェックポイントの削除

登録したチェックポイントをすべて削除するには、開発者コンソールで以下のメニューを実行します。
[Debug] > [Clear] > [Checkpoint Locations]

注意事項

開発者コンソールを閉じているとチェックポイントは実行されません。Apexコードが実行される前に開発者コンソールを開いたままにしておく必要があります。
チェックポイントは最大5個まで登録可能です。
forループ内の行にチェックポイントを登録した場合は、デバッグは1回だけ実行されます。[Checkpoint Locations]リストで Iteration の値を変更すると、何回目のループ時にチェックポイントを実行するかを設定できます。

参考リンク

Action ScriptからApexクラス内のオブジェクトや変数を参照することはできません。Staticな要素のみ参照可能です。 ↩