Blazor 组件实现
IDisposable是为了在组件被销毁前及时释放非托管资源(如定时器、事件订阅、HTTP 客户端连接、WebSocket 等),避免内存泄漏或后台任务持续运行。
什么时候必须实现 IDisposable
当组件中持有以下资源时,应显式实现
IDisposable: 启动了
System.Threading.Timer或
Task.Run启动的长期运行后台任务 手动订阅了静态事件或跨组件生命周期的事件(如
HttpClient.DefaultRequestHeaders变更、自定义事件总线) 使用了未被 Blazor 生命周期自动管理的
Stream、
DbContext(非 Scoped 服务)、
WebSocket等 通过
@ref持有原生 JS 对象且需调用 JS cleanup 函数(配合
IJSRuntime)
正确实现 Dispose 方法
在组件类中实现
IDisposable接口,并在
Dispose()中执行清理逻辑。注意:Blazor Server 和 WebAssembly 均支持该接口,但触发时机一致——组件从渲染树移除时(例如导航离开、条件渲染为 false)。
推荐写法:
@implements IDisposable
<p>@code {
private Timer? _timer;
private IDisposable? _subscription;</p><pre class="brush:php;toolbar:false;">protected override void OnInitialized()
{
_timer = new Timer(_ => { /* do work */ }, null, TimeSpan.Zero, TimeSpan.FromSeconds(5));
_subscription = SomeEventBus.Subscribe<Message>(HandleMessage);
}
public void Dispose()
{
_timer?.Dispose();
_subscription?.Dispose();
// 其他清理...
}}
关键点:确保所有可释放成员都判空再调用
Dispose();避免在
Dispose()中调用
StateHasChanged()(组件已不可交互);不要在
Dispose()中 await 异步操作(它不是异步方法)。
替代方案与注意事项
并非所有资源都需要手动
IDisposable: 注入的 Scoped 服务(如
HttpClient实例)由 DI 容器统一管理,组件内无需调用其
Dispose()使用
CancellationTokenSource配合异步操作时,应在
OnDisposing或
Dispose()中调用
Cancel()并
Dispose(),而非等待任务完成 Blazor 无
DisposeAsync的内置支持(.NET 6+ 的
IAsyncDisposable在组件中不被框架自动调用),如需异步清理,建议在
Dispose()中启动 fire-and-forget 任务并记录日志,或改用生命周期事件 + 取消令牌
基本上就这些。IDisposable 不复杂但容易忽略,尤其在定时器和事件订阅场景下,漏掉清理会导致组件卸载后逻辑仍在执行。
