# LiveEventBus

**Repository Path**: wangyingjun02/LiveEventBus

## Basic Information

- **Project Name**: LiveEventBus
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 33
- **Created**: 2023-05-08
- **Last Updated**: 2023-05-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# LiveEventBus

## 简介

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

 ![showeventbus](./show/showeventbus.gif)


## 下载安装
```shell
ohpm install @ohos/liveeventbus 

```
OpenHarmony ohpm 环境配置等更多内容，请参考[如何安装 OpenHarmony ohpm 包](https://gitee.com/openharmony-tpc/docs/blob/master/OpenHarmony_har_usage.md)


## 使用说明

 在pages页面中使用

```js
//引入
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
  }
}
```

### 订阅消息

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

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



- 以Forever模式订阅消息

```js
 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
  ```

- 先定义消息，再发送消息

  ```js
  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' `

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

# 约束与限制

在下述版本验证通过：

DevEco Studio: 3.1 Beta2(3.1.0.400), SDK: API9 Release(3.2.11.9)

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

## 贡献代码
使用过程中发现任何问题都可以提 [Issue](https://gitee.com/openharmony-sig/LiveEventBus/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://gitee.com/openharmony-sig/LiveEventBus/pulls) 。

## 开源协议
本项目基于 [Apache License 2.0](https://gitee.com/openharmony-sig/LiveEventBus/blob/master/LICENSE) ，请自由地享受和参与开源。