通过

CA1512：使用 ArgumentOutOfRangeException 引发帮助程序

  • 项目
属性 值
规则 ID CA1512
标题 使用 ArgumentOutOfRangeException 引发帮助程序
类别 可维护性
修复是中断修复还是非中断修复 非中断
在 .NET 8 中默认启用 作为建议

原因

代码检查参数是小于还是大于给定值，然后有条件地引发 ArgumentOutOfRangeException。

规则说明

参数检查对代码大小有重大影响，并且通常支配着小型函数和属性资源库的代码。 这些检查会阻止内联，并造成重大的指令缓存污染。 与构造新异常实例的 if 块相比，ArgumentOutOfRangeException.ThrowIfGreaterThan 等引发帮助程序方法更简单高效。

示例

以下代码片段显示了违反 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));
}

以下代码片段显示了修复方法：

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);
}

如何解决冲突

将引发异常的 if 块替换为对以下引发帮助程序方法之一的调用：

或者，在 Visual Studio 中，使用灯泡菜单自动修复代码。

何时禁止显示警告

如果不在乎代码的可维护性，可安全地禁止显示此规则的冲突。 还可以禁止显示标识为误报的冲突。

抑制警告

如果只想抑制单个冲突，请将预处理器指令添加到源文件以禁用该规则，然后重新启用该规则。

#pragma warning disable CA1512
// The code that's violating the rule is on this line.
#pragma warning restore CA1512

若要对文件、文件夹或项目禁用该规则，请在配置文件中将其严重性设置为 none。

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

有关详细信息，请参阅如何禁止显示代码分析警告。