CA1861：避免将常量数组用作参数

  • 项目
属性 值
规则 ID CA1861
标题 避免将常量数组用作参数
类别 “性能”
修复是中断修复还是非中断修复 非中断
在 .NET 8 中默认启用 作为建议

原因

文本值的常量数组通过常规调用或扩展方法调用传递给方法。

规则说明

重复调用时，不会重复使用作为参数传递的常量数组，这意味着每次都会创建一个新数组。 如果传递的数组在调用的方法中未发生改变，请考虑将其提取到 static readonly 字段以提高性能。

注意

如果调用的方法使传递的数组发生改变，或者不确定该方法是否会改变数组，请不要将数组提取到 static readonly 字段。 这样做可能会导致中断性变更。 在这种情况下，最好改为禁止显示警告。

如何解决冲突

如果在调用的方法中传递的数组未发生改变，则将常量数组提取到 static readonly 字段。

以下示例显示了规则的冲突：

// A method argument
string message = string.Join(" ", new[] { "Hello", "world!" });

' A method argument
Dim message As String = String.Join(" ", {"Hello", "world!"})

以下示例显示了如何通过将参数提取到 static readonly 字段来修复此规则的冲突。

private static readonly string[] array = new[] { "Hello" , "world!" };

private string GetMessage()
{
    return string.Join(" ", array);
}

Private Shared ReadOnly array As String() = {"Hello", "world!"}

Private Function GetMessage() As String
    Return String.Join(" ", array)
End Function

现在，数组的值是在编译时（而不是在运行时）解析的，这使得代码的性能更佳。

何时禁止显示警告

如果出现以下情况，则禁止违反此规则：

  • 调用仅运行一次。
  • 数组可能会在调用的方法中发生改变，或者你不确定它是否会发生改变。
  • 你并不关心为每个调用创建常量数组对性能的影响。

抑制警告

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

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

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

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

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