カスタムエラー, Error の拡張

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

エラーは message, name 、望ましくは stack のような基本のエラープロパティをサポートすべきです。ですが、他にも独自のプロパティを持つかもしれません。例えば HttpError オブジェクトであれば、 404, 403 もしくは 500 といった値をとる statusCode プロパティです。

JavaScript は任意の引数で throw できるので、技術的にはカスタムのエラークラスは Error から継承する必要はありません。しかし、継承しているとエラーオブジェクトを識別する obj instanceof Error を使えるようになります。そのため、継承しておくほうのがベターです。

アプリケーションを開発するにつれ、独自のエラーが自然に階層を形成します。たとえば、 HttpTimeoutError は HttpError を継承する、といったように。

Error を拡張する

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

ここでは、有効な json がどのように見えるかの例を示します。:

let json = `{ "name": "John", "age": 30 }`;

内部的には、JSON.parse を使います。不正な json を受け取った場合は SyntaxError をスローします。しかし、たとえ json が構文的に正しくても、それが正しいユーザとは限りません。その json には必要なデータが不足しているかもしれません。例えば、上のケースだと、ユーザに必要不可欠な name ã‚„ age プロパティを持っていない場合です。

私たちの関数 readUser(json) はJSONを読むだけでなく、データのチェック(バリデート)をします。必須のフィールドがなかったり、フォーマットが誤っている場合はエラーになります。そしてそれは SyntaxError ではありません。なぜならデータは構文的には正しく、別の種類のエラーだからです。したがって、このエラーは ValidationError と呼び、そのためのクラスを作りましょう。このようなエラーは、問題のあるフィールドに関する情報も保持する必要があります。

ValidationError クラスは Error クラスから継承します。

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

// JavaScript自体で定義された組み込みのErrorクラスの「擬似コード」
class Error {
  constructor(message) {
    this.message = message;
    this.name = "Error"; // (組み込みのエラークラスごとに異なる名前)
    this.stack = <nested calls>; // 非標準ですが、ほとんどの環境はサポートしています
  }
}

では、ValidationError をそれから継承させ、動かしましょう:

class ValidationError extends Error {
  constructor(message) {
    super(message); // (1)
    this.name = "ValidationError"; // (2)
  }
}

function test() {
  throw new ValidationError("Whoops!");
}

try {
  test();
} catch(err) {
  alert(err.message); // Whoops!
  alert(err.name); // ValidationError
  alert(err.stack); // それぞれの行番号を持つネストされたコールのリスト
}

補足: (1) で親のコンストラクタを呼び出しています。JavaScriptは子のコンストラクタ内で super 呼び出しが必要で、これは義務です。親のコンストラクタは message プロパティをセットします。

親のコンストラクタは name プロパティも　"Error" へセットしますので、行 (2) で正しい値にリセットしています。

readUser(json) で使ってみましょう:

class ValidationError extends Error {
  constructor(message) {
    super(message);
    this.name = "ValidationError";
  }
}

// Usage
function readUser(json) {
  let user = JSON.parse(json);

  if (!user.age) {
    throw new ValidationError("No field: age");
  }
  if (!user.name) {
    throw new ValidationError("No field: name");
  }

  return user;
}

// try..catch での動作例

try {
  let user = readUser('{ "age": 25 }');
} catch (err) {
  if (err instanceof ValidationError) {
    alert("Invalid data: " + err.message); // Invalid data: No field: name
  } else if (err instanceof SyntaxError) { // (*)
    alert("JSON Syntax Error: " + err.message);
  } else {
    throw err; // 知らないエラーなので、再スロー (**)
  }
}

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

è¡Œ (*) で特定のエラーの種類をチェックするために、どのように instanceof を使っているか見てください。

このようにして err.name を見ることもできます。:

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

instanceof の方がよりベターです。なぜなら、将来 ValidationError を拡張し、PropertyRequiredError のようなサブタイプを作るからです。そして instanceof チェックは新しい継承したクラスでもうまく機能し続けます。それは将来を保証します。

また、catch が未知のエラーに遭遇したとき、行 (**) でそれを再度スローすることも重要です。 catch はバリデーションと構文エラーの処理の仕方だけを知っています。他の種類(コード中のタイポやその他)の場合は失敗します。

さらなる継承

ValidationError クラスはとても汎用的です。色んな種類の誤りがあります。例えば、プロパティが存在しなかったり、誤ったフォーマット(age が文字列値のような)など。ここで、存在しないプロパティに対するより具体的なクラス PropertyRequiredError を作りましょう。欠落しているプロパティについての追加の情報を保持します。

class ValidationError extends Error {
  constructor(message) {
    super(message);
    this.name = "ValidationError";
  }
}

class PropertyRequiredError extends ValidationError {
  constructor(property) {
    super("No property: " + property);
    this.name = "PropertyRequiredError";
    this.property = property;
  }
}

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

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

  return user;
}

// try..catch での動作例

try {
  let user = readUser('{ "age": 25 }');
} catch (err) {
  if (err instanceof ValidationError) {
    alert("Invalid data: " + err.message); // Invalid data: No property: name
    alert(err.name); // PropertyRequiredError
    alert(err.property); // name
  } else if (err instanceof SyntaxError) {
    alert("JSON Syntax Error: " + err.message);
  } else {
    throw err; // 知らないエラーなので、それを再スロー
  }
}

