【Apex】カスタム例外クラスの作成と使用

この記事では Apex のカスタム例外クラスについて記述しています。

以下のような内容が理解できます。

• カスタム例外クラス作成時の注意点
• カスタム例外の４つの発生方法

カスタム例外を用いる目的

まずカスタム例外を作成する主な目的は以下の２つです。

• 任意のタイミングで例外を発生させたい
• 例外に詳細なエラーメッセージを指定したい

Apex には insert 失敗時の DmlException や、null 変数参照時の NullPointerException などの組み込み例外があります。

これ以外に任意のタイミングで例外を発生させたい場合や、より詳細な情報を付加することで原因特定等をしやすくする目的でカスタム例外を使用します。

カスタム例外クラスの作成

以下にカスタム例外クラスの例を示します。

public class SampleException extends Exception {}

ポイントとなるのは以下の２つです。

• Exception クラスを継承する
• クラス名が「Exception」で終わる必要がある

カスタム例外クラス作成時はこれらのルールを守る必要があります。

カスタム例外の発生方法

カスタム例外クラスは Exception クラスから４つのコンストラクタを継承しており、この４つのパターンで例外を発生させることができます。
例外を投げるときは throw を使います。

1. 引数なし
2. エラーメッセージ（string）を指定
3. Exception 型の引数を指定
4. エラーメッセージ（string）と、Exception 型の引数を指定

throw new SampleException();

throw new SampleException('Error Message');

throw new SampleException(e);

throw new SampleException('Error Message', e);