#跟着晓明学鸿蒙# 鸿蒙Next开发中ohpm三方库使用指南之ohos-liveeventbus集成示例

_Indulge

16人浏览 · 2025-05-21 20:22:14

_Indulge · 2025-05-21 20:22:14 发布

LiveEventBus

简介

LiveEventBus是一款消息总线，具有生命周期感知能力，支持Sticky，支持跨进程，支持跨APP发送消息。

showeventbus

下载安装

ohpm install @ohos/liveeventbus

OpenHarmony ohpm 环境配置等更多内容，请参考如何安装 OpenHarmony ohpm 包

使用说明

在pages页面中使用

//引入
import { LiveEventBus,Lifecycle,MState } from '@ohos/liveeventbus'
import router from '@system.router';

const KEY_TEST_CLOSE_ALL_PAGE = "key_test_close_all_page";
@Entry
@Component
struct Demo {
 private mLifecycle: Lifecycle;
 aboutToAppear() {
  //创建生命周期感知对象
  this.mLifecycle = new Lifecycle(MState.STARTED)
  //订阅消息
  LiveEventBus
      .get<boolean>(KEY_TEST_CLOSE_ALL_PAGE)
      .observe(this, {
        onChanged(b:boolean) {
          if (b) {
            router.clear()
            router.back()
          }
        }
      });
 }
 build() {
    Column({ space: 10 }) {
      Text('LiveEventBus Demo')
        .fontSize(30)
        .fontWeight(FontWeight.Bold)
      Scroll() {
        Column({ space: 5 }) {
         Button('关闭All').onClick(event => {
            this.closeAll()
          })
        }
       }
     }
   }
 
 closeAll() {
    //发送消息
    LiveEventBus.get(KEY_TEST_CLOSE_ALL_PAGE).post(true);
  }
    
 aboutToDisappear() {
    destroyService()
    this.mLifecycle.markState(MState.DESTROYED)
  }
 
 //生命周期感知对象
 getLifecycle(): Lifecycle{
    return this.mLifecycle
  }
}

订阅消息

以生命周期感知模式订阅消息

    LiveEventBus
      .get<string>("name")
      .observe(this, {
        onChanged(s) {
          showToast(s);
        }
      });

以Forever模式订阅消息

 LiveEventBus
    .get<string>("name")
    .observeForever(observer);

发送消息

不定义消息直接发送

LiveEventBus
	.get("some_key")
	.post(some_value);

发送消息给ObserveForver注册的订阅者

LiveEventBus.get(KEY_TEST_OBSERVE_FOREVER)
      .post("Message To ForeverObserver: " + nextInt(100));

进程内发送消息
```
post(value: T): void
```
App之间发送消息

postAcrossProcess(value: T): void

延迟发送

postOrderly(value: T): void

延迟发送带生命周期

postDelay(value: T, delay: number, sender?: LifecycleOwner): void

以广播形式发送消息
```
broadcast(value: T): void
```

先定义消息，再发送消息

class DemoEvent {
  content: string

  constructor(content: string) {
    this.content = content
  }
}

LiveEventBus
      .get<string>('DemoEvent')
      .post(JSON.stringify(new DemoEvent("Hello world")));

更多详细用法请参考开源库Demo页面的实现

接口说明

import { LiveEventBus } from '@ohos/liveeventbus'

进程内发送消息 LiveEventBus.get("key").post()
App之间发送消息 LiveEventBus.get("key").postAcrossApp()
进程内发送消息，延迟发送，带生命周期 LiveEventBus.get("key").postDelay()
以广播的形式发送一个消息 LiveEventBus.get("key").broadcast()
注册一个Observer，生命周期感知，自动取消订阅 LiveEventBus.get("key").observe()
注册一个Observer，如果之前有消息发送，可以在注册时收到消息（消息同步） LiveEventBus.get("key").observeSticky()
注册一个Observer，需手动解除绑定 LiveEventBus.get("key").observeForever()
注册一个Observer，如果之前有消息发送，可以在注册时收到消息（消息同步） LiveEventBus.get("key").observeStickyForever()
通过observeForever或observeStickyForever注册的，需要调用该方法取消订阅 LiveEventBus.get("key").removeObserver()
取消App之间的消息订阅 LiveEventBus.get("key").unsubscribe()

关于混淆

代码混淆，请查看代码混淆简介
如果希望liveeventbus库在代码混淆过程中不会被混淆，需要在混淆规则配置文件obfuscation-rules.txt中添加相应的排除规则：

-keep
./oh_modules/@ohos/liveeventbus

约束与限制

在下述版本验证通过：

DevEco Studio: NEXT Beta1-5.0.3.806, SDK:API12 Release(5.0.0.66)
DevEco Studio NEXT Developer Preview1: (4.1.3.501), SDK: API11 (4.1.0.57 SP6)

目录结构

|---- LiveEventBus  
|     |---- entry  # 示例代码文件夹
|     |---- library  # LiveEventBus库文件夹
|           |---- index.ts  # 对外接口
|           └─src/main/ets/LiveEventBus
|                          ├─core # 核心代码，事件总线处理类等
|                          ├─lifecycle # 生命周期数据处理
|                          ├─logger # 日志打印处理
|                          └─tslivedata # ts版livedata
|                 |---- GlobalContext  # GlobalContext替代globalThis配置
|                 |---- LiveEventBus  # LiveEventBus核心类
|---- README.md  # 安装使用方法    
|---- README_zh.md  # 安装使用方法