C#でのカスタム例外クラスの作成方法を徹底解説

C#でのエラーハンドリングを強化するためには、カスタム例外クラスの作成が重要です。本記事では、カスタム例外クラスの基本構造から実践的な使用例までを網羅し、具体的な手順を通じて理解を深めます。独自の例外クラスを作成することで、コードの可読性とメンテナンス性が向上し、複雑なエラーハンドリングを効率的に行うことができます。

カスタム例外クラスの必要性

カスタム例外クラスは、標準の例外クラスでは対応できない特定のエラー状況を管理するために使用されます。標準の例外クラス（例：ArgumentNullExceptionやInvalidOperationException）は一般的なエラーに対して十分ですが、アプリケーション固有のエラーをより具体的に表現するにはカスタム例外が有効です。

エラーの詳細な特定

カスタム例外クラスを使用することで、エラーの原因をより具体的に特定できます。これにより、デバッグやログの分析が容易になり、問題解決の速度が向上します。

コードの可読性とメンテナンス性の向上

特定のエラー状況に対して明示的な例外クラスを作成することで、コードの可読性が向上します。メンテナンス時にも、どのようなエラーが発生し得るかが明確になるため、修正や機能追加がしやすくなります。

エラーハンドリングの一貫性

カスタム例外を使用することで、アプリケーション全体で一貫したエラーハンドリングの実装が可能となります。これにより、エラー処理の統一性が保たれ、コード全体の品質が向上します。

カスタム例外クラスの基本構造

カスタム例外クラスは、標準のExceptionクラスまたはその派生クラスを継承して作成します。基本的な構造は以下のようになります。

クラス定義

まず、カスタム例外クラスを定義します。クラス名は通常、Exceptionという単語を含めます。例えば、MyCustomExceptionとします。

public class MyCustomException : Exception
{
    public MyCustomException()
    {
    }

    public MyCustomException(string message)
        : base(message)
    {
    }

    public MyCustomException(string message, Exception inner)
        : base(message, inner)
    {
    }
}

コンストラクタの追加

カスタム例外クラスには、複数のコンストラクタを追加しておくと便利です。以下の3つのコンストラクタが一般的です。

デフォルトコンストラクタ: 引数なしで例外を生成します。
メッセージ付きコンストラクタ: エラーメッセージを指定して例外を生成します。
内部例外付きコンストラクタ: エラーメッセージと、内部例外（この例外の原因となった別の例外）を指定して例外を生成します。

シリアライズ対応（オプション）

カスタム例外クラスをシリアライズ可能にするには、シリアライズコンストラクタとGetObjectDataメソッドをオーバーライドします。これは、例外をネットワーク越しに転送したり、ファイルに保存したりする場合に必要です。

[Serializable]
public class MyCustomException : Exception
{
    protected MyCustomException(SerializationInfo info, StreamingContext context)
        : base(info, context)
    {
    }

    public override void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        base.GetObjectData(info, context);
    }
}

このように、カスタム例外クラスは標準のExceptionクラスを継承し、必要なコンストラクタやメソッドを追加することで作成します。次に、具体的な作成手順について詳しく説明します。

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

カスタム例外クラスを実際に作成する手順を具体的に見ていきましょう。このセクションでは、C#でのカスタム例外クラスの作成方法を順を追って解説します。

1. クラスの定義と命名

まず、適切な名前を持つ新しいクラスを作成します。クラス名には通常、Exceptionという単語を含めます。

public class MyCustomException : Exception
{
}

2. コンストラクタの追加

次に、必要なコンストラクタを追加します。以下の3つのコンストラクタを含めることが一般的です。

デフォルトコンストラクタ
メッセージを受け取るコンストラクタ
メッセージと内部例外を受け取るコンストラクタ

public class MyCustomException : Exception
{
    public MyCustomException()
    {
    }

    public MyCustomException(string message)
        : base(message)
    {
    }

    public MyCustomException(string message, Exception inner)
        : base(message, inner)
    {
    }
}

3. プロパティの追加（オプション）

特定のエラー情報を保持するためのプロパティを追加することもできます。

public class MyCustomException : Exception
{
    public int ErrorCode { get; set; }

    public MyCustomException()
    {
    }

    public MyCustomException(string message)
        : base(message)
    {
    }

    public MyCustomException(string message, Exception inner)
        : base(message, inner)
    {
    }

    public MyCustomException(string message, int errorCode)
        : base(message)
    {
        ErrorCode = errorCode;
    }
}

4. シリアライズ対応（オプション）

