ASP.NET Blazor 中 MarkupContent 拼接 HTML 的注意事项

在 ASP.NET Blazor 开发中，开发者有时会遇到需要动态构建 HTML 内容的情况。本文将通过一个典型场景，分析在 Blazor 中拼接 MarkupContent 时需要注意的技术细节。

问题现象

开发者尝试在 Blazor InteractiveServer 应用中使用 RenderFragment 动态构建一个包含 div 和 h2 标签的 HTML 结构。代码逻辑看似合理，期望输出一个包含标题的警示框，但实际渲染结果却不符合预期。

代码示例

开发者使用了以下两种方式尝试实现：

1. 通过 RenderFragment 构建：

private RenderFragment RenderWholeControl => mybuilder =>
{
    mybuilder.AddMarkupContent(0, """<div class="alert alert-primary">""");
    mybuilder.OpenElement(1, "h2");
    mybuilder.AddContent(2, "Hello Blazor");
    mybuilder.CloseElement();
    mybuilder.AddMarkupContent(3, "</div>");
};

2. 通过多个 MarkupString 拼接：

@((MarkupString)"""<div class="alert alert-primary">""")
@((MarkupString)"""<h2>Hello Blazor</h2>""")
@((MarkupString)"""</div>""")

渲染差异

在 Interactive WebAssembly 组件中，代码能够按预期工作，生成正确的嵌套结构。但在 InteractiveServer 模式下，渲染结果出现了问题，div 和 h2 标签被拆分开来，失去了预期的嵌套关系。

技术分析

这种现象源于 Blazor 对 MarkupString 和 HTML 片段处理的核心机制：

1. HTML 片段完整性要求：Blazor 要求每个 MarkupString 必须代表一个完整的、有效的 HTML 片段。不能通过拼接不完整的 HTML 片段来构建结构。

2. 渲染器差异：WebAssembly 和 Server 模式的渲染器实现有所不同，导致对不完整 HTML 片段的容错性存在差异。

3. 构建器使用规范：当使用 RenderTreeBuilder 时，应该遵循完整的元素生命周期管理，避免混合使用标记内容和元素构建方法。

解决方案

要实现预期的 HTML 结构，推荐以下两种正确方式：

1. 统一使用 RenderTreeBuilder 方法：

private RenderFragment RenderWholeControl => mybuilder =>
{
    mybuilder.OpenElement(0, "div");
    mybuilder.AddAttribute(1, "class", "alert alert-primary");
    mybuilder.OpenElement(2, "h2");
    mybuilder.AddContent(3, "Hello Blazor");
    mybuilder.CloseElement(); // 关闭 h2
    mybuilder.CloseElement(); // 关闭 div
};

2. 使用完整的 MarkupString：

@((MarkupString)"""<div class="alert alert-primary"><h2>Hello Blazor</h2></div>""")

最佳实践

1. 在动态构建复杂 HTML 结构时，优先使用 RenderTreeBuilder 的 Open/Close 方法。

2. 如果使用 MarkupString，确保每个片段都是完整、有效的 HTML。

3. 避免混合使用标记内容和元素构建方法，这可能导致不可预期的渲染结果。

4. 在需要跨模式(WebAssembly/Server)兼容的场景下，更应严格遵守这些规范。

理解这些底层机制，可以帮助开发者在 Blazor 中更可靠地构建动态 UI 内容。