CA1826:Linq の列挙可能なメソッドの代わりにプロパティを使用します
プロパティ | 値 |
---|---|
ルール ID | CA1826 |
Title | Linq の列挙可能なメソッドの代わりにプロパティを使用します |
[カテゴリ] | パフォーマンス |
修正が中断ありか中断なしか | なし |
.NET 8 では既定で有効 | 提案として |
原因
Enumerable LINQ メソッドが同等のより効率的なプロパティをサポートする型で使用されました。
規則の説明
この規則では、同じデータをフェッチするための同等でより効率的なプロパティを持つ型のコレクションでの Enumerable LINQ メソッド呼び出しにフラグを設定します。
この規則は、IReadOnlyList<T> を実装するが IList<T> を実装しないコレクション型を分析します。
この規則では、これらのコレクション型の次のメソッドの呼び出しにフラグを設定します。
- System.Linq.Enumerable.Count
- System.Linq.Enumerable.First
- System.Linq.Enumerable.FirstOrDefault
- System.Linq.Enumerable.Last
- System.Linq.Enumerable.LastOrDefault
分析されるコレクション型やメソッドは、より多くのケースに対応できるように将来拡張される可能性があります。
違反の修正方法
違反を修正するには、Enumerable メソッドの呼び出しをプロパティ アクセスに置き換えます。 たとえば、次の 2 つのコード スニペットは、規則違反とその修正方法を示しています。
using System;
using System.Collections.Generic;
using System.Linq;
class C
{
public void M(IReadOnlyList<string> list)
{
Console.Write(list.First());
Console.Write(list.Last());
Console.Write(list.Count());
}
}
using System;
using System.Collections.Generic;
class C
{
public void M(IReadOnlyList<string> list)
{
Console.Write(list[0]);
Console.Write(list[list.Count - 1]);
Console.Write(list.Count);
}
}
ヒント
Visual Studio では、この規則に対するコード修正を使用できます。 これを使用するには、違反にカーソルを置き、Ctrl+. (ピリオド) を押します。 表示されるオプションの一覧から、 [インデクサーを使用する] を選択します。
どのようなときに警告を抑制するか
特定の Enumerable メソッド呼び出しによるパフォーマンスへの影響が懸念されない場合は、この規則違反を抑制しても問題ありません。
警告を抑制する
単一の違反を抑制するだけの場合は、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、規則をもう一度有効にします。
#pragma warning disable CA1826
// The code that's violating the rule is on this line.
#pragma warning restore CA1826
ファイル、フォルダー、またはプロジェクトの規則を無効にするには、構成ファイルでその重要度を none
に設定します。
[*.{cs,vb}]
dotnet_diagnostic.CA1826.severity = none
詳細については、「コード分析の警告を抑制する方法」を参照してください。
分析するコードを構成する
次のオプションを使用して、コードベースのどの部分に対してこの規則を実行するか構成します。
FirstOrDefault メソッドと LastOrDefault メソッドを除外する
この規則を、Enumerable.FirstOrDefault および Enumerable.LastOrDefault メソッドが分析から除外されるように構成することができます。 これらを置き換えるために記述するコードは読み取りにくいため、読みやすさが問題である場合は、これらのメソッドを除外することを検討してください。 これらのメソッドを除外するには、プロジェクトの .editorconfig ファイルに次のキーと値のペアを追加します。
dotnet_code_quality.CA1826.exclude_ordefault_methods = true
関連規則
- CA1827:Any が使用できる場合は Count/LongCount を使用しません
- CA1828:AnyAsync が使用できる場合は CountAsync/LongCountAsync を使用しません
- CA1829:Enumerable. Count メソッドではなく Length/Count プロパティを使用します
関連項目
.NET