CA1868: Unnötiger Aufruf von „Contains“ für Sets

Artikel
12/18/2023

Eigenschaft	Wert
Regel-ID	CA1868
Titel	Unnötiger Aufruf von „Contains“ für Sets
Kategorie	Leistung
Fix führt oder führt nicht zur Unterbrechung	Nicht unterbrechend
Standardmäßig in .NET 9 aktiviert	Als Vorschlag

Ursache

Ein ISet<T>.Add- oder ICollection<T>.Remove-Aufruf wird durch einen Aufruf von Contains geschützt. Oder ein IImmutableSet<T>.Add- oder IImmutableSet<T>.Remove-Aufruf wird durch einen Aufruf von IImmutableSet<T>.Contains geschützt.

Regelbeschreibung

Sowohl ISet<T>.Add(T) wie auch ICollection<T>.Remove(T) führen ein Lookup durch, der es überflüssig macht, vorher ICollection<T>.Contains(T) aufzurufen. Es ist effizienter, Add(T) oder Remove(T) direkt aufzurufen, wodurch ein boolescher Wert zurückgegeben wird, der angibt, ob das Element hinzugefügt oder entfernt wurde.

Diese Logik gilt auch für IImmutableSet<T>.Add(T) und IImmutableSet<T>.Remove(T), mit der Ausnahme, dass sie entweder ein neues Set zurückgeben, wenn das Element hinzugefügt oder entfernt wird, oder das ursprüngliche Set, falls dies nicht der Fall war.

Behandeln von Verstößen

Ersetzen Sie den Aufruf von ICollection<T>.Contains(T) (oder IImmutableSet<T>.Contains(T)), gefolgt von einem Aufruf von ISet<T>.Add(T) oder ICollection<T>.Remove(T) (oder IImmutableSet<T>.Add(T) oder IImmutableSet<T>.Remove(T)) durch einen einzelnen Aufruf der letztgenannten Methode.

Beispiel

Der folgende Codeschnipsel zeigt einen Verstoß gegen CA1868:

void Run(ISet<string> set)
{
    if (!set.Contains("Hello World"))
    {
        set.Add("Hello World");
    }
}

Sub Run(set As ISet(Of String))
    If Not set.Contains("Hello World") Then
        set.Add("Hello World")
    End If
End Sub

Der folgende Codeausschnitt korrigiert die Verletzung:

void Run(ISet<string> set)
{
    set.Add("Hello World");
}

Sub Run(set As ISet(Of String))
    set.Add("Hello World")
End Sub

Wann sollten Warnungen unterdrückt werden?

Es ist ungefährlich, diese Warnung zu unterdrücken, wenn die Leistung kein Problem ist.

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 CA1868
// The code that's violating the rule is on this line.
#pragma warning restore CA1868

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.CA1868.severity = none

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Freigeben über