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

陌伟君_5046

陌伟君_5046

2025-12-26

1057人浏览

原创

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

blazor c# 调用 js 的详细方法 (js interop)

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

基础 JS 函数注册与调用

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

例如,在 interop.js 中定义:

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

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

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

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

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

cn-json-diff
cn-json-diff

比较两个 JSON 文件并显示差异。支持嵌套结构、数组及值变更。纯 Python 标准库实现,无需 API 密钥。

下载
  • 在组件中创建并保持引用:`private DotNetObjectReference? objRef;`
  • 重写 OnInitialized 初始化:objRef = DotNetObjectReference.Create(this);
  • 在 Dispose 或 OnDisposing 中释放: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
  • 数组/集合:建议转为 List 或 T[],JS 侧用数组操作即可

常见问题与最佳实践

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

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

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

2255

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

3662

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

1216

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

4219

7

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1878

5

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

3024

5

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

2023.10.24

6284

49

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2023.11.24

6269

6

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

2024.03.22

7834

16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.4万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.8万人学习