例外をシリアライズ可能にするには、ISerializableインターフェースを実装し、シリアライズコンストラクタとGetObjectDataメソッドを追加します。

[Serializable]
public class MyCustomException : Exception
{
    public int ErrorCode { get; set; }

    public MyCustomException()
    {
    }

    public MyCustomException(string message)
        : base(message)
    {
    }

    public MyCustomException(string message, Exception inner)
        : base(message, inner)
    {
    }

    public MyCustomException(string message, int errorCode)
        : base(message)
    {
        ErrorCode = errorCode;
    }

    protected MyCustomException(SerializationInfo info, StreamingContext context)
        : base(info, context)
    {
        ErrorCode = info.GetInt32("ErrorCode");
    }

    public override void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        base.GetObjectData(info, context);
        info.AddValue("ErrorCode", ErrorCode);
    }
}

この手順に従うことで、カスタム例外クラスを作成し、独自のエラーハンドリングを実装することができます。次は、プロパティとメソッドの追加方法について説明します。

プロパティとメソッドの追加

カスタム例外クラスにプロパティやメソッドを追加することで、エラーに関する詳細な情報を提供し、処理をカスタマイズすることができます。このセクションでは、プロパティとメソッドの追加方法を解説します。

プロパティの追加

カスタム例外クラスにプロパティを追加することで、エラーに関する詳細情報を格納できます。例えば、エラーコードや関連情報を保持するプロパティを追加します。

public class MyCustomException : Exception
{
    public int ErrorCode { get; set; }

    public MyCustomException()
    {
    }

    public MyCustomException(string message)
        : base(message)
    {
    }

    public MyCustomException(string message, Exception inner)
        : base(message, inner)
    {
    }

    public MyCustomException(string message, int errorCode)
        : base(message)
    {
        ErrorCode = errorCode;
    }
}

この例では、ErrorCodeプロパティを追加し、エラーコードを保持できるようにしています。

メソッドの追加

エラーに対するカスタムロジックを実装するために、カスタム例外クラスにメソッドを追加することも可能です。例えば、エラーメッセージをカスタマイズするメソッドを追加します。

public class MyCustomException : Exception
{
    public int ErrorCode { get; set; }

    public MyCustomException()
    {
    }

    public MyCustomException(string message)
        : base(message)
    {
    }

    public MyCustomException(string message, Exception inner)
        : base(message, inner)
    {
    }

    public MyCustomException(string message, int errorCode)
        : base(message)
    {
        ErrorCode = errorCode;
    }

    public string GetCustomMessage()
    {
        return $"Error Code: {ErrorCode}, Message: {Message}";
    }
}

GetCustomMessageメソッドは、ErrorCodeとエラーメッセージを組み合わせたカスタムメッセージを返します。

シリアライズ対応（再掲）

プロパティやメソッドを追加した場合、シリアライズ対応が必要な場合は、シリアライズコンストラクタとGetObjectDataメソッドをオーバーライドする必要があります。

[Serializable]
public class MyCustomException : Exception
{
    public int ErrorCode { get; set; }

    public MyCustomException()
    {
    }

    public MyCustomException(string message)
        : base(message)
    {
    }

    public MyCustomException(string message, Exception inner)
        : base(message, inner)
    {
    }

    public MyCustomException(string message, int errorCode)
        : base(message)
    {
        ErrorCode = errorCode;
    }

    protected MyCustomException(SerializationInfo info, StreamingContext context)
        : base(info, context)
    {
        ErrorCode = info.GetInt32("ErrorCode");
    }

    public override void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        base.GetObjectData(info, context);
        info.AddValue("ErrorCode", ErrorCode);
    }

    public string GetCustomMessage()
    {
        return $"Error Code: {ErrorCode}, Message: {Message}";
    }
}

このように、プロパティやメソッドを追加することで、カスタム例外クラスをより強力で使いやすいものにすることができます。次に、カスタム例外をスローし、キャッチする方法について説明します。

例外のスローとキャッチ

カスタム例外クラスを作成した後は、実際に例外をスローし、キャッチする方法を学びます。これにより、アプリケーション内で発生する特定のエラー状況に対処することができます。

カスタム例外のスロー

カスタム例外をスローするには、throwキーワードを使用します。以下は、カスタム例外をスローする例です。

public void PerformOperation(int value)
{
    if (value < 0)
    {
        throw new MyCustomException("Value cannot be negative", 1001);
    }

    // そのほかの操作
}

この例では、valueが負の値の場合にMyCustomExceptionをスローします。エラーメッセージとエラーコードを渡しています。

