CA1812: Evitar classes internas sem instâncias

Causa

Um tipo interno (nível de assembly) nunca é instanciado.

Descrição da regra

Essa regra tentará localizar uma chamada para um dos construtores do tipo e relatará uma violação se nenhuma chamada for localizada.

Os seguintes tipos não são examinados por essa regra:

• Tipos de valor
• Tipos abstratos
• Enumerações
• Delegados
• Tipos de matriz emitidos pelo compilador
• Os tipos em que não é possível criar uma instância e que definem apenas métodos static.

Se você aplicar System.Runtime.CompilerServices.InternalsVisibleToAttribute ao assembly que está sendo analisado, essa regra não sinalizará os tipos marcados como internal (Friend no Visual Basic) por padrão porque um campo poderá ser utilizado por um assembly amigável. Para analisar o assembly mesmo assim, confira Configurar código para análise.

Como corrigir violações

Para corrigir uma violação dessa regra, remova o tipo ou adicione o código que o utiliza. Se o tipo contiver apenas os métodos static, adicione um modificador static ao tipo para impedir que o compilador emita um construtor de instância pública padrão.

Quando suprimir avisos

É seguro suprimir um aviso dessa regra. É recomendável suprimir esse aviso nas seguintes situações:

• A classe é criada por meio de métodos de reflexão de associação tardia como System.Activator.CreateInstance.

• A classe é registrada em um contêiner de IoC (inversão de controle) como parte do padrão de injeção de dependência.

• A classe é criada automaticamente pelo runtime ou ASP.NET. Alguns exemplos de classes criadas automaticamente são aqueles que implementam System.Configuration.IConfigurationSectionHandler ou System.Web.IHttpHandler.

• A classe é usada como um parâmetro de tipo em uma definição de classe e possui uma new restrição. O exemplo a seguir será sinalizado pela regra CA1812:

  internal class MyClass
  {
      public void DoSomething()
      {
      }
  }
  public class MyGeneric<T> where T : new()
  {
      public T Create()
      {
          return new T();
      }
  }
  
  MyGeneric<MyClass> mc = new MyGeneric<MyClass>();
  mc.Create();
  

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

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.CA1812.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.

• Ignorar o atributo InternalsVisibleTo

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 (Desempenho) às quais ela se aplica. Para saber mais, confira Opções de configuração de regra de qualidade de código.

Ignorar o atributo InternalsVisibleTo

Por padrão, essa regra será desabilitada se o assembly que está sendo analisado usar InternalsVisibleToAttribute para expor os símbolos internos. Para especificar que a regra deverá ser executada mesmo se o assembly estiver marcado com InternalsVisibleToAttribute, adicione o seguinte par chave-valor a um arquivo .editorconfig no seu projeto:

dotnet_code_quality.CAXXXX.ignore_internalsvisibleto = true

Esta opção está disponível desde o .NET 8.

Regras relacionadas

• CA1801: Examinar parâmetros não utilizados