CA1863: 'CompositeFormat' kullanın

Özellik	Değer
Kural Kimliği	CA1863
Başlık	CompositeFormat komutunu kullanma
Kategori	Performans
Hataya neden olan veya bozulmayan düzeltme	Hataya neden olmayan
.NET 8'de varsayılan olarak etkin	No

Neden

Kod çağrıları String.Format(String, Object[]) veya StringBuilder.AppendFormat(String, Object[]) bir örneğe önbelleğe alınmamış bir staticCompositeFormat biçim dizesiyle.

Kural açıklaması

Çalışma zamanında bir biçim dizesini ayrıştırmak pahalıdır. Bu kural, özgün biçim dizesini geçirmek yerine, kodunuzda bir örneği önbelleğe alıp biçimlendirme işlemine bağımsız değişken olarak kullanabileceğiniz CompositeFormat yerleri bulur. Örnek CompositeFormat , bileşik biçim dizesini oluşturulduğunda ayrıştırır; başka bir deyişle, dize biçimlendirmesinin "sık erişimli yolu" çok daha hızlı yürütülebilir.

İhlalleri düzeltme

öğesini çağırarak CompositeFormat.Parse(String) ve özgün biçim dizesi yerine veya StringBuilder.AppendFormat(IFormatProvider, CompositeFormat, Object[]) öğesine geçirerek String.Format(IFormatProvider, CompositeFormat, Object[]) bir örneği CompositeFormat oluşturun.

Örnek

Aşağıdaki örnekte kuralın iki ihlali gösterilmektedir:

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

Aşağıdaki örnekte her iki ihlali de düzelten kod gösterilmektedir:

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

Uyarıların ne zaman bastırılması gerekiyor?

Performans önemli değilse bu kuraldan tanılamayı engellemek güvenlidir.

Uyarıyı gizleme

Yalnızca tek bir ihlali engellemek istiyorsanız, kuralı devre dışı bırakmak ve sonra yeniden etkinleştirmek için kaynak dosyanıza ön işlemci yönergeleri ekleyin.

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

Bir dosya, klasör veya projenin kuralını devre dışı bırakmak için, yapılandırma dosyasındaki önem derecesini noneolarak ayarlayın.

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

Daha fazla bilgi için bkz . Kod analizi uyarılarını gizleme.