CA1864: Bevorzugen Sie die Methode „IDictionary.TryAdd(TKey, TValue)“

Artikel
12/18/2023

Eigenschaft	Wert
Regel-ID	CA1864
Titel	Bevorzugen Sie die Methode „IDictionary.TryAdd(TKey, TValue)“
Kategorie	Leistung
Fix führt oder führt nicht zur Unterbrechung	Nicht unterbrechend
Standardmäßig in .NET 8 aktiviert	Als Vorschlag

Ursache

Dictionary<TKey,TValue>.Add wird durch einen Dictionary<TKey,TValue>.ContainsKey(TKey)-Aufruf bewacht.

Regelbeschreibung

Sowohl Dictionary<TKey,TValue>.ContainsKey(TKey) als auch Dictionary<TKey,TValue>.Add führen ein redundantes Lookup durch. Dictionary<TKey,TValue>.Add löst auch eine Ausnahme aus, wenn der Schlüssel bereits im Wörterbuch vorhanden ist. Es ist effizienter, Dictionary<TKey,TValue>.TryAdd aufzurufen, was einen booleschen Wert zurückgibt, der angibt, ob der Wert hinzugefügt wurde oder nicht. TryAdd überschreibt den Wert des Schlüssels nicht, wenn der Schlüssel bereits vorhanden ist.

Behandeln von Verstößen

Ersetzen Sie einen Aufruf von Dictionary<TKey,TValue>.ContainsKey(TKey) dem ein Aufruf von Dictionary<TKey,TValue>.Add gefolgt ist, durch einen einzelnen Aufruf von Dictionary<TKey,TValue>.TryAdd.

Beispiel

Der folgende Codeschnipsel zeigt einen Verstoß gegen CA1864:

void Run(IDictionary<int, string> dictionary)
{
    if(!dictionary.ContainsKey(2)) {
        dictionary.Add(2, "Hello World");
    }
}

Sub Run(dictionary As IDictionary(Of Integer, String))
    If Not dictionary.ContainsKey(2) Then
        dictionary.Add(2, "Hello World")
    End If
End Sub

Der folgende Codeausschnitt korrigiert die Verletzung:

void Run(IDictionary<int, string> dictionary)
{
    dictionary.TryAdd(2, "Hello World");
}

Sub Run(dictionary As IDictionary(Of Integer, String))
    dictionary.TryAdd(2, "Hello World")
End Sub

Wann sollten Warnungen unterdrückt werden?

Es ist sicher, diese Warnung zu unterdrücken, wenn die Leistung keine Rolle spielt und wenn Sie die Ausnahme, die von Dictionary<TKey,TValue>.Add ausgelöst werden könnte, behandeln.

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

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

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

Freigeben über