カスタムエラー、拡張エラー

著者：Eve Cole 更新時間：2024-12-16 10:32:10

何かを開発するとき、タスク内で問題が発生する可能性のある特定の事柄を反映するために、独自のエラークラスが必要になることがよくあります。ネットワーク操作のエラーの場合はHttpError 、データベース操作の場合はDbError 、検索操作の場合はNotFoundErrorなどが必要になる場合があります。

私たちのエラーは、 message 、 name 、そしてできればstackなどの基本的なエラープロパティをサポートする必要があります。ただし、それらは独自の他のプロパティを持つこともあります。たとえば、 HttpErrorオブジェクトは、 404 、 403 、または500のような値を持つstatusCodeプロパティを持つことがあります。

JavaScript では任意の引数とともにthrowを使用できるため、技術的にはカスタムエラークラスはErrorから継承する必要はありません。しかし、継承すると、 obj instanceof Error使用してエラーオブジェクトを識別することが可能になります。したがって、それを継承する方が良いでしょう。

アプリケーションが成長するにつれて、私たち自身のエラーは自然に階層を形成します。たとえば、 HttpTimeoutError HttpErrorなどから継承する場合があります。

拡張エラー

例として、ユーザーデータを含む JSON を読み取る関数readUser(json)を考えてみましょう。

有効なjsonどのように見えるかの例を次に示します。

 let json = `{ "名前": "ジョン", "年齢": 30 }`;

内部的にはJSON.parseを使用します。不正な形式のjson受信すると、 SyntaxErrorがスローされます。しかし、たとえjson構文的に正しいとしても、それが有効なユーザーであることを意味するわけではありません。必要なデータが欠落している可能性があります。たとえば、ユーザーにとって不可欠なnameとageプロパティが含まれていない可能性があります。

関数readUser(json) JSON を読み取るだけでなく、データをチェック (「検証」) します。必須フィールドがない場合、または形式が間違っている場合は、エラーになります。データは構文的に正しいため、これはSyntaxErrorではなく、別の種類のエラーです。これをValidationErrorと呼び、そのクラスを作成します。この種のエラーには、問題のあるフィールドに関する情報も含まれている必要があります。

ValidationErrorクラスはErrorクラスを継承する必要があります。

Errorクラスは組み込みですが、何を拡張しているのかを理解できるように、おおよそのコードを次に示します。

 // JavaScript 自体によって定義される組み込み Error クラスの「疑似コード」
クラスエラー{
  コンストラクター(メッセージ) {
    this.message = メッセージ;
    this.name = "エラー"; // (組み込みエラー クラスごとに異なる名前)
    this.stack = <呼び出しスタック>; // 標準ではありませんが、ほとんどの環境でサポートされています
  }
}

次に、 ValidationError継承して実際に動作させてみましょう。

 class ValidationError extends Error {
  コンストラクター(メッセージ) {
    スーパー(メッセージ); // (1)
    this.name = "検証エラー"; // (2)
  }
}

関数テスト() {
  throw new ValidationError("おっと!");
}