新しいクラス PropertyRequiredError は簡単に使えます。プロパティ名を渡すだけです。: new PropertyRequiredError(property)。人が読める message はコンストラクタで作られます。

PropertyRequiredError コンストラクタでの this.name は再度手動で割り当てられることに注目してください。カスタムのエラーを作る度に this.name = <class name> と代入することには、少しうんざりするかもしれません。が、this.name = this.constructor.name を行う “基本エラー” クラスを作り、カスタムエラーはそれを継承することで避けることができます。

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

ここでは、単純化した MyError のコードと他のカスタムエラークラスを示します。:

class MyError extends Error {
  constructor(message) {
    super(message);
    this.name = this.constructor.name;
  }
}

class ValidationError extends MyError { }

class PropertyRequiredError extends ValidationError {
  constructor(property) {
    super("No property: " + property);
    this.property = property;
  }
}

// name is correct
alert( new PropertyRequiredError("field").name ); // PropertyRequiredError

これで、カスタムエラーははるかに短くなりました。特に ValidationError はコンストラクタの "this.name = ..." の行を除いたので。

例外のラッピング

上のコードの関数 readUser の目的は “ユーザデータを読むこと” ですよね？この処理では異なる種類のエラーが起こる可能性があります。今は SyntaxError と ValidationError を持っていますが、将来 readUser 関数が成長し、新たなコードが別の種類のエラーを生み出すかもしれません。

readUser を呼び出すコードは、これらのエラーを処理する必要があります。今は catch ブロックの中で、異なるエラータイプのチェックと未知のエラーを再スローするために、複数の if を使っています。

スキーマはこのようになります:

try {
  ...
  readUser()  // 潜在的なエラーの原因
  ...
} catch (err) {
  if (err instanceof ValidationError) {
    // バリデーションエラーの処理
  } else if (err instanceof SyntaxError) {
    // シンタックスエラーの処理
  } else {
    throw err; // 未知のエラー、再スロー
  }
}

上のコードでは2種類のエラーがありますが、他にもありえます。

もし readUser 関数が複数の種類のエラーを生成する場合、readUser 呼び出しをするすべてのコードで、毎回本当にすべてのエラータイプを1つずつチェックしたいですか？

多くの場合、答えは、“いいえ” です。:　外側のコードは “それらすべての1つ上のレベル” でありたいです。つまり、“データ読み込みエラー” が発生したかどうかが知りたいだけです。発生した正確な理由については、多くの場合は無関心です（エラーメッセージで説明されています）。また、さらに良いのは、必要な場合にのみエラーの詳細を取得する方法があることです。

このテクニックは “例外のラッピング(wrapping exceptions)” と呼ばれます。

1. 汎用的な “データ読み込み” エラーを表現する新しいクラス ReadError を作ります。
2. 関数 readUser は ValidationError ã‚„ SyntaxError のような、内部で発生するデータ読み込みエラーをキャッチし、代わりに ReadError を生成します。
3. ReadError オブジェクトは自身の cause プロパティに元のエラーへの参照を保持します。

readUser を呼び出すコードは、ReadError だけをチェックする必要があり、他の種類のデータ読み込みエラーのチェックは不要です。そして、エラーの詳細が必要な場合は、その cause プロパティで確認できます。

これは、ReadError を定義し、readUser と try..catch でそれを利用するデモです。:

class ReadError extends Error {
  constructor(message, cause) {
    super(message);
    this.cause = cause;
    this.name = 'ReadError';
  }
}

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

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

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

function readUser(json) {
  let user;

  try {
    user = JSON.parse(json);
  } catch (err) {
    if (err instanceof SyntaxError) {
      throw new ReadError("Syntax Error", err);
    } else {
      throw err;
    }
  }

  try {
    validateUser(user);
  } catch (err) {
    if (err instanceof ValidationError) {
      throw new ReadError("Validation Error", err);
    } else {
      throw err;
    }
  }

}

try {
  readUser('{bad json}');
} catch (e) {
  if (e instanceof ReadError) {
    alert(e);
    // Original error: SyntaxError: Unexpected token b in JSON at position 1
    alert("Original error: " + e.cause);
  } else {
    throw e;
  }
}

上のコードで、readUser は説明されている通りに正確に動作します – 構文とバリデーションエラーをキャッチし、ReadError エラーを代わりにスローします(未知のエラーは通常通り再スローします)。

なので、外部のコードは instanceof ReadError をチェックするだけです。可能性のあるすべてのエラータイプをリストする必要はありません。

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

サマリ

• Error や他の組み込みのエラークラスから継承することができます。そのときは、name プロパティに手を入れることと、super の呼び出しを忘れないでください。
• 特定のエラーのチェックには instanceof が使えます。これは継承している場合にも有効です。しかし、ときにはサードパーティのライブラリから来たエラーオブジェクトを持っていて、簡単にそのクラスを取得する方法がないことがあります。このような場合には name プロパティが使えます。
• 例外のラッピングは広く利用されているテクニックです: 関数が低レベルの例外を処理し、それぞれの低レベルの例外の代わりに高レベルのエラーを生成します。低レベルの例外は、上の例の err.cause のようにオブジェクトのプロパティになることがありますが、厳密には必須ではありません。