カスタム例外のキャッチ

スローされたカスタム例外をキャッチするには、try-catchブロックを使用します。以下は、カスタム例外をキャッチする例です。

public void ExecuteOperation()
{
    try
    {
        PerformOperation(-1);
    }
    catch (MyCustomException ex)
    {
        Console.WriteLine(ex.GetCustomMessage());
    }
}

この例では、PerformOperationメソッドがカスタム例外をスローした場合、それをキャッチし、カスタムメッセージをコンソールに出力します。

複数の例外をキャッチ

複数の例外をキャッチする場合は、複数のcatchブロックを使用します。以下の例では、標準の例外とカスタム例外をキャッチします。

public void ExecuteOperation()
{
    try
    {
        PerformOperation(-1);
    }
    catch (MyCustomException ex)
    {
        Console.WriteLine($"Custom Exception Caught: {ex.GetCustomMessage()}");
    }
    catch (Exception ex)
    {
        Console.WriteLine($"General Exception Caught: {ex.Message}");
    }
}

この例では、MyCustomExceptionがスローされた場合とその他の例外がスローされた場合に応じて異なるメッセージを出力します。

例外の再スロー

キャッチした例外を再度スローする場合は、throwキーワードを使用します。以下の例では、カスタム例外をキャッチした後、再スローしています。

public void ExecuteOperation()
{
    try
    {
        PerformOperation(-1);
    }
    catch (MyCustomException ex)
    {
        Console.WriteLine("Handling exception and rethrowing...");
        throw;
    }
}

この例では、カスタム例外をキャッチしてメッセージを出力した後、同じ例外を再度スローしています。

このように、カスタム例外をスローしキャッチすることで、特定のエラーに対する処理を柔軟に行うことができます。次に、実践的な使用例を紹介します。

実践的な使用例

ここでは、カスタム例外クラスを実際のプロジェクトでどのように活用するかを具体例を通じて紹介します。例として、ユーザー登録システムで発生し得る特定のエラーを管理するカスタム例外を見ていきます。

ユーザー登録システムにおけるカスタム例外の活用

ユーザー登録システムでは、さまざまなエラーが発生する可能性があります。例えば、ユーザー名が既に使用されている場合やパスワードが要件を満たしていない場合です。これらのエラーを管理するために、カスタム例外を使用します。

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

まず、ユーザー登録に関するカスタム例外クラスを作成します。

public class UserRegistrationException : Exception
{
    public int ErrorCode { get; set; }

    public UserRegistrationException() { }

    public UserRegistrationException(string message)
        : base(message) { }

    public UserRegistrationException(string message, Exception inner)
        : base(message, inner) { }

    public UserRegistrationException(string message, int errorCode)
        : base(message)
    {
        ErrorCode = errorCode;
    }

    protected UserRegistrationException(SerializationInfo info, StreamingContext context)
        : base(info, context)
    {
        ErrorCode = info.GetInt32("ErrorCode");
    }

    public override void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        base.GetObjectData(info, context);
        info.AddValue("ErrorCode", ErrorCode);
    }

    public string GetCustomMessage()
    {
        return $"Error Code: {ErrorCode}, Message: {Message}";
    }
}

具体的なエラーケースの実装

次に、ユーザー名が既に使用されている場合の例外をスローするメソッドを実装します。

public class UserService
{
    private List<string> existingUsernames = new List<string> { "user1", "user2" };

    public void RegisterUser(string username, string password)
    {
        if (existingUsernames.Contains(username))
        {
            throw new UserRegistrationException("Username already exists", 1001);
        }

        if (password.Length < 8)
        {
            throw new UserRegistrationException("Password does not meet the minimum length requirement", 1002);
        }

        // 登録処理
        existingUsernames.Add(username);
        Console.WriteLine("User registered successfully");
    }
}

例外のキャッチと処理

カスタム例外をキャッチして適切に処理します。

