从.NET Framework迁移到.NET Core：如何改写StringBuilder+TagBuilder的HTML渲染代码？

针对.NET Core中TagBuilder.ToString()无参数、需用StringWriter渲染的问题，以下是几种兼顾修改成本、内存效率、兼容性和可读性的解决方案：

方案1：封装扩展方法模拟.NET Framework行为（推荐快速迁移） #

通过扩展方法还原.NET Framework中TagBuilder.ToString(TagRenderMode)的调用方式，原有代码几乎无需调整：

public static class TagBuilderExtensions
{
    public static string ToHtmlString(this TagBuilder tagBuilder, TagRenderMode renderMode)
    {
        tagBuilder.TagRenderMode = renderMode;
        using var writer = new StringWriter();
        tagBuilder.WriteTo(writer, HtmlEncoder.Default);
        return writer.ToString();
    }
}

使用方式 #

原有代码：

sb.Append(tag.ToString(TagRenderMode.Normal));

修改后：

sb.Append(tag.ToHtmlString(TagRenderMode.Normal));

优势 #

• 修改难度极低：仅需替换方法名，无需重构逻辑
• 内存消耗可控：StringWriter通过using自动释放，与原StringBuilder拼接逻辑的内存开销接近
• 完全兼容：保留原有扩展方法的字符串返回逻辑，不影响上层调用
• 可读性好：团队无需适应新写法，保持原有代码风格

方案2：直接替换为StringWriter+WriteTo（不推荐大量修改） #

不封装扩展方法，直接在每个调用点改写为.NET Core原生写法：

var sb = new StringBuilder();
var tag = new TagBuilder("div");
tag.TagRenderMode = TagRenderMode.Normal;

// 直接关联现有StringBuilder，避免额外字符串拷贝
using var writer = new StringWriter(sb);
tag.WriteTo(writer, HtmlEncoder.Default);

劣势 #

• 修改难度高：每个ToString(TagRenderMode)调用都需手动改写，代码量巨大时容易出错
• 可读性下降：原生写法比原代码冗长，破坏原有简洁性
• 兼容性差：无法直接复用原有逻辑，需逐处调整

方案3：重构扩展方法返回IHtmlContent（推荐长期维护） #

.NET Core中TagBuilder实现了IHtmlContent接口，可直接作为扩展方法返回值，避免StringBuilder和StringWriter的中间开销：

原有扩展方法（.NET Framework）：

public static string MyCustomDiv(this HtmlHelper helper)
{
    var sb = new StringBuilder();
    var tag = new TagBuilder("div");
    tag.InnerHtml.Append("Hello World");
    sb.Append(tag.ToString(TagRenderMode.Normal));
    return sb.ToString();
}

重构后（.NET Core）：

public static IHtmlContent MyCustomDiv(this HtmlHelper helper)
{
    var tag = new TagBuilder("div");
    tag.InnerHtml.Append("Hello World");
    tag.TagRenderMode = TagRenderMode.Normal;
    return tag;
}

优势 #

• 内存消耗最低：直接由框架渲染IHtmlContent，避免中间字符串拼接的内存开销
• 符合最佳实践：适配.NET Core MVC的原生渲染逻辑
• 可读性优：代码更简洁，专注于标签构建而非字符串拼接

注意事项 #

需调整扩展方法的返回类型，若原有代码依赖字符串返回值（如手动拼接其他内容），需额外适配IHtmlContent的拼接逻辑（可使用HtmlContentBuilder）。

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