Freigeben über

CA1854: Bevorzugen der Methode IDictionary.TryGetValue(TKey, out TValue)

  • Artikel
Eigenschaft Wert
Regel-ID CA1854
Titel Bevorzugen der IDictionary.TryGetValue(TKey, out TValue) Methode
Kategorie Leistung
Fix führt oder führt nicht zur Unterbrechung Nicht unterbrechend
Standardmäßig in .NET 9 aktiviert Als Vorschlag

Ursache

Ein IDictionary-Elementzugriff, der durch eine IDictionary.ContainsKey-Überprüfung geschützt wird.

Regelbeschreibung

Wenn auf ein Element eines IDictionary zugegriffen wird, überprüft die Indexerimplementierung auf einen Null-Wert, indem die IDictionary.ContainsKey-Methode aufgerufen wird. Wenn Sie IDictionary.ContainsKey auch in einer if-Klausel aufrufen, um das Nachschlagen eines Werts zu schützen, werden zwei Nachschlagevorgänge ausgeführt, wenn nur einer benötigt wird.

Behandeln von Verstößen

Ersetzen Sie den IDictionary.ContainsKey-Aufruf und Elementzugriff durch einen Aufruf der IDictionary.TryGetValue-Methode.

Verstoß:

public string? GetValue(string key)
{
    if (_dictionary.ContainsKey(key))
    {
        return _dictionary[key];
    }

    return null;
}

Public Function GetValue(key As String) As String
    If _dictionary.ContainsKey(key) Then
        Return _dictionary(key)
    End If

    Return Nothing
End Function

Korrektur:

public string? GetValue(string key)
{
    if (_dictionary.TryGetValue(key, out string? value))
    {
        return value;
    }

    return null;
}

Public Function GetValue(key As String) As String
    Dim value as String

    If _dictionary.TryGetValue(key, value) Then
        Return value
    End If

    Return Nothing
End Function

Wann sollten Warnungen unterdrückt werden?

Diese Warnung können Sie gefahrlos unterdrücken, wenn Sie eine benutzerdefinierte Implementierung von IDictionary verwenden, die beim Durchführen der IDictionary.ContainsKey-Überprüfung das Nachschlagen eines Werts vermeidet.

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

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

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