public class Program
{
    public static void Main()
    {
        UserService userService = new UserService();

        try
        {
            userService.RegisterUser("user1", "password");
        }
        catch (UserRegistrationException ex)
        {
            Console.WriteLine($"Custom Exception Caught: {ex.GetCustomMessage()}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"General Exception Caught: {ex.Message}");
        }
    }
}

この例では、UserServiceクラスのRegisterUserメソッドでカスタム例外をスローし、ProgramクラスのMainメソッドでその例外をキャッチして適切に処理しています。

カスタム例外クラスを使用することで、アプリケーション固有のエラーを明確に管理し、エラー発生時の対応を一貫して行うことができます。次に、カスタム例外クラスを使用する際のベストプラクティスについて説明します。

ベストプラクティス

カスタム例外クラスを効果的に使用するためには、いくつかのベストプラクティスを遵守することが重要です。これにより、エラーハンドリングの効率が向上し、コードの品質が保たれます。

意味のある名前を付ける

カスタム例外クラスには、例外の内容を具体的に表す意味のある名前を付けるようにしましょう。例えば、UserRegistrationExceptionやFileProcessingExceptionなどです。これにより、例外の内容が明確になり、コードの可読性が向上します。

詳細なエラーメッセージを提供する

エラーメッセージは、問題の原因を特定するための重要な手がかりです。カスタム例外をスローする際には、可能な限り具体的で詳細なエラーメッセージを提供するようにしましょう。

throw new UserRegistrationException("Username 'john_doe' is already taken. Please choose a different username.", 1001);

適切なエラーコードを使用する

エラーコードを使用することで、エラーの種類をプログラム的に識別しやすくなります。エラーコードは一貫した形式で管理し、必要に応じてドキュメント化しておくと便利です。

内包例外を活用する

内部例外を含むカスタム例外を使用することで、エラーの原因を追跡しやすくなります。内部例外は、元の例外情報を保持するために使用します。

try
{
    // ファイルの読み込み処理
}
catch (IOException ioEx)
{
    throw new FileProcessingException("An error occurred while processing the file.", ioEx);
}

シリアライズ対応を考慮する

カスタム例外クラスをシリアライズ対応にしておくと、例外をネットワーク越しに転送したり、ファイルに保存したりする際に便利です。特に、分散システムやリモートサービスを使用する場合はシリアライズ対応が重要です。

例外を過剰に使用しない

例外は、正常なプログラムの流れを制御するために使用するべきではありません。例外は、本当にエラーが発生した場合にのみ使用し、通常の条件分岐や検証ロジックで処理できる場合は例外を使用しないようにしましょう。

ドキュメントを整備する

カスタム例外クラスとその使用方法について、十分なドキュメントを整備しておくことが重要です。これにより、他の開発者がカスタム例外クラスを正しく使用しやすくなります。

これらのベストプラクティスを守ることで、カスタム例外クラスを効果的に使用し、エラーハンドリングをより強力で一貫性のあるものにすることができます。次に、カスタム例外クラスに関連する一般的な問題とその解決方法について説明します。

トラブルシューティング

カスタム例外クラスを使用する際に発生し得る一般的な問題と、その解決方法について解説します。これにより、カスタム例外の使用がスムーズになり、予期せぬエラーに対処する能力が向上します。

問題1: 例外がキャッチされない

カスタム例外がキャッチされない場合、try-catchブロックが適切に配置されているか、キャッチする例外の型が正しいかを確認します。

try
{
    PerformOperation(-1);
}
catch (UserRegistrationException ex)
{
    Console.WriteLine($"Custom Exception Caught: {ex.GetCustomMessage()}");
}
catch (Exception ex)
{
    Console.WriteLine($"General Exception Caught: {ex.Message}");
}

解決方法として、カスタム例外を特定のcatchブロックでキャッチし、一般的な例外は別のcatchブロックでキャッチします。

問題2: 内部例外が失われる

カスタム例外をスローする際に、内部例外が適切に渡されていないと、デバッグが困難になります。

try
{
    // ファイル読み込み処理
}
catch (IOException ioEx)
{
    throw new FileProcessingException("An error occurred while processing the file.", ioEx);
}

解決方法として、内部例外をカスタム例外のコンストラクタに渡し、保持するようにします。

問題3: シリアライズで例外が発生する

カスタム例外をシリアライズする際にエラーが発生する場合、シリアライズ対応が正しく実装されているかを確認します。

[Serializable]
public class MyCustomException : Exception
{
    public int ErrorCode { get; set; }

    protected MyCustomException(SerializationInfo info, StreamingContext context)
        : base(info, context)
    {
        ErrorCode = info.GetInt32("ErrorCode");
    }

    public override void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        base.GetObjectData(info, context);
        info.AddValue("ErrorCode", ErrorCode);
    }
}

解決方法として、シリアライズコンストラクタとGetObjectDataメソッドを正しく実装します。

問題4: 詳細なエラーメッセージが表示されない

カスタム例外のメッセージが十分に詳細でない場合、デバッグが困難になります。

public string GetCustomMessage()
{
    return $"Error Code: {ErrorCode}, Message: {Message}";
}

