C#でIDisposableデザインパターンを実装する方法を解説

アンマネージリソース(アンマネージオブジェクト)を確実に解放する必要がある場面では、IDisposableデザインパターン(Disposeパターン)を採用するのが推奨されます。

IDisposableデザインパターンを実装する際は、アンマネージオブジェクトを直接的または間接的に扱うクラスに対してIDisposableインターフェースを実装し、同インターフェース内で宣言されているDisposeメソッドを定義します。実際の開発では、アンマネージオブジェクトを直接操作することはほとんどなく、それらを内部で扱うマネージクラス(ファイルハンドラ、データベース接続文字列、HTTPストリームなど)を経由して利用するのが一般的です。

このパターンの重要なポイントは、オーバーライド可能なDisposeメソッドを提供することで、継承先のクラスでもIDisposableデザインパターンに容易に準拠できるようになる点にあります。さらに、このパターンではファイナライザー(C#ではデストラクタと呼ばれます)の実装も推奨されています。ただし、ファイナライザーはガベージコレクションの動作に影響を与え、パフォーマンス面でのコストが高いため、使用する場合は適切に管理することが重要です。

実装例

static class Program {
    static void Main(string[] args) {
        using var serviceProxy = new ServiceProxy(null);
        serviceProxy.Get();
        serviceProxy.Post("");
        Console.ReadLine();
    }
}
public class ServiceProxy : System.IDisposable {
    private readonly HttpClient httpClient;
    private bool disposed;

    public ServiceProxy(IHttpClientFactory httpClientFactory) {
        httpClient = httpClientFactory.CreateClient();
    }
    ~ServiceProxy() {
        Dispose(false);
    }
    public void Dispose() {
        Dispose(true);
        GC.SuppressFinalize(this);
    }
    protected virtual void Dispose(bool disposing) {
        if (disposed) {
            return;
        }

        if (disposing) {
            // マネージオブジェクトの解放
            httpClient.Dispose();
        }
        // アンマネージオブジェクトの解放
        disposed = true;
    }
    public void Get() {
        var response = httpClient.GetAsync("");
    }
    public void Post(string request) {
        var response = httpClient.PostAsync("", new StringContent(request));
    }
}

コードのポイント

• Dispose(bool disposing)：引数disposingがtrueの場合はマネージオブジェクト(HttpClientなど)を解放し、falseの場合はアンマネージリソースのみを対象とします。これにより、明示的な解放とファイナライザーからの呼び出しを正しく区別できます。
• disposedフラグ：既に解放済みの場合は処理をスキップすることで、二重解放を防止し、冪等性を保証します。
• GC.SuppressFinalize(this)：Disposeが明示的に呼び出された後はファイナライザーの実行を抑制することで、不要なGCの負荷を軽減します。
• usingステートメント：スコープを抜けた時点で自動的にDisposeが呼び出されるため、リソースの解放漏れを防ぐことができます。