Compartilhar via

CA1002: Não expor listas genéricas

  • Artigo
Property Valor
ID da regra CA1002
Título Não expor listas genéricas
Categoria Projetar
Correção interruptiva ou sem interrupção Quebra
Habilitado por padrão no .NET 8 Não

Causa

Um tipo contém um membro externamente visível que é um tipo System.Collections.Generic.List<T>, retorna um tipo List<T> ou cuja assinatura inclua um parâmetro List<T>.

Por padrão, essa regra apenas analisa os tipos visíveis externamente, mas isso é configurável.

Descrição da regra

System.Collections.Generic.List<T> é uma coleção genérica projetada para desempenho e não herança. List<T> não contém membros virtuais que facilitam a alteração do comportamento de uma classe herdada. As coleções genéricas a seguir são projetadas para herança e devem ser expostas em vez de List<T>.

Como corrigir violações

Para corrigir uma violação dessa regra, altere o tipo System.Collections.Generic.List<T> para uma das coleções genéricas projetadas para herança.

Quando suprimir avisos

Não suprima um aviso dessa regra, a menos que o assembly que gera esse aviso não se destine a ser uma biblioteca reutilizável. Por exemplo, seria seguro suprimir esse aviso em um aplicativo ajustado pelo desempenho em que um benefício de desempenho foi obtido com o uso de listas genéricas.

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

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

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

Configurar código para analisar

Use a opção a seguir para configurar em quais partes da base de código essa regra deve ser executada.

Você pode configurar essa opção apenas para essa regra, para todas as regras às quais ela se aplica ou para todas as regras nessa categoria (Design) às quais ela se aplica. Para saber mais, confira Opções de configuração de regra de qualidade de código.

Incluir superfícies de API específicas

É possível configurar em quais partes da base de código essa regra deverá ser executada, com base na acessibilidade. Por exemplo, para especificar que a regra deverá ser executada apenas na superfície de API não pública, adicione o seguinte par chave-valor a um arquivo .editorconfig no projeto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

CA1005: Evitar parâmetros excessivos em tipos genéricos

CA1010: Coleções devem implementar uma interface genérica

CA1000: Não declarar membros estáticos em tipos genéricos

CA1003: Usar instâncias do manipulador de eventos genérico

Confira também

Genéricos