CA2215: Dispose-Methoden müssen die Dispose-Funktion der Basisklasse aufrufen.
Eigenschaft | Wert |
---|---|
Regel-ID | CA2215 |
Titel | Dispose-Methoden müssen die Dispose-Funktion der Basisklasse aufrufen. |
Kategorie | Verwendung |
Fix führt oder führt nicht zur Unterbrechung | Nicht unterbrechend |
Standardmäßig in .NET 9 aktiviert | No |
Ursache
Ein Typ, der System.IDisposable implementiert, erbt von einem Typ, der auch IDisposable implementiert. Die Dispose-Methode des erbenden Typs ruft nicht die Dispose-Methode des übergeordneten Typs auf.
Regelbeschreibung
Wenn ein Typ von einem verwerfbaren Typ erbt, muss er über seine eigene Dispose-Methode die Dispose-Methode des Basistyps aufrufen. Durch Aufrufen der Dispose
-Methode des Basistyps wird sichergestellt, dass alle vom Basistyp erstellten Ressourcen freigegeben werden.
Behandeln von Verstößen
Um einen Verstoß gegen diese Regel zu beheben, rufen Sie base
.Dispose in Ihrer Dispose-Methode auf.
Wann sollten Warnungen unterdrückt werden?
Wenn der Aufruf an base
.Dispose auf einer tieferen Aufrufebene als die Regelüberprüfung erfolgt, können Sie eine Warnung für diese Regel sicher unterdrücken.
Unterdrücken einer Warnung
Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.
#pragma warning disable CA2215
// The code that's violating the rule is on this line.
#pragma warning restore CA2215
Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none
fest.
[*.{cs,vb}]
dotnet_diagnostic.CA2215.severity = none
Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.
Beispiel
Im folgenden Beispiel werden zwei Typen gezeigt: TypeA
zur Implementierung von IDisposable und TypeB
, der von TypeA
erbt und dessen Dispose-Methode ordnungsgemäß aufruft.
Namespace ca2215
Public Class TypeA
Implements IDisposable
Protected Overridable Overloads Sub Dispose(disposing As Boolean)
If disposing Then
' dispose managed resources
End If
' free native resources
End Sub
Public Overloads Sub Dispose() Implements IDisposable.Dispose
Dispose(True)
GC.SuppressFinalize(Me)
End Sub
' Disposable types implement a finalizer.
Protected Overrides Sub Finalize()
Dispose(False)
MyBase.Finalize()
End Sub
End Class
Public Class TypeB
Inherits TypeA
Protected Overrides Sub Dispose(disposing As Boolean)
If Not disposing Then
MyBase.Dispose(False)
End If
End Sub
End Class
End Namespace
using System;
namespace ca2215
{
public class TypeA : IDisposable
{
protected virtual void Dispose(bool disposing)
{
if (disposing)
{
// Dispose managed resources
}
// Free native resources
}
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
// Disposable types implement a finalizer.
~TypeA()
{
Dispose(false);
}
}
public class TypeB : TypeA
{
protected override void Dispose(bool disposing)
{
if (!disposing)
{
base.Dispose(false);
}
}
}
}