CA1841: preferir métodos que contêm dicionário
Property | Valor |
---|---|
ID da regra | CA1841 |
Título | Preferir o Dicionário que Contenha métodos |
Categoria | Desempenho |
Correção interruptiva ou sem interrupção | Sem interrupção |
Habilitado por padrão no .NET 8 | Como sugestão |
Causa
Essa regra localiza chamadas para um método Contains
na coleção Keys
ou Values
de um IDictionary<TKey,TValue> que pode ser substituído por uma chamada a um método ContainsKey
ou ContainsValue
no próprio dicionário.
Descrição da regra
Chamar Contains
na coleção Keys
ou Values
pode ser mais caro do que chamar ContainsKey
ou ContainsValue
no próprio dicionário:
- Muitas implementações de dicionário instanciam de forma lenta coleções de chave e valor, o que significa que acessar a coleção
Keys
ouValues
pode resultar em alocações extras. - Você pode acabar chamando um método de extensão em IEnumerable<T> se a coleção de chaves ou valores usar a implementação explícita da interface para ocultar métodos em ICollection<T>. Isso pode levar a um desempenho reduzido, especialmente ao acessar a coleção de chaves. A maioria das implementações de dicionário é capaz de fornecer uma verificação rápida de contenção de O(1) para chaves, enquanto o método de extensão
Contains
em IEnumerable<T> geralmente faz uma verificação de contenção O(n) lenta.
Como corrigir violações
Para corrigir violações, substitua chamadas para dictionary.Keys.Contains
ou dictionary.Values.Contains
por chamadas para dictionary.ContainsKey
ou dictionary.ContainsValue
, respectivamente.
O snippet de código a seguir mostra exemplos de violações e como corrigi-las.
using System.Collections.Generic;
// Importing this namespace brings extension methods for IEnumerable<T> into scope.
using System.Linq;
class Example
{
void Method()
{
var dictionary = new Dictionary<string, int>();
// Violation
dictionary.Keys.Contains("hello world");
// Fixed
dictionary.ContainsKey("hello world");
// Violation
dictionary.Values.Contains(17);
// Fixed
dictionary.ContainsValue(17);
}
}
Imports System.Collection.Generic
' Importing this namespace brings extension methods for IEnumerable(Of T) into scope.
' Note that in Visual Basic, this namespace is often imported automatically throughout the project.
Imports System.Linq
Class Example
Private Sub Method()
Dim dictionary = New Dictionary(Of String, Of Integer)
' Violation
dictionary.Keys.Contains("hello world")
' Fixed
dictionary.ContainsKey("hello world")
' Violation
dictionary.Values.Contains(17)
' Fixed
dictionary.ContainsValue(17)
End Sub
End Class
Quando suprimir avisos
É seguro suprimir avisos dessa regra se o código em questão não for crítico para o desempenho.
Suprimir um aviso
Para suprimir apenas uma violação, adicione diretivas de pré-processador ao arquivo de origem a fim de desabilitar e, em seguida, reabilitar a regra.
#pragma warning disable CA1841
// The code that's violating the rule is on this line.
#pragma warning restore CA1841
Para desabilitar a regra em um arquivo, uma pasta ou um projeto, defina a severidade como none
no arquivo de configuração.
[*.{cs,vb}]
dotnet_diagnostic.CA1841.severity = none
Para obter mais informações, confira Como suprimir avisos de análise de código.