blazor通过ijsruntime接口实现安全高效的js互操作,推荐异步调用;需将js函数挂载到window,c#中注入并调用;支持参数传递、返回值处理及双向调用,注意生命周期与异常处理。

Blazor 可以通过 JS Interop(JavaScript 互操作)安全、高效地调用浏览器中的 JavaScript 函数,这是混合开发的关键能力。核心在于 IJSRuntime 接口,它提供同步和异步两种调用方式,推荐优先使用异步方法(InvokeAsync)以避免阻塞 UI 线程。
在组件中调用 JS 函数
先确保 JS 函数已挂载到全局作用域(如 window),再在 Razor 组件中注入并调用:
- 在
wwwroot/index.html或wwwroot/js/site.js中定义函数,例如:
<script><br> window.showAlert = (message) => alert(message);<br> window.getScreenWidth = () => window.screen.width;<br> </script> - 在 Blazor 组件(.razor)顶部注入服务:
@inject IJSRuntime JSRuntime - 调用示例(异步):
@code {<br> private async Task ShowMessage() => await JSRuntime.InvokeVoidAsync("showAlert", "Hello from Blazor!");<br> private async Task GetWidth() {<br> var width = await JSRuntime.InvokeAsync<int>("getScreenWidth");<br> Console.WriteLine($"Screen width: {width}");<br> }<br> }
传递参数与处理返回值
JS Interop 支持基本类型(string、int、bool)、JSON 序列化对象(需匹配 JS 结构),以及 .NET 的 ElementReference(用于 DOM 操作):
- 传入对象时,Blazor 自动序列化为 JSON,JS 端直接接收为普通对象;
例如 C#:await JSRuntime.InvokeVoidAsync("updateUser", new { name = "Alice", age = 30 });
对应 JS:window.updateUser = (user) => console.log(user.name, user.age); - 返回值支持
string、int、bool、DateTime、object(反序列化为Dictionary<string object></string>或强类型模型) - 若 JS 返回 Promise,Blazor 会自动等待其完成,无需额外包装
从 JS 调用 .NET 方法(双向互操作)
使用 IJSInProcessRuntime(仅限 Server-Side Blazor)或更通用的 DotNetObjectReference 实现 JS 主动调用 C#:
立即学习“Java免费学习笔记(深入)”;
- 在 C# 中创建可被 JS 引用的对象:
private DotNetObjectReference<MyComponent> objRef;<br> protected override void OnInitialized() {<br> objRef = DotNetObjectReference.Create(this);<br> JSRuntime.InvokeVoidAsync("registerCallback", objRef);<br> } - 在 JS 中保存引用,并调用 .NET 方法:
window.registerCallback = (dotNetObj) => {
window.dotNetHelper = dotNetObj;
};
window.triggerCSharp = () => window.dotNetHelper.invokeMethodAsync('HandleFromJs', 'data'); - 在 C# 中添加被调用方法(必须是 public 且带
[JSInvokable]):[JSInvokable]<br> public void HandleFromJs(string data) { /* 处理逻辑 */ }
注意事项与最佳实践
JS Interop 不是万能胶,需注意生命周期、线程安全和错误处理:
- JS 函数必须在 Blazor 组件渲染完成后再调用(如放在
OnAfterRenderAsync或用户交互事件中),避免因 DOM 未就绪导致报错 - Server-Side Blazor 中,JS 调用 .NET 是通过 SignalR 发送消息,有网络延迟,不适合高频实时调用
- 务必用 try-catch 包裹
InvokeAsync,捕获JavascriptException等异常 - 不再需要时(如组件销毁),手动释放
DotNetObjectReference:public void Dispose() => objRef?.Dispose();
基本上就这些。JS Interop 不复杂但容易忽略细节,重点是保持 JS 全局函数干净、C# 调用异步化、跨端数据结构对齐。用熟之后,Blazor 和前端生态就能真正打通了。









