CA1870: キャッシュされた 'SearchValues' インスタンスを使用する

プロパティ	値
ルール ID	CA1870
Title	キャッシュされた 'SearchValues' インスタンスを使用する
[カテゴリ]	パフォーマンス
修正が中断ありか中断なしか	なし
.NET 8 では既定で有効	提案として

原因

IndexOfAny または ContainsAny メソッドは、多くの定数値を使用して呼び出される方法では、代わりに SearchValues を使用したほうが有利な場合があります。

このルールでは、最適な実装が既に使用されているため、最大 5 つの値を使用する呼び出しにフラグを設定しません。

規則の説明

キャッシュされた SearchValues<T> インスタンスを使用すると、値を IndexOfAny または ContainsAny に直接渡すよりも効率的です。

違反の修正方法

static readonly フィールドに SearchValues<T> インスタンスを作成してキャッシュし、代わりにそのインスタンスを IndexOfAny または ContainsAny 呼び出しに渡します。

この変換を実行するコード修正ツールを使用できます。

例

次のコード スニペットは、CA1870 の 2 つの違反を示しています:

static readonly char[] MyValues = new[] { 'a', 'b', 'c', 'x', 'y', 'z' };

static int IndexOfMyValues(ReadOnlySpan<char> text)
{
    return text.IndexOfAny(MyValues);
}

static bool ContainsOnlyMyValues(ReadOnlySpan<char> text)
{
    return !text.ContainsAnyExcept("abcxyz");
}

次のコード スニペットでは、これらの違反を修正しています。

private static readonly SearchValues<char> s_myValues = SearchValues.Create("abcxyz");

static int IndexOfMyValues(ReadOnlySpan<char> text)
{
    return text.IndexOfAny(s_myValues);
}

static bool ContainsOnlyMyValues(ReadOnlySpan<char> text)
{
    return !text.ContainsAnyExcept(s_myValues);
}

同じ値のセットで IndexOfAny を複数回呼び出す場合は、 s_myValues 再利用する必要があります。

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

パフォーマンスが問題でない場合は、この警告を抑制しても問題ありません。

警告を抑制する

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

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

ファイル、フォルダー、またはプロジェクトの規則を無効にするには、構成ファイルでその重要度を none に設定します。

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

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