C#アプリケーション

C#におけるIDisposableとUsing文の仕組み

Tim Corey

10m 00s

リソース管理は、C#開発者にとって最も重要な責務の1つです。ファイルハンドル、データベース接続、管理されていないメモリなどのリソースを適切にクリーンアップしないと、アプリケーションはすぐにパフォーマンスの問題やメモリリーク、あるいはシステムクラッシュに陥る可能性があります。

Tim Corey氏のビデオ"How IDisposable and Using Statements Work Together in C#"では、C#のIDisposableパターンがどのように適切なリソース管理を保証し、using文がどのようにクリーンアップを簡素化するのかについて、わかりやすく実践的な説明をしています。この記事では、彼のデモンストレーションを順を追って見ていき、このパターンが管理されていないリソースを効率的に解放し、リソースの漏れを防ぐのにどのように役立つかを理解しましょう。

IDisposableとリソース管理の紹介

Timはまず、IDisposableを"アプリケーションの適切なリソース管理と安全性を確保するための強力なツール"と説明する。彼は、管理されていないリソース（データベース接続、ファイルストリーム、システムハンドルなど）は、ガベージコレクタによって自動的にクリーンアップされないと説明する。

一方、管理されたリソース（文字列や通常のC#オブジェクトなど）は、ガベージコレクションプロセスによって自動的に処理されます。問題は、クラスがOSレベルのメモリやファイルハンドルなど、管理されていないコードや管理されていないリソースと直接やりとりするときに発生します。

ティムは、管理されていないリソースが明示的に解放されないと、割り当てられたままになり、メモリ・リークやシステム・パフォーマンスの低下を引き起こすことを強調しています。 IDisposableインターフェイスは、開発者に決定論的なクリーンアップメカニズム、つまりオブジェクトの寿命が終了したときにリソースをクリーンアップする保証された方法を提供するために設計されました。

リソース使用量をシミュレーションする

クリーンアップの必要性を示すために、TimはDemoResourceクラスを含む小さなコンソールアプリを作成します。このクラスには、データベース接続のオープンとクローズをシミュレートする DoWork() メソッドがあります：

public class DemoResource
{
    public void DoWork()
    {
        Console.WriteLine("Opening Connection");
        Console.WriteLine("Doing Work");
        Console.WriteLine("Closing Connection");
    }
}

public class DemoResource
{
    public void DoWork()
    {
        Console.WriteLine("Opening Connection");
        Console.WriteLine("Doing Work");
        Console.WriteLine("Closing Connection");
    }
}

Public Class DemoResource
    Public Sub DoWork()
        Console.WriteLine("Opening Connection")
        Console.WriteLine("Doing Work")
        Console.WriteLine("Closing Connection")
    End Sub
End Class

Public Class DemoResource
    Public Sub DoWork()
        Console.WriteLine("Opening Connection")
        Console.WriteLine("Doing Work")
        Console.WriteLine("Closing Connection")
    End Sub
End Class

これは、データベースへの接続の確立やファイルへの書き込みなど、管理されていないリソースを含む典型的なワークフローを表しています。DoWork()内の操作は、管理されていないリソースを直接使用した場合に起こることをシミュレートしています。

うまくいかないとき - リソースリーク

2分あたりで、ティムは、プロセスが正しく完了しない場合に何が起こるかを示しています。彼は、操作中のエラーをシミュレートするために例外を追加します：

throw new Exception("I broke");

throw new Exception("I broke");

Throw New Exception("I broke")

Throw New Exception("I broke")

この例外が発生した場合、プログラムは "Closing Connection "行に到達しません。

ティムは、アプリケーションがデータベース接続を閉じるのに失敗したため、毎晩サーバーを再起動しなければならなかった初期の経験を思い出しています。これらの閉じられない接続は蓄積され、利用可能なすべてのメモリとソケットを消費します。これは、クリーンアップ・ロジックの欠落や不適切さによるリソース漏れの典型的な例です。

IDisposableの役割

