CA1513: Usar o auxiliar de lançamento ObjectDisposedException

Artigo
12/16/2023

Property	valor
ID da regra	CA1513
Título	Usar o auxiliar de lançamento ObjectDisposedException
Categoria	Manutenibilidade
A correção está quebrando ou não quebrando	Não-quebrando
Habilitado por padrão no .NET 8	Como sugestão

Motivo

O código verifica se um objeto é descartado e, em seguida, condicionalmente lança um ObjectDisposedExceptionarquivo .

Descrição da regra

As verificações de objetos têm um impacto substancial no tamanho do código e geralmente dominam o código para pequenas funções e setters de propriedade. Essas verificações evitam o inlining e causam poluição substancial do cache de instruções. Métodos auxiliares de lançamento, como ThrowIf são mais simples e eficientes do que blocos que constroem uma nova instância de if exceção.

Exemplo

O trecho de código a seguir mostra uma violação de CA1513:

class C
{
    private bool _disposed = false;
    void M()
    {
        if (_disposed)
            throw new ObjectDisposedException(GetType().Name);
    }
}

O trecho de código a seguir mostra a correção:

class C
{
    private bool _disposed = false;
    void M()
    {
        ObjectDisposedException.ThrowIf(_disposed, this);
    }
}

Como corrigir violações

Substitua o if bloco que lança a exceção por uma chamada para ThrowIf. Ou, no Visual Studio, use o menu de lâmpada para corrigir seu código automaticamente.

Quando suprimir avisos

É seguro suprimir uma violação dessa regra se você não estiver preocupado com a capacidade de manutenção do seu código. Também é bom suprimir violações que são identificadas como falsos positivos.

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

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

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

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

Partilhar via