CA1871:請勿將可為 Null 的結構傳遞至 'ArgumentNullException.ThrowIfNull'

屬性
規則識別碼 CA1871
職稱 請勿將可為 Null 的結構傳遞至 'ArgumentNullException.ThrowIfNull'
類別 效能
修正程式是中斷或非中斷 不中斷
預設在 .NET 9 中啟用 作為資訊

原因

當可為 Null 的結構,例如 int?Guid?傳遞至 ArgumentNullException.ThrowIfNull時,會將其 Boxed 至 物件,因而造成效能損失。

檔案描述

為了改善效能,最好檢查 HasValue 屬性,並手動擲回例外狀況,而不是將可為 Null 的結構傳遞至 ArgumentNullException.ThrowIfNull

如何修正違規

檢查 Null 並手動擲回 ArgumentNullException

範例

下列代碼段顯示 CA1871 的違規:

static void Print(int? value)
{
    ArgumentNullException.ThrowIfNull(value);
    Console.WriteLine(value.Value);
}

下列代碼段會修正違規:

static void Print(int? value)
{
    if (!value.HasValue)
    {
        throw new ArgumentNullException(nameof(value));
    }

    Console.WriteLine(value.Value);
}

隱藏警告的時機

如果效能不相關,則隱藏此警告是安全的。

隱藏警告

如果您只想要隱藏單一違規,請將預處理器指示詞新增至原始程式檔以停用,然後重新啟用規則。

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

若要停用檔案、資料夾或項目的規則,請在組態檔中將其嚴重性設定為 。none

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

如需詳細資訊,請參閱 如何隱藏程式代碼分析警告