当前位置:

首页 > 编程开发 > Blazor调用JS函数方法详解

Blazor调用JS函数方法详解

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

本文目录

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

    Blazor怎么调用JavaScript函数 Blazor JS Interop教程

    Blazor 可以通过 JS Interop(JavaScript 互操作)安全、高效地调用浏览器中的 JavaScript 函数,这是混合开发的关键能力。核心在于 IJSRuntime 接口,它提供同步和异步两种调用方式,推荐优先使用异步方法(InvokeAsync)以避免阻塞 UI 线程。

    在组件中调用 JS 函数

    先确保 JS 函数已挂载到全局作用域(如 window),再在 Razor 组件中注入并调用:

    • 在 wwwroot/index.html 或 wwwroot/js/site.js 中定义函数,例如:
    • 在 Blazor 组件(.razor)顶部注入服务:
      @inject IJSRuntime JSRuntime
    • 调用示例(异步):
      @code {
      private async Task ShowMessage() => await JSRuntime.InvokeVoidAsync("showAlert", "Hello from Blazor!");
      private async Task GetWidth() {
        var width = await JSRuntime.InvokeAsync("getScreenWidth");
        Console.WriteLine($"Screen width: {width}");
      }
      }

    传递参数与处理返回值

    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 或强类型模型)
    • 若 JS 返回 Promise,Blazor 会自动等待其完成,无需额外包装

    从 JS 调用 .NET 方法(双向互操作)

    使用 IJSInProcessRuntime(仅限 Server-Side Blazor)或更通用的 DotNetObjectReference 实现 JS 主动调用 C#:

    • 在 C# 中创建可被 JS 引用的对象:
      private DotNetObjectReference objRef;
      protected override void OnInitialized() {
        objRef = DotNetObjectReference.Create(this);
        JSRuntime.InvokeVoidAsync("registerCallback", objRef);
      }
    • 在 JS 中保存引用,并调用 .NET 方法:
      window.registerCallback = (dotNetObj) => {
        window.dotNetHelper = dotNetObj;
      };
      window.triggerCSharp = () => window.dotNetHelper.invokeMethodAsync('HandleFromJs', 'data');
    • 在 C# 中添加被调用方法(必须是 public 且带 [JSInvokable]):
      [JSInvokable]
      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 和前端生态就能真正打通了。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    GitHub六个AI开源项目能做什么?软件理解、语音与求职场景
    GitHub六个AI开源项目能做什么?软件理解、语音与求职场景

    解析六个GitHub AI开源项目的具体用途,包括软件静态分析、智能体回答检查、多语言配音、求职材料生成、本地代码检索及动态歌词展示,帮助开发者根据实际需求筛选工具并正确验证结果。

    opencode安装skills教程及本地配置方法
    opencode安装skills教程及本地配置方法

    遇到OpenCode Skills无法加载或配置无效?本文手把手教你完成Skills的安装、环境变量设置及本地调试,避开常见坑点,让AI助手更懂你的代码习惯。

    如何开启Visual Studio2022实时代码分析警告提示
    如何开启Visual Studio2022实时代码分析警告提示

    解决 Visual Studio 2022 编辑时不显示代码分析警告的问题。指南涵盖 .NET 项目实时分析设置、Roslyn 分析器范围调整及错误列表来源筛选,确保开发者能高效利用实时代码诊断功能。

    如何在Visual Studio2022查看变量监视窗口调试程序
    如何在Visual Studio2022查看变量监视窗口调试程序

    详解 Visual Studio 2022 调试技巧:包括断点设置、监视窗口开启方法、变量添加步骤以及通过 F10 单步执行观察变量值变化的全过程。

    Visual Studio2017设置默认编码为UTF-8不带BOM
    Visual Studio2017设置默认编码为UTF-8不带BOM

    针对 Visual Studio 2017 缺乏全局默认编码选项的情况,详解如何利用 .editorconfig 设定项目级 UTF-8 无 BOM 规则,以及手动转换现有文件并校验字节的方法。

    Visual Studio2022F5调试提示启动项目未配置怎么修复
    Visual Studio2022F5调试提示启动项目未配置怎么修复

    解决 Visual Studio 2022 F5 调试报错问题,通过设置启动项目、检查解决方案属性及正确区分类库与应用项目,快速恢复调试功能。

    Visual Studio2022NuGet包还原失败离线处理方案
    Visual Studio2022NuGet包还原失败离线处理方案

    解决Visual Studio 2022离线环境中NuGet包还原失败的难题,涵盖依赖链分析、本地源配置、包集收集及隔离验证步骤,帮助开发者构建稳定的离线开发环境。

    Visual Studio2017大项目加载缓慢,优化加载性能技巧
    Visual Studio2017大项目加载缓慢,优化加载性能技巧

    解决Visual Studio 2017大型项目加载慢的实用指南。涵盖性能监测、扩展管理、文档恢复优化及版本兼容性检查,帮助开发者精准定位瓶颈并提升工作效率。

    Visual Studio2022设置多启动项目同时调试运行
    Visual Studio2022设置多启动项目同时调试运行

    详解 Visual Studio 2022 多启动项目配置方法,包括启动动作选择、顺序调整及调试技巧,帮助开发者高效调试分布式或前后端分离应用。

    fastapi下载文件接口实现教程
    fastapi下载文件接口实现教程

    深入解析在FastAPI框架中实现文件下载接口的完整方案,涵盖基于FileResponse的本地静态文件传输、基于StreamingResponse的分块流式传输、RFC 5987中文文件名编码规范、路径穿越安全防御及BackgroundTasks临时文件清理,并配备详细代码示例与架构解析图。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。