如何正确实现C#中的ISpanFormattable.TryFormat()方法？

你当前的实现逻辑上是正确的（目标Span能容纳完整结果时返回true，否则返回false，charsWritten记录实际写入长度），但存在明显性能瓶颈：将ReadOnlySpan<char>转为string、调用ToString生成中间字符串都会产生不必要的内存分配，完全浪费了ISpanFormattable无分配格式化的设计优势。

优化思路 #

核心原则是直接基于Span<char>完成格式化逻辑，避免中间字符串分配。把格式化的核心逻辑抽离到TryFormat中，让ToString方法反过来依赖TryFormat，既能复用逻辑，又能最大化性能。

优化后的实现示例 #

假设你的Foo类包含需要格式化的业务字段（比如示例中的_value），实现如下：

public class Foo : ISpanFormattable
{
    // 示例业务字段，根据你的实际类结构调整
    private readonly int _value;

    public Foo(int value) => _value = value;

    #region Formatting
    public override string ToString() => ToString("g");
    public string ToString(string? formatting) => ToString(formatting, CultureInfo.CurrentCulture.NumberFormat);
    public string ToString(string? formatting, IFormatProvider? formatProvider)
    {
        // 先尝试栈分配的Span（无GC分配，性能最优）
        Span<char> stackBuffer = stackalloc char[32]; // 预估足够的长度，根据实际格式调整
        if (TryFormat(stackBuffer, out int charsWritten, formatting.AsSpan(), formatProvider))
        {
            return stackBuffer[..charsWritten].ToString();
        }

        // 栈分配空间不足时，改用堆分配（仅在必要时触发）
        char[] heapBuffer = new char[64];
        while (!TryFormat(heapBuffer, out charsWritten, formatting.AsSpan(), formatProvider))
        {
            Array.Resize(ref heapBuffer, heapBuffer.Length * 2);
        }
        return new string(heapBuffer, 0, charsWritten);
    }

    public bool TryFormat(Span<char> destination, out int charsWritten, ReadOnlySpan<char> format, IFormatProvider? provider)
    {
        charsWritten = 0;
        // 核心格式化逻辑：直接操作destination Span，无中间字符串分配
        // 示例：复用int的TryFormat，实际根据你的业务需求自定义
        return _value.TryFormat(destination, out charsWritten, format, provider);
        
        // 如果是自定义格式拼接，比如添加前缀：
        // ReadOnlySpan<char> prefix = "Foo:".AsSpan();
        // if (destination.Length < prefix.Length)
        // {
        //     charsWritten = 0;
        //     return false;
        // }
        // prefix.CopyTo(destination);
        // bool numSuccess = _value.TryFormat(destination[prefix.Length..], out int numChars, format, provider);
        // charsWritten = prefix.Length + numChars;
        // return numSuccess;
    }

    // 可选：预计算格式化所需的最小长度，减少堆分配的尝试次数
    private int GetRequiredLength(string? formatting, IFormatProvider? formatProvider)
    {
        // 这里如果要完全无分配，需要自己计算长度；如果允许临时分配，可以用ToString获取长度
        return _value.ToString(formatting, formatProvider).Length;
    }
    #endregion
}

关键细节说明 #

1. 返回值逻辑：
   • 返回true：目标destination Span有足够空间容纳完整格式化结果，charsWritten为格式化后的总字符数。
   • 返回false：目标空间不足，charsWritten为实际写入的字符数（即destination的长度），写入内容为截断状态，调用者需自行处理。
2. 避免Span转string：直接使用ReadOnlySpan<char>形式的format参数，比如判断格式时用format.Equals("g".AsSpan())替代字符串比较。
3. 内存分配优化：优先使用栈分配的Span<char>（stackalloc），仅在空间不足时才使用堆分配，最大程度减少GC压力。

内容的提问来源于stack exchange，提问作者John Alexiou