【HarmonyOS】应用通知广播的使用

【HarmonyOS】应用通知广播的使用

一、通知广播是什么?

应用开发多年的同学,对于时间通知广播是比较熟悉。一般刚接触的同学可能不太清楚,下面简单介绍一下,了解的同学可以跨过,直接看第二节。

通知广播,见名知意,是为了实现将信息,通知给所有人的一种程序方式。那代码中对于信息的形态,通知给所有人的范围就会有定义。

一般而言通知广播会有一个注册key的实例来处理所有广播。每一个广播的发送也是通过这个key发给所有人进行广播。

举一个栗子,我有三家报社有订阅会员机制,报社分别是ABC三家。

对于想看A报社的人来说,只需要去A报社进行订阅即可。这个订阅行为在代码中就是注册key的过程。相应的广播方式,当然也是根据是否有订阅来决定。

其实鸿蒙中的事件广播迭代版本很有意思,在api7的时代,系统应用源码中就就已经有工具类的存在,eventBus的使用很多,例如相机的源码。相机各种状态同步给所有view,基本都是通过广播的形式通知。

虽然鸿蒙中对于子母组件有各种状态同步和监听机制,但是在纯逻辑处理类中就不适用了。所以才会有事件通知广播的场景需求。

随着鸿蒙API的版本迭代,在API10正式将给工具类并入到了系统接口中,方便大家的使用。

曾几何时,两年前我还在开发Openharmony时,都是自己封装的EventBusMgr使用,现在可以直接替换为官网api。基本无感知替换。可见该工具类的受欢迎程度。

二、鸿蒙中如何使用事件通知广播?

EventHub被存放在context上下文中,是单例模式,只有一个。每次可通过上下文获取到该实例。

该实例共有三个函数,分别是emit发送广播,on监听广播,off取消监听广播。

广播发送的包裹可以是任意类型。

三、Demo示例:

DEMO讲解通过注释的方式表明。若有不清楚的点,可关注私信我沟通。

dart 复制代码
import { BusinessError } from '@kit.BasicServicesKit';
import { promptAction } from '@kit.ArkUI';
import { common } from '@kit.AbilityKit';

@Entry
@Component
struct EventHubPage {

  private TAG: string = "EventHubPage";

  private noticeIsDone: boolean = false;

  private TEST_KEY: string = "TEST_KEY";

  private eventHub(){
    let context = getContext() as common.UIAbilityContext;
    return context.eventHub;
  }

  // 这里是收到广播的回调处理
  onTestKey = (noticeIsDone: boolean)=>{
    if(noticeIsDone){
      this.showToast("收到通知,完成!");
    }else{
      this.showToast("收到通知,失败!");
    }
  }

  onClickNotice = ()=>{
    this.noticeIsDone = !this.noticeIsDone;
    // 第二个参数就是需要广播出去的包裹,这里我以boolean类型举例
    this.eventHub().emit(this.TEST_KEY, this.noticeIsDone);
  }

  onClickRegister = ()=>{
    this.eventHub().on(this.TEST_KEY, this.onTestKey);
    this.showToast("注册监听成功!");
  }

  onClickUnRegister = ()=>{
    this.eventHub().off(this.TEST_KEY, this.onTestKey);
    this.showToast("取消注册监听!");
  }

  private showToast(content: string){
    try {
      promptAction.showToast({
        message: content,
        duration: 2000
      });
    } catch (error) {
      let message = (error as BusinessError).message
      let code = (error as BusinessError).code
      console.error(this.TAG, `showToast args error code is ${code}, message is ${message}`);
    };
  }

  /**
   * 统一样式封装
   */
  @Styles ButtonStyle(){
    .width(px2vp(350))
    .height(px2vp(200))
    .margin({ top: px2vp(66) })
  }

  build() {
    Column(){
      Button("发送广播")
        .ButtonStyle()
        .onClick(this.onClickNotice)

      Button("设置注册监听")
        .ButtonStyle()
        .onClick(this.onClickRegister)

      Button("取消注册监听")
        .ButtonStyle()
        .onClick(this.onClickUnRegister)

    }.size({
      width: "100%",
      height: "100%"
    })
  }
}

注意:封装唯一性。因为在不同window中会导致获取的eventhub 不是一个。


dart 复制代码
import { common } from '@kit.AbilityKit';

export class EventHubUtils {

  private static mEventHub: common.EventHub | null = null;

  /**
   * 获取事件通知实例
   * @returns
   */
  public static getEventHub(){
    // 封装唯一性。因为在不同window中会导致获取的eventhub 不是一个。
    if(!EventHubUtils.mEventHub){
      let context = getContext() as common.UIAbilityContext;
      EventHubUtils.mEventHub = context.eventHub;
      console.log("EventHubUtils", "EventIns mEventHub done !");
    }
    return EventHubUtils.mEventHub;
  }
}
相关推荐
爱写Bug的浮游8 小时前
初识仓颉:5 分钟看懂核心语法
harmonyos·编程语言
羽落•无痕(苏晗默)10 小时前
华为数通IA——14、网络服务与应用:TCP/UDP 传输层协议与 FTP、Telnet、SSH 实践
网络·网络协议·tcp/ip·网络安全·华为·udp·信息与通信
程序猿追21 小时前
鸿蒙 PC 的 Ionic 工单有两个错误,按下生成后光标该去哪儿
华为·harmonyos
KevinChaos1 天前
随手备忘录手记 04|HarmonyOS 7.0新特性实验:物品图鉴的加载逻辑
华为·harmonyos
Sirius_Ji1 天前
从硬解基座到字幕与滤镜链:ffmpeg-for-HarmonyOS v0.3.2
harmonyos
用户86194177207411 天前
uni-app 鸿蒙端提现点不动?我用 UTS 插件补上了微信"确认收款"
微信·harmonyos
码间留白1 天前
uni-app 鸿蒙端提现点不动?我用 UTS 插件补上了微信"确认收款"
uni-app·harmonyos·鸿蒙·uts插件·微信商家转账
GitCode官方2 天前
开源鸿蒙跨平台直播|AI 时代,用 cj-tauri 开发鸿蒙 PC 应用
人工智能·华为·harmonyos·atomgit
程序猿追2 天前
鸿蒙 PC 用 Tauri 做本地查找,怎样让慢请求给新请求让路
华为·状态模式·harmonyos
程序猿追2 天前
鸿蒙 PC 用 Ionic 做巡检目录,缩窄窗口后草稿还在吗
华为·harmonyos