これを解決するために、TimはDisposeメソッドを定義するIDisposableインターフェイスを紹介しています。 IDisposableを実装することで、.NETにこのクラスがリリースすべきリソースを持っていることを伝え、それらをどのようにリリースすべきかを定義します。

Tim は自分のクラスに IDisposable を追加し、メソッドを実装します：

public class DemoResource : IDisposable
{
    public void Dispose()
    {
        Console.WriteLine("Closing Connection via Dispose");
    }
}

public class DemoResource : IDisposable
{
    public void Dispose()
    {
        Console.WriteLine("Closing Connection via Dispose");
    }
}

Public Class DemoResource
    Implements IDisposable

    Public Sub Dispose() Implements IDisposable.Dispose
        Console.WriteLine("Closing Connection via Dispose")
    End Sub
End Class

Public Class DemoResource
    Implements IDisposable

    Public Sub Dispose() Implements IDisposable.Dispose
        Console.WriteLine("Closing Connection via Dispose")
    End Sub
End Class

Disposeメソッドは、管理されていないメモリの解放、ファイルハンドルのクローズ、データベース接続の解放など、リソースのクリーンアップ専用の場所として機能します。

Timは、このDisposeメソッドはusingステートメントを使用して自動的に呼び出すことができ、例外が発生した場合でも確実にクリーンアップが行われることを説明しています。

ステートメントと決定論的クリーンアップを使用する

Timは、C#ではusingが2つの異なる意味になることを明らかにしています：

Using ディレクティブ - ファイルの先頭（例：using System;)
使用ステートメント - リソースのクリーンアップ用

彼は後者を実演しています：

using DemoResource demo = new DemoResource();
demo.DoWork();

using DemoResource demo = new DemoResource();
demo.DoWork();

Using demo As New DemoResource()
    demo.DoWork()
End Using

Using demo As New DemoResource()
    demo.DoWork()
End Using

このステートメントのスコープが終了すると、コンパイラは自動的にDisposeメソッドを呼び出します。これは、決定論的なクリーンアップを保証します。つまり、リソースは、ガベージコレクタが後でオブジェクトをファイナライズするのを待つのではなく、使用後すぐに解放されます。

このアプローチは、すべての使い捨てオブジェクトが適切なタイミングで適切に廃棄されるようにすることで、アプリケーションの安定性とメモリ使用効率を高めます。

例外が発生したときに起こること

ティムは例外を再紹介し、デモを再実行します。例外によって通常のフローが中断されても、Dispose()が呼び出されていることが出力からわかります：

Opening Connection
Doing Work
I broke
Closing Connection via Dispose

Opening Connection
Doing Work
I broke
Closing Connection via Dispose

Opening Connection
Doing Work
I broke
Closing Connection via Dispose

Opening Connection
Doing Work
I broke
Closing Connection via Dispose

これは、usingブロックが失敗の際にもクリーンアップを保証することを示しています。これは、finallyブロックの中にクリーンアップ・ロジックを配置することに相当しますが、よりクリーンで読みやすくなります。

これは、C# IDisposable パターンの威力です。IDisposable パターンは、コードのあらゆる部分で手動によるクリーンアップを必要とすることなく、管理対象または非管理対象のリソースが適切に解放されるようにします。

使用する範囲とディスポが呼び出されるタイミング

ティムは次に、スコープが廃棄のタイミングにどのように影響するかを探ります。 using宣言が終了すると、コンパイラは自動的にDispose()の呼び出しを挿入します。

彼は、次のような別の行を置くと、次のようになることを示しています：

Console.WriteLine("I'm done running Program.cs");

Console.WriteLine("I'm done running Program.cs");

Console.WriteLine("I'm done running Program.cs")

Console.WriteLine("I'm done running Program.cs")

現在のスコープが終了するとき（メソッドの終了など）に廃棄が行われるためです。

廃棄をより早く行うために、Timはコードをusingブロックで囲んでいます：

using (DemoResource demo = new DemoResource())
{
    demo.DoWork();
}
Console.WriteLine("I'm done running Program.cs");

using (DemoResource demo = new DemoResource())
{
    demo.DoWork();
}
Console.WriteLine("I'm done running Program.cs");