試す {
  テスト（）;
キャッチ(エラー) {
  アラート(err.メッセージ); // おっと！
  アラート(err.name); // 検証エラー
  アラート(err.スタック); // ネストされた呼び出しのリストとそれぞれの行番号
}

注意してください: 行(1)では、親コンストラクターを呼び出します。 JavaScript では子コンストラクターでsuper呼び出す必要があるため、これは必須です。親コンストラクターはmessageプロパティを設定します。

親コンストラクターはnameプロパティも"Error"に設定するため、行(2)で正しい値にリセットします。

これをreadUser(json)で使用してみましょう。

 class ValidationError extends Error {
  コンストラクター(メッセージ) {
    スーパー(メッセージ);
    this.name = "検証エラー";
  }
}

// 使用法
関数 readUser(json) {
  let user = JSON.parse(json);

  if (!user.age) {
    throw new ValidationError("フィールドなし: 年齢");
  }
  if (!user.name) {
    throw new ValidationError("フィールドがありません: 名前");
  }

  リターンユーザー。
}

// try..catch を使用した実際の例

試す {
  let user = readUser('{ "年齢": 25 }');
} キャッチ (エラー) {
  if (err 検証エラーのインスタンス) {
    alert("無効なデータ: " + err.message); // 無効なデータ: フィールドがありません: 名前
  } else if (err instanceof SyntaxError) { // (*)
    alert("JSON 構文エラー: " + err.message);
  } それ以外 {
    エラーをスローします。 // 不明なエラー。再スローします (**)
  }
}

上記のコードのtry..catchブロックは、 ValidationErrorとJSON.parseからの組み込みSyntaxErrorの両方を処理します。

(*)行で、 instanceof使用して特定のエラータイプをチェックする方法を見てください。

次のようにerr.nameを調べることもできます。

 // ...
// (errinstanceofSyntaxError) の代わりに
} else if (err.name == "SyntaxError") { // (*)
// ...

将来的にはValidationError拡張し、 PropertyRequiredErrorのようなそのサブタイプを作成する予定であるため、 instanceofバージョンの方がはるかに優れています。また、 instanceofチェックは、新しい継承クラスに対しても引き続き機能します。つまり、それは将来性があります。

また、 catch不明なエラーに遭遇した場合、それを行(**)に再スローすることも重要です。 catchブロックは検証エラーと構文エラーの処理方法のみを知っており、他の種類のエラー (コード内のタイプミスやその他の不明な理由が原因) は失敗するはずです。

さらなる継承

ValidationErrorクラスは非常に汎用的です。多くのことがうまくいかない可能性があります。プロパティが存在しないか、間違った形式 ( ageの数値ではなく文字列値など) である可能性があります。存在しないプロパティに対して正確に、より具体的なクラスPropertyRequiredErrorを作成しましょう。不足しているプロパティに関する追加情報が含まれます。

 class ValidationError extends Error {
  コンストラクター(メッセージ) {
    スーパー(メッセージ);
    this.name = "検証エラー";
  }
}

class PropertyRequiredError extends ValidationError {
  コンストラクター(プロパティ) {
    super("プロパティがありません: " + プロパティ);
    this.name = "プロパティ必須エラー";
    this.property = プロパティ;
  }
}

// 使用法
関数 readUser(json) {
  let user = JSON.parse(json);

  if (!user.age) {
    throw new PropertyRequiredError("age");
  }
  if (!user.name) {
    throw new PropertyRequiredError("name");
  }

  リターンユーザー。
}

// try..catch を使用した実際の例

試す {
  let user = readUser('{ "年齢": 25 }');
} キャッチ (エラー) {
  if (err 検証エラーのインスタンス) {
    alert("無効なデータ: " + err.message); // 無効なデータ: プロパティ: 名前がありません
    アラート(err.name); // プロパティ必須エラー
    アラート(err.property); // 名前
  else if (err 構文エラーのインスタンス) {
    alert("JSON 構文エラー: " + err.message);
  } それ以外 {
    エラーをスローします。 // 不明なエラーなので再スローしてください
  }
}

新しいクラスPropertyRequiredErrorは使いやすいです。プロパティ名new PropertyRequiredError(property)を渡すだけです。人間が判読できるmessageはコンストラクターによって生成されます。

PropertyRequiredErrorコンストラクターのthis.nameが再び手動で割り当てられることに注意してください。すべてのカスタムエラークラスにthis.name = <class name>を割り当てるのは、少し面倒になるかもしれません。 this.name = this.constructor.nameを割り当てる独自の「基本エラー」クラスを作成することで、これを回避できます。そして、そこからすべてのカスタムエラーを継承します。

これをMyErrorと呼びましょう。

MyErrorとその他のカスタムエラークラスを簡略化したコードを次に示します。

 class MyError extends Error {
  コンストラクター(メッセージ) {
    スーパー(メッセージ);
    this.name = this.constructor.name;
  }
}

class ValidationError extends MyError { }

class PropertyRequiredError extends ValidationError {
  コンストラクター(プロパティ) {
    super("プロパティがありません: " + プロパティ);
    this.property = プロパティ;
  }
}

// 名前は正しいです
alert( new PropertyRequiredError("field").name ); // プロパティ必須エラー

コンストラクター内の"this.name = ..."行が削除されたため、カスタムエラー、特にValidationErrorが大幅に短くなりました。

ラッピング例外

上記のコード内の関数readUserの目的は、「ユーザーデータを読み取る」ことです。プロセス中にさまざまな種類のエラーが発生する可能性があります。現時点ではSyntaxErrorとValidationErrorがありますが、将来的にreadUser関数が拡張され、おそらく他の種類のエラーが生成される可能性があります。

readUser呼び出すコードは、これらのエラーを処理する必要があります。現時点では、 catchブロック内で複数のifを使用しており、クラスをチェックして既知のエラーを処理し、未知のエラーを再スローします。

スキームは次のとおりです。

試す {
  ...
  readUser() // 潜在的なエラーの原因
  ...
} キャッチ (エラー) {
  if (err 検証エラーのインスタンス) {
    // 検証エラーを処理します
  else if (err 構文エラーのインスタンス) {
    // 構文エラーを処理します
  } それ以外 {
    エラーをスローします。 // 不明なエラーなので再スローしてください
  }
}

上記のコードでは 2 種類のエラーが確認できますが、さらに多くのエラーが存在する可能性があります。

readUser関数が複数の種類のエラーを生成する場合は、自問する必要があります。本当にすべての種類のエラーを毎回 1 つずつチェックする必要があるのでしょうか。

多くの場合、答えは「ノー」です。私たちは「それよりも 1 つ上のレベル」になりたいと考えています。私たちが知りたいのは「データ読み取りエラー」があったかどうかだけです。正確な理由は多くの場合無関係です (エラーメッセージで説明されています)。あるいは、必要な場合に限り、エラーの詳細を取得する方法があればさらに良いのですが。

ここで説明する手法は「例外のラッピング」と呼ばれます。

一般的な「データ読み取り」エラーを表す新しいクラスReadErrorを作成します。
関数readUserその内部で発生するデータ読み取りエラーValidationErrorやSyntaxErrorなど) を捕捉し、代わりにReadError生成します。
ReadErrorオブジェクトは、そのcauseプロパティに元のエラーへの参照を保持します。

そうすれば、 readUser呼び出すコードは、あらゆる種類のデータ読み取りエラーではなく、 ReadErrorをチェックするだけで済みます。エラーの詳細が必要な場合は、そのcauseプロパティを確認できます。

ReadErrorを定義し、 readUserとtry..catchでの使用法を示すコードは次のとおりです。

 class ReadError extends Error {
  コンストラクター(メッセージ、原因) {
    スーパー(メッセージ);
    this.cause = 原因;
    this.name = '読み取りエラー';
  }
}

class ValidationError extends Error { /*...*/ }
class PropertyRequiredError extends ValidationError { /* ... */ }

関数 validateUser(user) {
  if (!user.age) {
    throw new PropertyRequiredError("age");
  }

  if (!user.name) {
    throw new PropertyRequiredError("name");
  }
}

関数 readUser(json) {
  ユーザーに許可します。

  試す {
    ユーザー = JSON.parse(json);
  } キャッチ (エラー) {
    if (err 構文エラーのインスタンス) {
      throw new ReadError("構文エラー", err);
    } それ以外 {
      エラーをスローします。
    }
  }

  試す {
    validateUser(ユーザー);
  } キャッチ (エラー) {
    if (err 検証エラーのインスタンス) {
      throw new ReadError("検証エラー", err);
    } それ以外 {
      エラーをスローします。
    }
  }

}

試す {
  readUser('{悪い json}');
} キャッチ (e) {
  if (e インスタンス of ReadError) {
    アラート(e);
    // 元のエラー: SyntaxError: JSON の位置 1 に予期しないトークン b があります
    alert("元のエラー: " + e.cause);
  } それ以外 {
    eを投げます。
  }
}

上記のコードでは、 readUser説明どおりに動作します。構文エラーと検証エラーをキャッチし、代わりにReadErrorエラーをスローします (不明なエラーは通常どおり再スローされます)。

したがって、外側のコードは、 instanceof ReadErrorをチェックするだけです。考えられるすべてのエラーの種類をリストする必要はありません。

このアプローチは、「低レベル」例外を取得し、より抽象的なReadErrorに「ラップ」するため、「例外のラッピング」と呼ばれます。オブジェクト指向プログラミングで広く使用されています。

まとめ

通常は、 Errorおよび他の組み込みエラークラスを継承できます。 nameプロパティを処理する必要があるだけで、 super呼び出すことを忘れないでください。
特定のエラーをチェックするには、 instanceof使用します。継承でも機能します。しかし、サードパーティのライブラリからエラーオブジェクトが発生し、そのクラスを取得する簡単な方法がない場合があります。その後、 nameプロパティをそのようなチェックに使用できます。
例外のラッピングは広く普及している手法です。つまり、関数が低レベルの例外を処理し、さまざまな低レベルのエラーの代わりに高レベルのエラーを作成します。低レベルの例外は、上記の例のerr.causeのように、そのオブジェクトのプロパティになることがありますが、これは厳密には必須ではありません。

タスク

SyntaxError から継承

重要度: 5

組み込みのSyntaxErrorクラスを継承するクラスFormatErrorを作成します。

message 、 name 、およびstackプロパティをサポートする必要があります。

使用例：

 let err = new FormatError("フォーマットエラー");

アラート( err.メッセージ ); // フォーマットエラー
アラート( err.name ); // フォーマットエラー
アラート( err.stack ); // スタック

alert( err インスタンスの FormatError ); // 真実
アラート( err インスタンスオブ構文エラー ); // true (SyntaxError から継承されるため)

class FormatError extends SyntaxError {
  コンストラクター(メッセージ) {
    スーパー(メッセージ);
    this.name = this.constructor.name;
  }
}

let err = new FormatError("フォーマットエラー");

アラート( err.メッセージ ); // フォーマットエラー
アラート( err.name ); // フォーマットエラー
アラート( err.stack ); // スタック

アラート( err 構文エラーのインスタンス ); // 真実

カスタム エラー、拡張エラー

拡張エラー

さらなる継承

ラッピング例外

まとめ

タスク

SyntaxError から継承

カスタムエラー、拡張エラー