CA1820: Mithilfe der Zeichenfolgenlänge auf leere Zeichenfolgen prüfen.

Eigenschaft	Wert
Regel-ID	CA1820
Titel	Mithilfe der Zeichenfolgenlänge auf leere Zeichenfolgen prüfen.
Kategorie	Leistung
Fix ist eine Breaking- oder Non-Breaking-Änderung	Nicht umbrechend
Standardmäßig in .NET 10 aktiviert	Nein
Anwendbare Sprachen	C# und Visual Basic

Ursache

Eine Zeichenfolge wird mithilfe von Object.Equals mit der leeren Zeichenfolge verglichen.

Regelbeschreibung

Der Vergleich von Zeichenfolgen mittels String.Length-Eigenschaft oder String.IsNullOrEmpty-Methode ist schneller als mit Equals. Dies liegt daran, dass Equals wesentlich mehr CIL-Anweisungen ausführt als entweder IsNullOrEmpty oder die Anzahl der Anweisungen, die zum Abrufen des Length-Eigenschaftswerts ausgeführt werden, um diesen mit Null zu vergleichen.

Bei Null-Zeichen verhalten sich Equals und <string>.Length == 0 unterschiedlich. Wenn Sie versuchen, den Wert der Length-Eigenschaft für eine NULL-Zeichenfolge zu erhalten, löst der Common Language Runtime einen System.NullReferenceException aus. Wenn Sie einen Vergleich zwischen einer NULL-Zeichenfolge und der leeren Zeichenfolge durchführen, löst der Common Language Runtime keine Ausnahme aus und gibt false zurück. Das Testen auf NULL wirkt sich nicht maßgeblich auf die relative Leistung dieser beiden Ansätze aus. Verwenden Sie die IsNullOrEmpty-Methode, wenn Sie auf .NET Framework 2.0 oder höher abzielen. Verwenden Sie andernfalls den Length = = 0-Vergleich, wann immer dies möglich ist.

Behebung von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, ändern Sie den Vergleich so, dass die IsNullOrEmpty-Methode verwendet wird.

Wann sollten Warnungen unterdrückt werden?

Es ist sicher, eine Warnung aus dieser Regel zu unterdrücken, wenn die Leistung kein Thema 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 CA1820
// The code that's violating the rule is on this line.
#pragma warning restore CA1820

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

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

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

Beispiel

Im folgenden Beispiel werden die verschiedenen Techniken veranschaulicht, die verwendet werden, um nach einem leeren String zu suchen.

public class StringTester
{
    string s1 = "test";

    public void EqualsTest()
    {
        // Violates rule: TestForEmptyStringsUsingStringLength.
        if (s1 == "")
        {
            Console.WriteLine("s1 equals empty string.");
        }
    }

    // Use for .NET Framework 1.0 and 1.1.
    public void LengthTest()
    {
        // Satisfies rule: TestForEmptyStringsUsingStringLength.
        if (s1 != null && s1.Length == 0)
        {
            Console.WriteLine("s1.Length == 0.");
        }
    }

    // Use for .NET Framework 2.0.
    public void NullOrEmptyTest()
    {
        // Satisfies rule: TestForEmptyStringsUsingStringLength.
        if (!String.IsNullOrEmpty(s1))
        {
            Console.WriteLine("s1 != null and s1.Length != 0.");
        }
    }
}