Blazor C# 调用 JS 的详细方法 (JS Interop)

Blazor JS Interop核心是IJSRuntime接口,推荐异步调用;JS函数需挂载全局对象,C#通过DotNetObjectReference支持JS回调.NET方法,注意生命周期管理与错误处理。

Blazor 中调用 JavaScript(JS Interop)是混合开发的关键能力,核心在于 IJSRuntime 接口。它支持同步和异步调用,但推荐统一使用异步方式InvokeAsync),避免阻塞主线程,也兼容 Server 与 WebAssembly 模式。

基础 JS 函数注册与调用

JS 函数必须挂载在全局对象(如 windowself)上,才能被 C# 发现。不推荐直接写内联脚本,应放在 wwwroot/js/interop.js 并在 index.html_Host.cshtml 中引用。

例如,在 interop.js 中定义:

window.showAlert = (message) => alert(message);
window.getScreenWidth = () => window.screen.width;
window.invokeDotNet = (dotNetObj, data) => dotNetObj.invokeMethodAsync('HandleFromJs', data);

C# 端注入 IJSRuntime 后即可调用:

@inject IJSRuntime JSRuntime

@code {
private async Task ShowMessage() => await JSRuntime.InvokeVoidAsync("showAlert", "Hello from Blazor!");
private async Task GetWidth() => await JSRuntime.InvokeAsync("getScreenWidth");
}

从 JS 主动调用 C#(.NET 方法回调)

使用 DotNetObjectReference.Create() 包装 C# 实例,传给 JS。该引用可跨多次 JS 调用复用,但需手动释放(尤其在组件销毁时)。

  • 在组件中创建并保持引用:`private DotNetObjectReference? objRef;`
  • 重写 OnInitialized 初始化:objRef = DotNetObjectReference.Create(this);
  • DisposeOnDisposing 中释放:objRef?.Dispose();
  • JS 中通过 dotNetObj.invokeMethodAsync('MethodName', ...) 调用标记 [JSInvokable] 的 public 方法

注意:方法名默认为 C# 方法名,也可用 [JSInvokable("customName")] 自定义。

传递复杂参数与处理返回值

JS Interop 支持基本类型、字符串、JSON 对象(自动序列化/反序列化)、IJSInProcessObjectReference(仅 WebAssembly 同步场景)。

  • 传入对象:C# 传入 POCO 类,JS 端收到的是 plain object(非 class 实例)
  • 返回对象:JS 返回 JSON,C# 可用 InvokeAsync 直接映射
  • 错误处理:JS 抛出异常 → C# 捕获 JSException;C# 异常 → JS 端收到拒绝的 Promise
  • 数组/集合:建议转为 ListT[],JS 侧用数组操作即可

常见问题与最佳实践

  • Server-Side Blazor:JS 调用发生在浏览器端,C# 逻辑仍在服务器执行,网络延迟影响响应速度
  • WebAssembly:JS 运行在同一线程,无网络开销,但内存隔离严格,大对象传递建议用 ArrayBuffer 或流式处理
  • 避免频繁调用:合并多个小调用为单次批量操作(如传数组代替循环调用)
  • 调试技巧:在 JS 函数开头加 console.log;C# 端启用 try/catch 捕获 JSException 并打印 e.Message
  • 生命周期安全:确保 JS 调用不发生在组件已销毁后(如异步操作完成时组件已离开),可用 IsDisposed 判断

基本上就这些。JS Interop 不复杂但容易忽略上下文和生命周期,理清“谁调谁”“数据在哪”“何时释放”,就能稳稳用好。