当前位置:

首页 > 编程开发 > HarmonyOS 6.0应用级事件总线与组件间通信实例详解

HarmonyOS 6.0应用级事件总线与组件间通信实例详解

前言 说到组件通信,大家首先想到的肯定是@Prop/@Link、@Provide/@Consume、@Watch这些“正规军”。但有些场景它们确实搞不定——跨Ability通信、非父子组件通信、一对多广播、解耦通信。这时候就得请出事件总线了。HarmonyOS提供了Emitter和CommonEve

本文目录

    前言

    说到组件通信,大家首先想到的肯定是@Prop/@Link、@Provide/@Consume、@Watch这些“正规军”。但有些场景它们确实搞不定——跨Ability通信、非父子组件通信、一对多广播、解耦通信。这时候就得请出事件总线了。HarmonyOS提供了Emitter和CommonEvent两套方案,分别管应用内和应用间,但很多人分不清什么时候该用哪个。

    通信方案对比

    方案通信范围耦合度适用场景
    @Prop/@Link父子组件高父子数据同步
    @Provide/@Consume跨层级中祖孙组件通信
    AppStorage全局中全局状态共享
    Emitter应用内任意低组件间解耦通信
    CommonEvent跨应用低系统事件、跨应用通知

    Emitter是应用内的事件总线,CommonEvent是系统级的事件广播。 大多数场景用Emitter就够了,CommonEvent只在需要跟系统或其他应用通信时才用。

    Emitter基础

    Emitter是@kit.BasicServicesKit提供的进程内事件机制:

    import { emitter } from '@kit.BasicServicesKit';
    
    // 定义事件ID
    const EVENT_LOGIN_SUCCESS = 1001;
    const EVENT_CART_UPDATED = 1002;
    
    // 发送事件
    emitter.emit({
      eventId: EVENT_LOGIN_SUCCESS,
      parameters: { userId: '12345', userName: '张三' }
    });
    
    // 接收事件
    emitter.on({
      eventId: EVENT_LOGIN_SUCCESS
    }, (eventData: emitter.EventData) => {
      let params = eventData.parameters;
      let userId = params['userId'] as string;
      this.onLoginSuccess(userId);
    });
    

    eventId是数字类型的事件标识,自己定义。parameters携带数据,类型是Record。

    关键:Emitter是进程内的,同一个应用内才能收发。 跨进程(不同Ability运行在不同进程)时Emitter不生效。

    Emitter取消订阅

    // 订阅时保存回调引用
    private loginCallback = (eventData: emitter.EventData) => {
      // 处理
    }
    
    aboutToAppear(): void {
      emitter.on({ eventId: EVENT_LOGIN_SUCCESS }, this.loginCallback);
    }
    
    aboutToDisappear(): void {
      emitter.off(EVENT_LOGIN_SUCCESS, this.loginCallback);
    }
    

    必须在aboutToDisappear中off取消订阅,否则组件销毁后回调还在执行,导致内存泄漏和空引用crash。

    off必须传跟on相同的回调函数引用。所以回调不能写成匿名函数,要保存为类成员变量。

    一对多广播

    Emitter天然支持一对多——多个组件订阅同一个eventId,emit时所有订阅者都会收到:

    // 购物车页面
    emitter.emit({ eventId: EVENT_CART_UPDATED, parameters: { count: 5 } });
    
    // TabBar组件
    emitter.on({ eventId: EVENT_CART_UPDATED }, (data) => {
      this.cartBadge = data.parameters['count'] as number;
    });
    
    // 首页组件
    emitter.on({ eventId: EVENT_CART_UPDATED }, (data) => {
      this.refreshRecommendations();
    });
    
    // 消息中心
    emitter.on({ eventId: EVENT_CART_UPDATED }, (data) => {
      this.checkPromotions();
    });
    

    三个组件同时监听购物车更新事件,emit一次,三个都收到。这是@Prop/@Link做不到的——它们需要组件有明确的层级关系。

    登录状态同步

    经典场景:登录成功后,多个页面需要更新状态:

    const EVENT_USER_STATE_CHANGED = 2001;
    
    // 登录页
    async login(username: string, password: string): Promise {
      let user = await this.authService.login(username, password);
      AppStorage.setOrCreate('currentUser', user);
      emitter.emit({
        eventId: EVENT_USER_STATE_CHANGED,
        parameters: { isLogin: true, userId: user.id }
      });
    }
    
    // 退出登录
    logout(): void {
      this.authService.logout();
      AppStorage.delete('currentUser');
      emitter.emit({
        eventId: EVENT_USER_STATE_CHANGED,
        parameters: { isLogin: false }
      });
    }
    
    // 个人中心页
    aboutToAppear(): void {
      emitter.on({ eventId: EVENT_USER_STATE_CHANGED }, this.onUserStateChanged);
    }
    
    private onUserStateChanged = (data: emitter.EventData) => {
      let isLogin = data.parameters['isLogin'] as boolean;
      if (isLogin) {
        this.showUserInfo();
      } else {
        this.showLoginButton();
      }
    }
    

    为什么不直接用AppStorage? AppStorage的数据变化会触发UI刷新,但不会触发逻辑回调。比如退出登录时你不仅要更新UI,还要清理缓存、取消请求、重置状态——这些是业务逻辑,不是UI渲染。Emitter可以触发这些逻辑回调。

    封装事件总线

    直接用emitter的API有点啰嗦。封装一个类型安全的事件总线:

    class EventBus {
      private static instance: EventBus;
      private handlers: Map = new Map();
      static getInstance(): EventBus {
        if (!EventBus.instance) {
          EventBus.instance = new EventBus();
        }
        return EventBus.instance;
      }
      on(eventId: number, callback: emitter.Callback): void {
        let existing = this.handlers.get(eventId);
        if (existing === undefined) {
          existing = [];
        }
        existing.push(callback);
        this.handlers.set(eventId, existing);
        emitter.on({ eventId: eventId }, callback);
      }
      off(eventId: number, callback: emitter.Callback): void {
        let existing = this.handlers.get(eventId);
        if (existing !== undefined) {
          let newList: emitter.Callback[] = [];
          for (let i = 0; i < existing.length; i++) {
            if (existing[i] !== callback) {
              newList.push(existing[i]);
            }
          }
          this.handlers.set(eventId, newList);
        }
        emitter.off(eventId, callback);
      }
      emit(eventId: number, parameters?: Record): void {
        if (parameters !== undefined) {
          emitter.emit({ eventId: eventId, parameters: parameters });
        } else {
          emitter.emit({ eventId: eventId });
        }
      }
    }

    封装后使用更简洁:

    EventBus.getInstance().on(EVENT_LOGIN, this.onLogin);
    EventBus.getInstance().emit(EVENT_LOGIN, { userId: '123' });
    EventBus.getInstance().off(EVENT_LOGIN, this.onLogin);
    

    CommonEvent跨应用通信

    CommonEvent是系统级广播,可以跨应用、跨进程:

    import { commonEventManager } from '@kit.BasicServicesKit';
    
    // 订阅系统事件
    let subscriber = commonEventManager.createSubscriber({
      events: ['usual.event.SCREEN_OFF']
    });
    
    commonEventManager.subscribe(subscriber, (err, data) => {
      // 处理屏幕关闭事件
    });
    
    // 取消订阅
    commonEventManager.unsubscribe(subscriber);
    

    CommonEvent需要权限声明。 很多系统事件需要对应权限才能订阅。自定义事件不需要权限,但要确保事件名的唯一性——建议用包名作前缀:

    let CUSTOM_EVENT = 'com.example.app.ORDER_CREATED';

    CommonEvent发送

    发送自定义CommonEvent:

    commonEventManager.publish('com.example.app.ORDER_CREATED', {
      parameters: {
        orderId: '20240101001',
        amount: 99.9
      }
    }, (err) => {
      if (!err) {
        console.info('Event published');
      }
    });

    publish是异步的,回调在发送完成后触发。

    注意:CommonEvent的发送和接收可以在不同应用中。 这意味着你的事件可能被其他应用监听到,敏感数据不要直接放在parameters里。

    什么时候用CommonEvent

    CommonEvent的使用场景很明确:

    1. 监听系统事件:屏幕开关、网络变化、时区变化、电量变化
    2. 跨应用通知:支付应用通知订单完成,地图应用接收导航请求
    3. 多进程通信:同一个应用的UIAbility和ExtensionAbility在不同进程

    应用内通信不要用CommonEvent——它比Emitter重得多(涉及跨进程序列化),而且有权限和可见性问题。

    时序控制

    事件到达顺序不保证。如果A事件必须在B事件之前处理:

    const EVENT_STEP1_COMPLETE = 3001;
    
    // A完成后发事件
    emitter.emit({ eventId: EVENT_STEP1_COMPLETE });
    
    // B等A完成才执行
    emitter.on({ eventId: EVENT_STEP1_COMPLETE }, () => {
      this.executeStep2();
    });
    

    用事件链代替时序假设——A完成后emit通知,B监听通知再执行。不要假设emit是同步的。

    内存泄漏防护

    Emitter的回调如果不off,组件销毁后依然执行。最危险的情况:

    // 危险:匿名函数无法off
    emitter.on({ eventId: 1001 }, (data) => {
      this.updateUI(); // 组件已销毁,this可能无效
    });
    
    // 安全:保存引用,组件销毁时off
    private handler = (data: emitter.EventData) => {
      this.updateUI();
    }
    
    aboutToAppear(): void {
      emitter.on({ eventId: 1001 }, this.handler);
    }
    
    aboutToDisappear(): void {
      emitter.off(1001, this.handler);
    }
    

    规则:on和off必须成对出现,回调必须是类成员变量,不能是匿名函数。

    踩坑清单

    问题原因解决
    组件销毁后crash没off取消订阅aboutToDisappear中off
    off不掉匿名函数无法比较引用回调保存为类成员变量
    事件收不到Emitter跨进程不生效跨进程用CommonEvent
    收到重复事件多次on同一回调on前先off
    事件顺序不对emit不保证同步时序用事件链传递顺序
    CommonEvent收不到没声明权限检查module.json5权限
    自定义事件被拦截事件名不够唯一用包名作前缀
    参数类型丢失parameters反序列化只传基本类型
    数据敏感泄露CommonEvent跨应用可见敏感数据加密或用Emitter
    事件总线内存增长Map中回调越积越多off时清理Map记录

    事件总线是组件通信的“后门”——不用它时架构清晰,用了它时调用链隐晦。能用@Prop/@Link解决的不要用Emitter,能不跨进程的不要用CommonEvent。但当通信距离超出组件树范围时,事件总线就是最干净的解法。

    总结

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 HarmonyOS
    相关文章 更多
    华为Mate 70 Pro开箱:包装、机身外观与首次开机
    华为Mate 70 Pro开箱:包装、机身外观与首次开机

    华为Mate 70 Pro开箱要看哪些细节?查看包装型号与HarmonyOS标识、机身外观和欢迎语言界面,并通过华为官方产品入口核对信息。

    鸿蒙创建项目流程详细步骤图解教程
    鸿蒙创建项目流程详细步骤图解教程

    通过图文步骤演示如何在DevEco Studio中创建鸿蒙应用项目,涵盖模板选择、SDK配置及代码结构解析,确保新手能顺利生成并运行第一个Hello World工程。

    《鸿蒙互联极核宣布高德导航投屏功能上线需升级至HarmonyOS 6.0以上》
    《鸿蒙互联极核宣布高德导航投屏功能上线需升级至HarmonyOS 6.0以上》

    ZEEHO极核上线高德导航投屏功能,支持鸿蒙互联,手机需升级至HarmonyOS6.0及以上。用户通过ZEEHOApp选择目的地、完成个性化及权限设置后,即可一键投屏导航,实现手机与车机无缝联动。

    HarmonyOSAPP实战指南:画图APP之画笔属性调节
    HarmonyOSAPP实战指南:画图APP之画笔属性调节

    通过PenSettings单例管理器存储画笔颜色、粗细和透明度属性,结合ColorPicker色板选择与Slider滑块调节,实现画笔属性的实时控制。用户调整参数后立即应用于下一笔绘制,提升手绘功能的灵活性与实用性。

    微信如何自定义通知铃声-HarmonyOS专属提示音怎么设置
    微信如何自定义通知铃声-HarmonyOS专属提示音怎么设置

    想让你的HarmonyOS手机在收到微信消息时,响起与众不同的专属铃声吗?这个个性化设置其实并不复杂,几步操作就能让你的手机体验焕然一新。下面,我们就来详细拆解一下整个设置流程。 首先,从手机的全局设置入手。找到并打开你手机里的「设置」应用,在菜单列表中找到「声音和振动」这一项。点进去之后,你会看到

    华为 Sound X 智能音箱获 HarmonyOS 6.0.0.312 花粉尝鲜升级,新增支持 HUAWEI HiPlay
    华为 Sound X 智能音箱获 HarmonyOS 6.0.0.312 花粉尝鲜升级,新增支持 HUAWEI HiPlay

    华为 Sound X 智能音箱获 HarmonyOS 6.0.0.312 花粉尝鲜升级,新增支持 HUAWEI HiPlay 各位关心智能硬件的朋友应该注意到了,华为 Sound X 智能音箱近期有了新动作。3月26日消息,这款音箱已经面向花粉用户,开启了鸿蒙 HarmonyOS 6.0.0.312

    华为鸿蒙 HarmonyOS 6 系统沉浸光感视效更至 2.0 版本,效果三档可调
    华为鸿蒙 HarmonyOS 6 系统沉浸光感视效更至 2.0 版本,效果三档可调

    华为鸿蒙HarmonyOS 6沉浸光感视效更至2.0版本,效果三档可调 就在3月27日,华为开启了一波颇有诚意的系统更新推送。一批包括Mate 80/70/60系列、Pura 80/70系列在内的老机型,收到了HarmonyOS 6.0.0.328 SP52花粉Beta版。这次更新的重头戏,无疑是此

    华为 WATCH 5 / Ultimate / FIT 4 系列手表今启 HarmonyOS 6.0.0.328 花粉 Beta 版升级尝鲜招募
    华为 WATCH 5 / Ultimate / FIT 4 系列手表今启 HarmonyOS 6.0.0.328 花粉 Beta 版升级尝鲜招募

    华为WATCH 5/Ultimate/FIT 4系列开启鸿蒙4.0.0.328花粉Beta尝鲜招募 今天,对于华为智能手表的用户来说,有个值得关注的消息。华为官方正式宣布,为WATCH 5系列、Ultimate版以及FIT 4系列智能手表,启动了鸿蒙HarmonyOS 6.0.0.328版本的花粉B

    华为畅享 60X,畅享十一黄金周,一键畅享乐趣无限
    华为畅享 60X,畅享十一黄金周,一键畅享乐趣无限

    根据IDC发布的报告显示,今年第二季度,华为手机在中国区的市占率由去年同期的7.3%逆势上涨至13%,重回前五行列,增幅高达76.1%。这也是主流智能手机厂商中同比增幅最大的品牌。‏‏获得上述成绩,除了MateX3这些高端旗舰机的热销外,更离不开‏‏畅享60X‏‏这些产品的强势推动。‏华为在畅享系列产品上坚持将高端设计和高端配置普及化,为用户提供融合科技与时尚的绝妙体验,因此成为消费者的首选‏一个好消息是,近期已有几十款华为设备陆续升级了鸿蒙HarmonyOS4正式版,其中就包括千元定位的华为‏‏畅享60

    QQ影音怎么加速播放视频课程
    QQ影音怎么加速播放视频课程

    播放时右键选播放速度,或点控制条倍速,1.25 到 1.5 倍看课最舒服;公式代码类内容别超过 1.25 倍。

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

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

    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 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。