CA1512: Usar o auxiliar de lançamento ArgumentOutOfRangeException

Artigo
12/16/2023

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

Motivo

O código verifica se um argumento é menor ou maior do que um determinado valor e, em seguida, condicionalmente lança um ArgumentOutOfRangeException.

Descrição da regra

As verificações de argumento 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 ArgumentOutOfRangeException.ThrowIfGreaterThan são mais simples e eficientes do if que blocos que constroem uma nova instância de exceção.

Exemplo

O trecho de código a seguir mostra violações do CA1512:

void M(int arg)
{
    if (arg is 0)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg < 0)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg <= 0)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg <= 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg < 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg > 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg >= 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg == 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg != 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
}

O trecho de código a seguir mostra as correções:

void M(int arg)
{
    ArgumentOutOfRangeException.ThrowIfZero(arg);
    ArgumentOutOfRangeException.ThrowIfNegative(arg);
    ArgumentOutOfRangeException.ThrowIfNegativeOrZero(arg);
    ArgumentOutOfRangeException.ThrowIfLessThanOrEqual(arg, 42);
    ArgumentOutOfRangeException.ThrowIfLessThan(arg, 42);
    ArgumentOutOfRangeException.ThrowIfGreaterThan(arg, 42);
    ArgumentOutOfRangeException.ThrowIfGreaterThanOrEqual(arg, 42);
    ArgumentOutOfRangeException.ThrowIfEqual(arg, 42);
    ArgumentOutOfRangeException.ThrowIfNotEqual(arg, 42);
}

Como corrigir violações

Substitua o if bloco que lança a exceção por uma chamada para um dos seguintes métodos throw-helper:

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

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

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

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

Partilhar via