《HarmonyOSNext Web组件双向通信开发指南:JavaScript互调+动态注册+跨端数据流转实战》

《HarmonyOSNext Web组件双向通信开发指南:JavaScript互调+动态注册+跨端数据流转实战》

\##Harmony OS Next ##Ark Ts ##教育

本文适用于教育科普行业进行学习,有错误之处请指出我会修改。

一、应用侧如何调用前端JS函数?

应用侧有两种神器可以调用前端页面的JavaScript函数:runJavaScript() 和它的升级版 runJavaScriptExt()!两者的核心区别是:

  • runJavaScript():只能传字符串类型的脚本
  • runJavaScriptExt()更强更灵活!支持字符串和二进制数据(ArrayBuffer),还能用AsyncCallback异步获取结果!
举个栗子:点击应用按钮让前端字体变绿!
当我们在应用侧点击"runJavaScript"按钮时,触发前端页面的htmlTest()方法:
前端页面代码





原始黑色文字调用runJavaScript变绿,runJavaScriptCodePassed变红

⚙️ 应用侧ArkTS代码
// WebComponent.ets
import { webview } from '@kit.ArkWeb';

@Entry
@Component
struct WebComponent {
  controller: webview.WebviewController = new webview.WebviewController();

  aboutToAppear() {
    // 开启Web调试模式(重要!)
    webview.WebviewController.setWebDebuggingAccess(true);
  }

  build() {
    Column() {
      Button('runJavaScript')
        .onClick(() => {
          // 调用无参版:去掉param
          this.controller.runJavaScript('htmlTest()'); 
        })
        
      Button('runJavaScriptCodePassed')
        .onClick(() => {
          // 直接注入JS代码片段
          this.controller.runJavaScript(
            `function changeColor(){
              document.getElementById('text').style.color = 'red'
            }`
          );
        })
        
      // 加载本地HTML页面
      Web({ 
        src: $rawfile('index.html'), 
        controller: this.controller 
      })
    }
  }
}

二、注册应用侧方法到前端

想让前端页面调用应用侧的方法?我们需要把ArkTS方法"注入"到前端!有两种神操作:

方式1:初始化时注册(超省心!)
// 初始化注册版.ets
import { webview } from '@kit.ArkWeb';

// 要注册的测试类
class TestAgent {
  test(): string {
    return 'ArkTS发来的问候!';
  }
}

@Entry
@Component
struct WebComponent {
  controller: webview.WebviewController = new webview.WebviewController();
  @State agent: TestAgent = new TestAgent(); // 注册对象

  build() {
    Column() {
      Button('卸载代理')
        .onClick(() => {
          this.controller.deleteJavaScriptRegister("agentName");
        })
      
      Web({ src: $rawfile('index.html'), controller: this.controller })
        // 核心注入操作!
        .javaScriptProxy({
          object: this.agent,
          name: "agentName",     // 前端通过该名称调用
          methodList: ["test"],  // 暴露的方法
          controller: this.controller
        })
    }
  }
}
方式2:动态注册(灵活但需手动刷新)
// 动态注册版.ets
import { webview } from '@kit.ArkWeb';

class DynamicAgent {
  greet(): string {
    return "ArkUI动态注册示例";
  }
}

@Entry
@Component
struct Index {
  controller: webview.WebviewController = new webview.WebviewController();
  @State agent: DynamicAgent = new DynamicAgent();

  build() {
    Column() {
      Button('刷新页面')
        .onClick(() => {
          this.controller.refresh(); // 注册后必须刷新生效!
        })
        
      Button('注册到前端')
        .onClick(() => {
          // 动态注册关键操作
          this.controller.registerJavaScriptProxy(
            this.agent, 
            "dynamicAgent",
            ["greet"] // 暴露的方法名
          );
        })
        
      Web({ src: $rawfile('index.html'), controller: this.controller })
    }
  }
}
⚡ 重要提示:动态注册后必须执行.refresh() 才能生效!

三、参数传递实战宝典

场景1:传递数组对象
// ArkTS侧
class ArrayAgent {
  getNumbers(): number[] {
    return [1, 3, 5, 7]; 
  }
}

场景2:传递自定义对象
// 定义学生对象
class Student {
  name: string = '';
  age: number = 0;
}

class StudentAgent {
  getStudent(): Student {
    return { name: "小明", age: 18 }; 
  }
}
场景3:双向回调神操作
// ArkTS接收JS回调
class CallbackAgent {
  handle(callback: (data:string) => void) {
    setTimeout(() => callback("操作完成!"), 1000);
  }
}

四、Promise异步交互

方式1:ArkTS返回Promise
class PromiseAgent {
  fetchData(): Promise {
    return new Promise((resolve) => {
      setTimeout(() => resolve("获取成功"), 1500);
    });
  }
}
方式2:前端生成Promise

避坑指南总结表

场景 易错点 解决方案
方法注册未生效 忘记调用.refresh() ✅ 注册后立即刷新页面
参数传递失败 类型不匹配 ✅ 用基础类型或JSON对象
Promise未执行 未正确处理异常 ✅ 添加.catch()捕获错误
内存泄漏 未注销注册对象 ✅ 页面关闭时deleteJavaScriptRegister
权限校验失败 permission配置错误 ✅ 参考官方JSON模板
终极提示:调试时务必开启 setWebDebuggingAccess(true),配合Chrome DevTools实时查看控制台输出!

关键要点总结

  1. 双向通信三剑客
    runJavaScript() ➡️ 基础调用
    javaScriptProxy() ➡️ 初始化注册
    registerJavaScriptProxy() ➡️ 动态注册(记得refresh!)
  2. 数据传输四原则
    ✅ 基础类型直接传
    ✅ 对象用Class封装
    ✅ 数组自动序列化
    ✅ 函数通过回调传递
  3. 异步交互双通道
    Promise方案:适合明确操作结果的场景
    Callback方案:适合事件驱动型交互

最后放个彩蛋:遇到permission配置头秃时,直接用官方提供的JSON模板改参数值就好啦!不需要自己造轮子~

你可能感兴趣的:(harmonyos-next)