CA1828:如果可以使用 AnyAsync,请勿使用 CountAsync/LongCountAsync

属性
规则 ID CA1828
标题 如果可以使用 AnyAsync,请勿使用 CountAsync/LongCountAsync
类别 “性能”
修复是中断修复还是非中断修复 非中断
在 .NET 9 中默认启用 作为建议

原因

在使用 AnyAsync 方法会更有效的情况下使用了 CountAsyncLongCountAsync 方法。

规则说明

此规则将标记 CountAsyncLongCountAsync LINQ 方法调用,用于检查集合是否至少有一个元素。 这些方法调用需要枚举整个集合来计算计数。 使用 AnyAsync 方法进行相同的检查速度更快,因为它可以避免枚举集合。

如何解决冲突

若要解决冲突,请将 CountAsyncLongCountAsync 方法调用替换为 AnyAsync 方法。 例如,以下两个代码片段显示了规则冲突及其解决方法:

using System.Linq;
using System.Threading.Tasks;
using static Microsoft.EntityFrameworkCore.EntityFrameworkQueryableExtensions;

class C
{
    public async Task<string> M1Async(IQueryable<string> list)
        => await list.CountAsync() != 0 ? "Not empty" : "Empty";

    public async Task<string> M2Async(IQueryable<string> list)
        => await list.LongCountAsync() > 0 ? "Not empty" : "Empty";
}
using System.Linq;
using System.Threading.Tasks;
using static Microsoft.EntityFrameworkCore.EntityFrameworkQueryableExtensions;

class C
{
    public async Task<string> M1Async(IQueryable<string> list)
        => await list.AnyAsync() ? "Not empty" : "Empty";

    public async Task<string> M2Async(IQueryable<string> list)
        => await list.AnyAsync() ? "Not empty" : "Empty";
}

提示

Visual Studio 中为此规则提供了代码修补程序。 若要使用它,请将光标置于冲突上,然后按“Ctrl+.”(句点)。 从显示的选项列表中,选择“如果可以使用 AnyAsync(),请勿使用 CountAsync() 或 LongCountAsync()”。

“CA1828 - 如果可以使用 AnyAsync(),请勿使用 CountAsync() 或 LongCountAsync()”的代码修复

何时禁止显示警告

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

抑制警告

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

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

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

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

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

另请参阅