TypeScript エラー処理

エラー処理はプログラムの堅牢性を保証する重要な要素です。

TypeScriptは強力な型システムを提供し、開発者がエラーをより適切に処理・防止するのに役立ちます。

この記事では、TypeScriptにおける一般的なエラー処理パターンとベストプラクティスを紹介します。


SVG図:エラー処理の方法 背景 タイトル エラー処理の方法 方法1:try-catch try-catch try { // エラーが発生する可能性のあるコード } catch (e) { // エラーを処理する } 例外をキャッチして処理する 方法2:Result型 Result型 type Result = | { ok: true; value: T } | { ok: false; error: E } 例外を投げずに結果を返す 方法3:エラー型 カスタムエラー class AppError extends Error { code: string; } 構造化されたエラー情報 下半分 ベストプラクティス 実践1 エラー型を明確にする 実践2 エラー処理を集中する 実践3 例外のリークを防ぐ

なぜ優れたエラー処理が必要なのか

あらゆるプログラムは、ネットワークリクエストの失敗、ファイルの不存在、ユーザー入力の誤りなど、エラー状況に遭遇する可能性があります。

優れたエラー処理は、プログラムのクラッシュを防ぎ、ユーザーフレンドリーなエラーメッセージを提供し、開発者が問題を特定するのに役立ちます。

TypeScriptの型システムはコンパイル段階で潜在的な問題を発見し、実行時エラーを減らすことができます。

概念の説明:エラー処理には主に2つの方法があります:例外処理(try-catch)と戻り値処理(Result型)です。前者は例外を投げてエラーを表現し、後者は戻り値にエラー情報を持たせます。


カスタムエラー型

Errorクラスを拡張してカスタムエラー型を作成すると、より多くのエラー情報を持たせることができます。

これにより、エラー処理がより正確かつ構造化されます。

例

// アプリケーションエラークラスを定義
// 組み込みのErrorクラスを拡張し、エラーコードを追加
class AppError extends Error {
    // エラーコード。プログラムによるエラー処理に使用
    code: string;

    // コンストラクタ
    constructor(message: string, code: string) {
        super(message);  // 親クラスのコンストラクタを呼び出す
        this.name = "AppError";  // エラー名を設定
        this.code = code;  // エラーコードを保存
    }
}

// 安全な除算関数
function divide(a: number, b: number): number {
    // 除数がゼロかどうかを確認
    if (b === 0) {
        // カスタムエラーを投げる
        throw new AppError("Cannot divide by zero", "DIVIDE_BY_ZERO");
    }
    return a / b;
}

// try-catchを使用してエラーをキャッチ
try {
    var result = divide(10, 0);
} catch (error) {
    // エラーの型を確認
    if (error instanceof AppError) {
        console.log("アプリケーションエラー: " + error.message + ", コード: " + error.code);
    } else {
        console.log("不明なエラー: " + error);
    }
}

実行結果:

应用错误: Cannot divide by zero, 代码: DIVIDE_BY_ZERO

エラーコード:エラーにコードを追加すると、プログラムがさまざまな種類のエラーをより正確に処理できるようになります。


Result型で例外を回避する

もう1つのエラー処理方法は、Result型を使用することです。

これは例外を投げる代わりに、戻り値にエラー情報を持たせます。この方法は関数型プログラミングでよく見られます。

例

// 共用型(ユニオン型)を使用してResult型を定義
// 成功時は ok: true と値を含み、失敗時は ok: false とエラーを含む
type Result<T, E = Error> =
    | { ok: true; value: T }
    | { ok: false; error: E };

// Result型を使用した除算関数
function safeDivide(a: number, b: number): Result<number, string> {
    // 除数がゼロかどうかを確認
    if (b === 0) {
        // エラー結果を返す
        return { ok: false, error: "Cannot divide by zero" };
    }
    // 成功結果を返す
    return { ok: true, value: a / b };
}

// 関数を呼び出し、結果を処理
var result = safeDivide(10, 2);

// 結果の型に応じて処理
if (result.ok) {
    console.log("結果: " + result.value);
} else {
    console.log("エラー: " + result.error);
}

実行結果:

结果: 5

利点:Result型はエラー処理を明示的にし、呼び出し側は潜在的なエラーを無視せずに処理する必要があります。


Async関数のエラー処理

非同期関数では、エラー処理が特に重要です。

try-catchまたはResult型を使用して、非同期操作のエラーを処理できます。

例

// ユーザーインターフェースを定義
interface User {
    id: number;
    name: string;
}

// ユーザーを取得する非同期関数をシミュレート
async function fetchUser(id: number): Promise<Result<User, Error>> {
    try {
        // ネットワークリクエストをシミュレート
        var response = await fetch("/api/users/" + id);
        var user = await response.json();
        // 成功結果を返す
        return { ok: true, value: user };
    } catch (error) {
        // エラー結果を返す
        return { ok: false, error: error as Error };
    }
}

// メイン関数
async function main() {
    // 非同期関数を呼び出す
    var result = await fetchUser(1);

    // 結果を処理
    if (result.ok) {
        console.log("ユーザー: " + JSON.stringify(result.value));
    } else {
        console.log("エラー: " + result.error.message);
    }
}

// メイン関数を実行
main();

実行結果:

ユーザー: {"id":1,"name":"Alice"}

ヒント:非同期関数内のtry-catchは、await式が投げるあらゆるエラーをキャッチします。


汎用エラー処理のカプセル化

汎用のエラー処理関数を作成すると、非同期コードのエラー処理を簡素化できます。

例

// 汎用エラー処理ラッパー関数
// 非同期関数を受け取り、Result型を返す
async function withErrorHandling<T>(
    fn: () => Promise<T>
): Promise<Result<T, Error>> {
    try {
        // 渡された非同期関数を実行
        var data = await fn();
        // 成功結果を返す
        return { ok: true, value: data };
    } catch (error) {
        // エラー結果を返す
        return { ok: false, error: error as Error };
    }
}

// 汎用エラー処理を使用
// データ取得をシミュレート
var result = await withErrorHandling(async function() {
    var response = await fetch("/api/data");
    return response.json();
});

// 結果に応じて処理
if (result.ok) {
    console.log("データ: " + JSON.stringify(result.value));
} else {
    console.error("エラー:", result.error);
}

ベストプラクティス:汎用のエラー処理ロジックをカプセル化すると、コードの重複を減らし、コードの保守性を向上させることができます。


注意事項

  • エラーを無視しない:空のcatchブロックでエラーをキャッチして無視しないでください
  • エラー型を明確にする:一般的なErrorではなく、具体的なエラー型を使用するようにしてください
  • エラーバウンダリ:アプリケーションに統一されたエラー処理メカニズムを構築する
  • 例外を使いすぎない:予測可能なエラーについては、例外を投げる代わりに戻り値を使用することを優先する

推奨:シナリオに応じてエラー処理方法を選択します:プログラムエラーには例外、ビジネスエラーにはResultを使用します。


まとめ

優れたエラー処理は、堅牢なアプリケーションを構築するための基盤です。

  • カスタムエラー:Errorクラスを拡張し、エラーコードなどの情報を追加する
  • Result型:戻り値でエラーを処理し、例外を回避する
  • async/await:try-catchを使用して非同期エラーを処理する
  • エラーカプセル化:汎用エラー処理関数を作成する
  • エラーバウンダリ:統一されたエラー処理メカニズムを構築する

ベストプラクティス:具体的なシナリオに応じて適切なエラー処理方法を選択し、コードの可読性と堅牢性のバランスを取ります。


その他の拡張