解決方法として、カスタムメッセージを生成するメソッドを追加し、詳細なエラーメッセージを提供します。

問題5: 例外が多発する

例外が多発する場合、例外の使用が適切でない可能性があります。通常のフロー制御には例外を使用しないようにします。

解決方法として、エラーハンドリングのロジックを見直し、必要に応じて事前条件の検証やガード条件を使用します。

これらのトラブルシューティングの方法を理解しておくことで、カスタム例外クラスの使用に関連する問題を迅速に解決できるようになります。次に、学んだ内容を確認するための演習問題を提供します。

演習問題

ここでは、カスタム例外クラスの作成と使用方法について理解を深めるための演習問題を提供します。これらの問題を通じて、実際にコードを記述し、カスタム例外の適用方法を確認しましょう。

問題1: 基本的なカスタム例外クラスの作成

以下の仕様に従って、InvalidUserInputExceptionというカスタム例外クラスを作成してください。

標準のExceptionクラスを継承する
デフォルトコンストラクタ、メッセージを受け取るコンストラクタ、メッセージと内部例外を受け取るコンストラクタを定義する
エラーメッセージとともに入力値を保持するプロパティInputValueを追加する

public class InvalidUserInputException : Exception
{
    public string InputValue { get; set; }

    public InvalidUserInputException()
    {
    }

    public InvalidUserInputException(string message)
        : base(message)
    {
    }

    public InvalidUserInputException(string message, Exception inner)
        : base(message, inner)
    {
    }

    public InvalidUserInputException(string message, string inputValue)
        : base(message)
    {
        InputValue = inputValue;
    }
}

問題2: カスタム例外のスローとキャッチ

次に、ユーザーの入力を検証し、不正な入力があった場合にInvalidUserInputExceptionをスローするValidateUserInputメソッドを作成してください。

入力値が空文字列の場合、InvalidUserInputExceptionをスローする
入力値が数値でない場合、InvalidUserInputExceptionをスローする

public void ValidateUserInput(string input)
{
    if (string.IsNullOrEmpty(input))
    {
        throw new InvalidUserInputException("Input cannot be empty", input);
    }

    if (!int.TryParse(input, out _))
    {
        throw new InvalidUserInputException("Input must be a number", input);
    }
}

このメソッドを呼び出し、例外をキャッチして適切に処理するコードをMainメソッド内に記述してください。

public static void Main()
{
    try
    {
        ValidateUserInput("");
    }
    catch (InvalidUserInputException ex)
    {
        Console.WriteLine($"Custom Exception Caught: {ex.Message}, Invalid Input: {ex.InputValue}");
    }
}

問題3: シリアライズ対応のカスタム例外クラス

InvalidUserInputExceptionクラスをシリアライズ対応に拡張してください。必要なシリアライズコンストラクタとGetObjectDataメソッドを実装します。

[Serializable]
public class InvalidUserInputException : Exception
{
    public string InputValue { get; set; }

    public InvalidUserInputException()
    {
    }

    public InvalidUserInputException(string message)
        : base(message)
    {
    }

    public InvalidUserInputException(string message, Exception inner)
        : base(message, inner)
    {
    }

    public InvalidUserInputException(string message, string inputValue)
        : base(message)
    {
        InputValue = inputValue;
    }

    protected InvalidUserInputException(SerializationInfo info, StreamingContext context)
        : base(info, context)
    {
        InputValue = info.GetString("InputValue");
    }

    public override void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        base.GetObjectData(info, context);
        info.AddValue("InputValue", InputValue);
    }
}

これらの演習問題を通じて、カスタム例外クラスの作成、スロー、キャッチ、シリアライズ対応の方法を実践的に学ぶことができます。次に、本記事の内容を簡潔にまとめます。

まとめ

本記事では、C#でカスタム例外クラスを作成する方法について詳しく解説しました。カスタム例外クラスを使用することで、エラーハンドリングの精度とコードの可読性が向上し、特定のエラー状況に対してより適切に対処できるようになります。

具体的には、カスタム例外クラスの必要性から始まり、基本構造の説明、作成手順、プロパティやメソッドの追加方法、実際の使用例、ベストプラクティス、トラブルシューティング、そして理解を深めるための演習問題までを網羅しました。

カスタム例外クラスを適切に設計・実装することで、アプリケーション全体のエラーハンドリングが一貫性を持ち、メンテナンス性が向上します。今回学んだ内容を活かして、より堅牢で可読性の高いコードを作成してください。

以上で、C#でのカスタム例外クラスの作成方法に関する解説を終わります。