CA1863: Använd "CompositeFormat"

Artikel
11/12/2024

Property	Värde
Regel-ID	CA1863
Title	Använda `CompositeFormat`
Kategori	Prestanda
Korrigeringen är icke-bakåtkompatibel	Icke-icke-bryta
Aktiverad som standard i .NET 9	Nej

Orsak

Kodanrop String.Format(String, Object[]) eller StringBuilder.AppendFormat(String, Object[]) med en static formatsträng som inte har cachelagrats till en CompositeFormat instans.

Regelbeskrivning

Det är dyrt att parsa en formatsträng vid körning. Den här regeln letar upp platser i koden där du kan cachelagras och använda en CompositeFormat instans som argument för en formateringsåtgärd i stället för att skicka den ursprungliga formatsträngen. En CompositeFormat instans parsar den sammansatta formatsträngen när den skapas, vilket innebär att strängformateringens "heta sökväg" kan köras mycket snabbare.

Så här åtgärdar du överträdelser

Skapa en instans av CompositeFormat genom att anropa CompositeFormat.Parse(String) och skicka den till String.Format(IFormatProvider, CompositeFormat, Object[]) eller StringBuilder.AppendFormat(IFormatProvider, CompositeFormat, Object[]) i stället för den ursprungliga formatsträngen.

Exempel

I följande exempel visas två överträdelser av regeln:

class C
{
    private static readonly string StaticField = "Format one value: {0}";

    static void Main()
    {
        _ = string.Format(StaticField, 42);

        StringBuilder sb = new();
        sb.AppendFormat(StaticField, 42);
    }
}

I följande exempel visas kod som åtgärdar båda överträdelserna:

class C
{
    private static readonly CompositeFormat StaticField = CompositeFormat.Parse("Format one value: {0}");

    static void Main()
    {
        _ = string.Format(null, StaticField, 42);

        StringBuilder sb = new();
        sb.AppendFormat(null, StaticField, 42);
    }
}

När du ska ignorera varningar

Det är säkert att förhindra diagnostik från den här regeln om prestanda inte är ett problem.

Ignorera en varning

Om du bara vill förhindra en enda överträdelse lägger du till förprocessordirektiv i källfilen för att inaktivera och aktiverar sedan regeln igen.

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

Om du vill inaktivera regeln för en fil, mapp eller ett projekt anger du dess allvarlighetsgrad till none i konfigurationsfilen.

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

Mer information finns i Så här utelämnar du kodanalysvarningar.

Dela via