CA2216:破棄可能な型はファイナライザーを宣言しなければなりません

  • [アーティクル]
プロパティ 値
ルール ID CA2216
Title 破棄可能な型はファイナライザーを宣言しなければなりません
[カテゴリ] 使用方法
修正が中断ありか中断なしか なし
.NET 8 では既定で有効 いいえ

原因

System.IDisposable を実装し、アンマネージド リソースの使用を提案するフィールドが含まれる型が、System.Object.Finalize で記述されているようにファイナライザーを実装していません。

規則の説明

この規則の違反は、破棄できる型に次の型のフィールドが含まれている場合に報告されます。

違反の修正方法

この規則違反を修正するには、Dispose メソッドを呼び出すファイナライザーを実装します。

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

アンマネージド リソースを解放する目的でこの型で IDisposable を実装することがないのであれば、この規則からの警告を抑制しても問題ありません。

警告を抑制する

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

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

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

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

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

例

次の例からは、この規則に違反する型を確認できます。

public class DisposeMissingFinalize : IDisposable
{
    private bool disposed = false;
    private IntPtr unmanagedResource;

    [DllImport("native.dll")]
    private static extern IntPtr AllocateUnmanagedResource();

    [DllImport("native.dll")]
    private static extern void FreeUnmanagedResource(IntPtr p);

    DisposeMissingFinalize()
    {
        unmanagedResource = AllocateUnmanagedResource();
    }

    protected virtual void Dispose(bool disposing)
    {
        if (!disposed)
        {
            // Dispose of resources held by this instance.
            FreeUnmanagedResource(unmanagedResource);
            disposed = true;

            // Suppress finalization of this disposed instance.
            if (disposing)
            {
                GC.SuppressFinalize(this);
            }
        }
    }

    public void Dispose()
    {
        Dispose(true);
    }

    // Disposable types with unmanaged resources implement a finalizer.
    // Uncomment the following code to satisfy rule:
    //  DisposableTypesShouldDeclareFinalizer
    // ~TypeA()
    // {
    //     Dispose(false);
    // }
}

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

こちらもご覧ください