CA1863: используйте составной формат

Статья
11/22/2023

Свойство	Значение
Идентификатор правила	CA1863
Заголовок	Использование `CompositeFormat`
Категория	Производительность
Исправление является критическим или не критическим	Не критическое
Включен по умолчанию в .NET 8	No

Причина

Вызовы String.Format(String, Object[]) кода или StringBuilder.AppendFormat(String, Object[]) строка формата, не кэшируемая static в экземпляре CompositeFormat .

Описание правила

Это дорого для анализа строки формата во время выполнения. Это правило находит места в коде, где можно кэшировать и использовать CompositeFormat экземпляр в качестве аргумента для операции форматирования, а не передавать исходную строку форматирования. Экземпляр CompositeFormat анализирует составную строку форматирования при его создании, что означает,что "горячий путь" форматирования строк может выполняться гораздо быстрее.

Устранение нарушений

Создайте экземпляр CompositeFormat путем вызова CompositeFormat.Parse(String) и передайте его String.Format(IFormatProvider, CompositeFormat, Object[]) в исходную строку формата или StringBuilder.AppendFormat(IFormatProvider, CompositeFormat, Object[]) вместо нее.

Пример

В следующем примере показано два нарушения правила:

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

В следующем примере показан код, который устраняет оба нарушения:

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

Когда лучше отключить предупреждения

Это безопасно, чтобы отключить диагностика из этого правила, если производительность не является проблемой.

Отключение предупреждений

Если вы просто хотите отключить одно нарушение, добавьте директивы препроцессора в исходный файл, чтобы отключить и повторно включить правило.

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

Чтобы отключить правило для файла, папки или проекта, задайте его серьезность none в файле конфигурации.

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

Дополнительные сведения см. в разделе Практическое руководство. Скрытие предупреждений анализа кода.

Поделиться через