.NET 6 Web API与Blazor Server应用间回调监听实现方案咨询

EventCallback是Blazor应用内部的组件间事件通信机制，仅支持同一进程内的事件触发，你的Web API与Blazor Server是两个独立的服务进程，跨进程通信自然无法使用该机制。

推荐实现方案：SignalR（.NET生态原生双向通信方案，适配性最好） #

后端Web API侧实现步骤 #

• 安装NuGet包：Microsoft.AspNetCore.SignalR
• 自定义Hub类用于通信：

public class DataChangeHub : Hub
{
    // 可根据需求添加客户端订阅、权限校验等逻辑
}

• Program.cs中注册SignalR服务并配置端点：

// 服务注册
builder.Services.AddSignalR();
// 中间件配置，放在app.MapControllers()之前
app.MapHub<DataChangeHub>("/hubs/data-change");

• 在你的复杂类实例变更的业务逻辑中，注入IHubContext<DataChangeHub>推送变更：

private readonly IHubContext<DataChangeHub> _hubContext;
// 构造函数注入省略

// 实例变更后触发推送
public void OnYourClassInstanceChanged(YourComplexClass newInstance)
{
    // 推送给所有连接的Blazor客户端，也可按用户ID、连接ID过滤推送目标
    _hubContext.Clients.All.SendAsync("OnDataChanged", newInstance);
}

Blazor Server侧实现步骤 #

• 安装NuGet包：Microsoft.AspNetCore.SignalR.Client
• 组件中初始化连接并监听推送事件：

private HubConnection _hubConnection;
private YourComplexClass _currentInstance;

protected override async Task OnInitializedAsync()
{
    // 初始化Hub连接，配置自动重连
    _hubConnection = new HubConnectionBuilder()
        .WithUrl("https://你的Web API域名/hubs/data-change")
        .WithAutomaticReconnect() // 配置断开自动重连
        .Build();

    // 监听后端推送的变更事件
    _hubConnection.On<YourComplexClass>("OnDataChanged", newInstance =>
    {
        _currentInstance = newInstance;
        // 通知UI更新
        StateHasChanged();
    });

    // 启动连接
    await _hubConnection.StartAsync();
}

// 组件销毁时释放连接
public async ValueTask DisposeAsync()
{
    if (_hubConnection is not null)
    {
        await _hubConnection.DisposeAsync();
    }
}

备选方案 #

• 单向推送场景可使用Server-Sent Events(SSE)：仅支持后端向前端单向推送，比WebSocket轻量，适合不需要客户端反向通信的场景
• 实时性要求低的场景可使用长轮询：Blazor端按固定间隔向后端发起查询请求，实现简单但实时性差，服务端负载更高

注意事项 #

• 两边序列化配置需保持一致，避免复杂类反序列化失败，默认使用System.Text.Json时可统一配置属性命名规则、忽略空值等规则
• 若Web API为多实例部署，需配置SignalR背板（支持Redis、Azure Service Bus等），确保变更通知能同步到所有实例连接的客户端

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