CA1828:AnyAsync が使用できる場合は CountAsync/LongCountAsync を使用しません

  • [アーティクル]
プロパティ 値
ルール ID CA1828
Title AnyAsync が使用できる場合は CountAsync/LongCountAsync を使用しません
[カテゴリ] パフォーマンス
修正が中断ありか中断なしか なし
.NET 8 では既定で有効 提案として

原因

AnyAsync メソッドの方が効率的な状況で、CountAsync または LongCountAsync メソッドが使用されました。

規則の説明

この規則は、コレクションに少なくとも 1 つの要素があるかどうかを確認するために使用される CountAsync および LongCountAsync LINQ メソッド呼び出しにフラグを付けます。 これらのメソッド呼び出しでは、数を計算するためにコレクション全体を列挙する必要があります。 コレクションの列挙が回避される AnyAsync メソッドを使用すると、同じチェックが高速になります。

違反の修正方法

違反を修正するには、CountAsync または LongCountAsync メソッド呼び出しを AnyAsync メソッドに置き換えます。 たとえば、次の 2 つのコード スニペットは、規則違反とその修正方法を示しています。

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() を使用しない] を選択します。

Code fix for CA1828 - Do not use CountAsync() or LongCountAsync() when AnyAsync() can be used

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

数を計算するための不要なコレクションの列挙によるパフォーマンスへの影響が懸念されない場合は、この規則違反を抑制しても問題ありません。

警告を抑制する

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

#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

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

関連項目