CA1863：使用 'CompositeFormat'

属性	值
规则 ID	CA1863
标题	使用 CompositeFormat
类别	“性能”
修复是中断修复还是非中断修复	非中断
在 .NET 8 中默认启用	否

原因

代码调用的 String.Format(String, Object[]) 或 StringBuilder.AppendFormat(String, Object[]) 带有尚未缓存到 CompositeFormat 实例的 static 格式字符串。

规则说明

在运行时分析格式字符串的成本很高。 此规则会在你的代码中查找可以缓存并使用 CompositeFormat 实例作为格式设置操作的参数的位置，而不会传入原始格式字符串。 CompositeFormat 实例会在复合格式字符串创建时分析它，这意味着字符串格式设置的“热路径”可以更快地执行。

如何解决冲突

通过调用 CompositeFormat.Parse(String) 来创建 CompositeFormat 的实例，并将其传递给 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

有关详细信息，请参阅如何禁止显示代码分析警告。