Partilhar via

CA1854: Prefira o IDictionary.TryGetValue(TKey, out TValue) método

  • Artigo
Property valor
ID da regra CA1854
Título Prefira o IDictionary.TryGetValue(TKey, out TValue) método
Categoria Desempenho
A correção está quebrando ou não quebrando Sem quebra
Habilitado por padrão no .NET 8 Como sugestão

Motivo

Um IDictionary acesso de elemento que é protegido por uma IDictionary.ContainsKey verificação.

Descrição da regra

Quando um elemento de um é acessado, a implementação do indexador verifica um IDictionary valor nulo chamando o IDictionary.ContainsKey método. Se você também chamar IDictionary.ContainsKey uma cláusula para proteger uma pesquisa de valor, duas pesquisas serão realizadas quando apenas uma if for necessária.

Como corrigir violações

Substitua a invocação e o acesso ao elemento por uma chamada para o IDictionary.ContainsKeyIDictionary.TryGetValue método.

Violação:

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

Correção:

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

Quando suprimir avisos

É seguro suprimir esse aviso se você estiver usando uma implementação personalizada que evite uma pesquisa de IDictionary valor ao executar a IDictionary.ContainsKey verificação.

Suprimir um aviso

Se você quiser apenas suprimir uma única violação, adicione diretivas de pré-processador ao seu arquivo de origem para desativar e, em seguida, reativar a regra.

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

Para desabilitar a regra para um arquivo, pasta ou projeto, defina sua severidade como none no arquivo de configuração.

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

Para obter mais informações, consulte Como suprimir avisos de análise de código.