CA1829:使用 Length/Count 属性,而不是 Enumerable.Count 方法

属性
规则 ID CA1829
标题 使用 Length/Count 属性,而不是 Enumerable.Count 方法
类别 “性能”
修复是中断修复还是非中断修复 非中断
在 .NET 9 中默认启用 作为建议

原因

对支持等效且更高效的 LengthCount 属性的类型使用了 Count LINQ 方法。

规则说明

此规则在具有等效但更高效的 LengthCount 属性以提取相同数据的类型的集合上标记 Count LINQ 方法调用。 LengthCount 属性不枚举集合,因此更高效。

此规则标记具有 Length 属性的以下集合类型上的 Count 调用:

此规则标记具有 Count 属性的以下集合类型上的 Count 调用:

分析后的集合类型可能会在将来扩展,以涵盖更多的情况。

如何解决冲突

若要解决冲突,请将 Count 方法调用替换为使用 LengthCount 属性访问。 例如,以下两个代码片段显示了规则冲突及其解决方法:

using System.Collections.Generic;
using System.Linq;

class C
{
    public int GetCount(int[] array)
        => array.Count();

    public int GetCount(ICollection<int> collection)
        => collection.Count();
}
using System.Collections.Generic;

class C
{
    public int GetCount(int[] array)
        => array.Length;

    public int GetCount(ICollection<int> collection)
        => collection.Count;
}

提示

Visual Studio 中为此规则提供了代码修补程序。 若要使用它,请将光标置于冲突上,然后按“Ctrl+.(句点)”。 从显示的选项列表中选择“在可用时使用 Length/Count 属性,而不是 Count()”。

CA1829 的代码修补程序 - 在可用时使用 Length/Count 属性而不是 Count()

何时禁止显示警告

如果不关心不必要的集合枚举计算计数对性能产生的影响,则可禁止显示此规则的冲突警告。

抑制警告

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

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

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

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

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

另请参阅