Using demo As New DemoResource()
    demo.DoWork()
End Using
Console.WriteLine("I'm done running Program.cs")

Using demo As New DemoResource()
    demo.DoWork()
End Using
Console.WriteLine("I'm done running Program.cs")

現在、Disposeメソッドは、ブロックの最後でオブジェクトがスコープ外になるため、最後のprint文の前に実行されます。

これは、コードブロックが実行を終了したときにリソースが直ちに解放されることを保証する、決定論的なリソースのクリーンアップを示しています。

完全な破棄パターン (拡張概念)

Timのデモは基本に重点を置いていますが、本番コードで使用される完全なC# Disposeパターンに自然につながります。このパターンは、マネージド・リソースとアンマネージド・リソースの両方の安全なクリーンアップを可能にし、継承をサポートし、二重のクリーンアップを回避します。このパターンは通常次のようになります：

public class BaseResource : IDisposable
{
    private bool disposed = false; // To detect redundant calls

    // Public dispose method
    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(this);
    }

    // Protected virtual dispose method
    protected virtual void Dispose(bool disposing)
    {
        if (!disposed)
        {
            if (disposing)
            {
                // Dispose managed resources here
            }

            // Free unmanaged resources here
            disposed = true;
        }
    }
}

public class BaseResource : IDisposable
{
    private bool disposed = false; // To detect redundant calls

    // Public dispose method
    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(this);
    }

    // Protected virtual dispose method
    protected virtual void Dispose(bool disposing)
    {
        if (!disposed)
        {
            if (disposing)
            {
                // Dispose managed resources here
            }

            // Free unmanaged resources here
            disposed = true;
        }
    }
}

Public Class BaseResource
    Implements IDisposable

    Private disposed As Boolean = False ' To detect redundant calls

    ' Public dispose method
    Public Sub Dispose() Implements IDisposable.Dispose
        Dispose(True)
        GC.SuppressFinalize(Me)
    End Sub

    ' Protected virtual dispose method
    Protected Overridable Sub Dispose(disposing As Boolean)
        If Not disposed Then
            If disposing Then
                ' Dispose managed resources here
            End If

            ' Free unmanaged resources here
            disposed = True
        End If
    End Sub
End Class

Public Class BaseResource
    Implements IDisposable

    Private disposed As Boolean = False ' To detect redundant calls

    ' Public dispose method
    Public Sub Dispose() Implements IDisposable.Dispose
        Dispose(True)
        GC.SuppressFinalize(Me)
    End Sub

    ' Protected virtual dispose method
    Protected Overridable Sub Dispose(disposing As Boolean)
        If Not disposed Then
            If disposing Then
                ' Dispose managed resources here
            End If

            ' Free unmanaged resources here
            disposed = True
        End If
    End Sub
End Class

以下がその内容です：

Dispose(boolディスポーズ)は、管理オブジェクトのディスポーズ(ディスポーズがtrueの場合)と、管理されていないリソースの解放(常に必要)を区別します。
disposingパラメータは、ガベージコレクタがすでにオブジェクトを回収している可能性がある最終化時に、管理オブジェクトを破棄しないようにします。
GC.SuppressFinalize(this)は、手動による廃棄が完了すると、ガベージコレクタがファイナライザを呼び出さないようにします。
protected virtual void Dispose(bool disposing) は、派生クラスがカスケード・ディスポ呼び出しのために protected override void Dispose(bool disposing) を使用してディスポ動作をオーバーライドできるようにします。

これは、効率的なリソース管理を保証し、リソースリークを防止し、管理されたリソースと管理されていないリソースの両方に対して安全なクリーンアップロジックを提供します。

なぜ適切なクリーンアップが重要なのか

Timの例では、Disposeパターンを正しく実装することの重要性を強調しています。データベース接続を閉じるだけでなく、管理されていないメモリ、ファイルハンドル、システムリソースを優雅に処理することも重要です。 IDisposableを実装し、using文でオブジェクトをラップすることで、以下のことが保証されます：