CA1870: Verwenden einer zwischengespeicherten „SearchValues“-Instanz

Eigenschaft	Wert
Regel-ID	CA1870
Titel	Verwenden einer zwischengespeicherten „SearchValues“-Instanz
Kategorie	Leistung
Fix führt oder führt nicht zur Unterbrechung	Nicht unterbrechend
Standardmäßig in .NET 8 aktiviert	Als Vorschlag

Ursache

Eine IndexOfAny- oder ContainsAny-Methode wird mit vielen konstanten Werten aufgerufen, die stattdessen von der Verwendung von SearchValues profitieren können.

Die Regel kennzeichnet keine Aufrufe, die bis zu fünf Werte verwenden, da diese bereits eine optimale Implementierung verwenden.

Regelbeschreibung

Die Verwendung einer zwischengespeicherten SearchValues<T>-Instanz ist effizienter als das direkte Übergeben von Werten an IndexOfAny oder ContainsAny.

Behandeln von Verstößen

Erstellen und zwischenspeichern Sie eine SearchValues<T>-Instanz in einem static readonly-Feld, und übergeben Sie diese Instanz stattdessen an den IndexOfAny- oder ContainsAny-Aufruf.

Ein Codefix, der diese Transformation ausführt, ist verfügbar.

Beispiel

Der folgende Codeausschnitt zeigt zwei Verstöße gegen CA1870:

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");
}

Der folgende Codeschnipsel korrigiert die Verletzung:

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);
}

Bei mehreren Aufrufen von IndexOfAny mit demselben Wertesatz sollte s_myValues wiederverwendet werden.

Wann sollten Warnungen unterdrückt werden?

Es ist ungefährlich, diese Warnung zu unterdrücken, wenn die Leistung kein Problem ist.

Unterdrücken einer Warnung

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.

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

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.

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

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.