CA1816:GC.SuppressFinalize を正しく呼び出します

  • [アーティクル]
プロパティ 値
ルール ID CA1816
Title GC.SuppressFinalize を正しく呼び出します
[カテゴリ] 使用方法
修正が中断ありか中断なしか なし
.NET 8 では既定で有効 提案として

原因

この規則の違反の原因として、次のことが考えられます。

規則の説明

IDisposable.Dispose メソッドにより、ユーザーはオブジェクトがガベージ コレクションで使用できるようになる前の任意の時点でリソースを解放できます。 IDisposable.Dispose メソッドが呼び出されると、オブジェクトのリソースが解放されます。 これにより、終了処理は不要になります。 IDisposable.Dispose では GC.SuppressFinalize を呼び出して、ガベージ コレクターがオブジェクトのファイナライザーを呼び出さないようにする必要があります。

ファイナライザーがある派生型が IDisposable を再実装して呼び出さないようにするために、ファイナライザーのないシールされた型でも GC.SuppressFinalize を呼び出す必要があります。

違反の修正方法

この規則の違反を修正するには:

どのようなときに警告を抑制するか

意図的に GC.SuppressFinalize を使用して他のオブジェクトの有効期間を制御している場合のみ、この規則による警告を抑制します。 Dispose の実装で GC.SuppressFinalize を呼び出さない場合は、この規則による警告を抑制しないでください。 この状況では、終了処理を抑制しないとパフォーマンスが低下し、利点がありません。

警告を抑制する

単一の違反を抑制するだけの場合は、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、規則をもう一度有効にします。

#pragma warning disable CA1816
// The code that's violating the rule is on this line.
#pragma warning restore CA1816

ファイル、フォルダー、またはプロジェクトの規則を無効にするには、構成ファイルでその重要度を none に設定します。

[*.{cs,vb}]
dotnet_diagnostic.CA1816.severity = none

詳細については、「コード分析の警告を抑制する方法」を参照してください。

CA1816 に違反する例

このコードは、GC.SuppressFinalize を呼び出すが、this (C#) または Me (Visual Basic) を渡さないメソッドを示しています。 その結果、このコードは規則 CA1816 に違反します。

Public Class DatabaseConnector
    Implements IDisposable

    Private _Connection As New SqlConnection

    Public Sub Dispose() Implements IDisposable.Dispose
        Dispose(True)
        ' Violates rules
        GC.SuppressFinalize(True)
    End Sub

    Protected Overridable Sub Dispose(ByVal disposing As Boolean)
        If disposing Then
            If _Connection IsNot Nothing Then
                _Connection.Dispose()
                _Connection = Nothing
            End If
        End If
    End Sub

End Class

public class DatabaseConnector : IDisposable
{
    private SqlConnection? _Connection = new SqlConnection();

    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(true);  // Violates rule
    }

    protected virtual void Dispose(bool disposing)
    {
        if (disposing)
        {
            if (_Connection != null)
            {
                _Connection.Dispose();
                _Connection = null;
            }
        }
    }
}

CA1816 を満たす例

この例は、GC.SuppressFinalize を this (C#) または Me (Visual Basic) を渡して正しく呼び出すメソッドを示しています。

Public Class DatabaseConnector
    Implements IDisposable

    Private _Connection As New SqlConnection

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

    Protected Overridable Sub Dispose(ByVal disposing As Boolean)
        If disposing Then
            If _Connection IsNot Nothing Then
                _Connection.Dispose()
                _Connection = Nothing
            End If
        End If
    End Sub

End Class

public class DatabaseConnector : IDisposable
{
    private SqlConnection? _Connection = new SqlConnection();

    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(this);
    }

    protected virtual void Dispose(bool disposing)
    {
        if (disposing)
        {
            if (_Connection != null)
            {
                _Connection.Dispose();
                _Connection = null;
            }
        }
    }
}

関連項目