Blazor Streaming Rendering 使用教程

Blazor Streaming Rendering是.NET 8引入的流式渲染优化,通过@stream指令分块推送渲染结果,提升长列表和实时数据场景的响应体验。

Blazor Streaming Rendering(流式渲染)是 .NET 8 引入的一项关键优化,用于提升 Blazor Server 和 Blazor WebAssembly(配合 SignalR 流式传输)中长列表、实时数据更新等场景的响应体验。它不改变组件生命周期,而是让框架能分块、渐进地将渲染结果推送到浏览器,避免“整页卡顿”或“白屏等待”。

什么时候该用 Streaming Rendering?

适合以下典型场景:

  • 渲染数百甚至上千项的动态列表(如日志流、聊天消息、传感器数据)
  • 页面包含多个耗时初始化的子组件(如图表、富文本编辑器),希望先显示骨架或部分区域
  • 服务端处理延迟较高,但用户需要尽快看到首屏内容
  • 避免因单次 RenderTree 批量更新过大导致 SignalR 消息超限或延迟激增

如何启用并使用 @stream

核心是使用 @stream 指令在 Razor 组件中标记可流式渲染的代码块。它必须包裹一个返回 IAsyncEnumerable 的异步方法或本地函数。

示例:流式加载用户列表

@page "/users"
@using System.Threading.Tasks

@stream UserItems()

@code {
    private async IAsyncEnumerable UserItems()
    {
        var users = await GetUsersAsync(); // 假设返回 List
        foreach (var user in users)
        {
            // 每次 yield 一个片段,浏览器立即渲染这一项
            await Task.Delay(10); // 可选:模拟逐条“推送”节奏
            yield return @@user.Name (@user.Id);
        }
    }

    private async Task> GetUsersAsync() => 
        await Task.FromResult(Enumerable.Range(1, 500)
            .Select(i => new User { Id = i, Name = $"User {i}" }).ToList());
}

注意:@stream 不支持嵌套,不能放在 @if@foreach 内部直接写;必须作为独立语句调用一个返回 IAsyncEnumerable 的方法。

搭配 Virtualize 组件更高效

流式渲染 + 是处理大数据列表的黄金组合:

  • 负责可视区按需渲染(减少 DOM 节点)
  • @stream 负责服务端数据分块下发(降低首屏阻塞)

实际中可先用 @stream 快速输出前 20 条,再由 接管滚动加载——两者互补,不是互斥。

注意事项和限制

当前(.NET 8 / .NET 9 Preview)需留意:

  • 仅支持 Blazor Server 和启用了 SignalR 流式传输的 Blazor WebAssembly(需配置 AddServerSideBlazor().AddCircuitOptions(...)
  • 流式块内不能调用 StateHasChanged() 或触发强制重渲染
  • 无法在流式块中使用 @key 或组件参数绑定(因片段是“一次性注入”的,无后续更新上下文)
  • 调试时浏览器 DevTools 的 Elements 面板可能不会实时反映每一条插入(但视觉和功能正常)

基本上就这些。流式渲染不是万能银弹,但对特定卡顿场景效果立竿见影——用对地方,体验提升非常直观。