CA1512: ArgumentOutOfRangeException throw ヘルパーを使用する

プロパティ	値
ルール ID	CA1512
Title	ArgumentOutOfRangeException throw ヘルパーを使用する
カテゴリ	保守容易性
修正が中断ありか中断なしか	中断なし
.NET 9 では既定で有効	提案として

原因

引数が指定された値より小さいか大きいかがコードでチェックされ、条件付きで ArgumentOutOfRangeException がスローされています。

規則の説明

引数チェックはコード・サイズに大きな影響を及ぼし、小さな関数やプロパティ・セッターのコードを占有することがよくあります。 このようなチェックはインライン化を妨げ、かなりの命令キャッシュ汚染を引き起こします。 ArgumentOutOfRangeException.ThrowIfGreaterThan などのスロー・ヘルパー・メソッドは、新しい例外インスタンスを構築する if ブロックよりもシンプルで効率的です。

例

次のコード スニペットは、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 ブロックを、次のいずれかのスロー ヘルパー メソッドの呼び出しに置き換えます。

• ArgumentOutOfRangeException.ThrowIfZero<T>(T, String)
• ArgumentOutOfRangeException.ThrowIfNegative<T>(T, String)
• ArgumentOutOfRangeException.ThrowIfNegativeOrZero<T>(T, String)
• ArgumentOutOfRangeException.ThrowIfLessThanOrEqual<T>(T, T, String)
• ArgumentOutOfRangeException.ThrowIfLessThan<T>(T, T, String)
• ArgumentOutOfRangeException.ThrowIfGreaterThanOrEqual<T>(T, T, String)
• ArgumentOutOfRangeException.ThrowIfGreaterThan<T>(T, T, String)
• ArgumentOutOfRangeException.ThrowIfEqual<T>(T, T, String)
• ArgumentOutOfRangeException.ThrowIfNotEqual<T>(T, T, String)

または、Visual Studio で Lightbulb メニューを使用して、コードを自動的に修正します。

どのようなときに警告を抑制するか

コードの保守性が懸念されない場合は、この規則違反を抑制しても問題ありません。 また、擬陽性であると識別された違反を抑制することもできます。

警告を抑制する

単一の違反を抑制するだけの場合は、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、規則をもう一度有効にします。

#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

詳細については、「コード分析の警告を抑制する方法」を参照してください。