使用Emitter进行线程间通信

介绍

1. 该工程介绍了如何使用Emitter进行线程间通信，给出示例代码，帮助开发者更快上手。
2. Emitter是一种作用在进程内的事件处理机制，为应用程序提供订阅事件、发布事件、取消事件订阅的能力。
3. Emitter用于同一进程内相同线程或不同线程间的事件处理，事件异步执行。使用时需要先订阅一个事件，然后发布该事件，发布完成后Emitter会将已发布的事件分发给订阅者，订阅者就会执行该事件订阅时设置的回调方法。当不需要订阅该事件时应及时取消订阅释放Emitter资源。

运行机制

Emitter通过维护一个内部事件队列，来进行任务分发。应用需要先订阅某个事件并设置好该事件的回调方法，当应用程序发布事件后，就会往队列里面插入一个事件。任务队列会串行执行队列里面的任务，执行任务时会调用该任务订阅者的回调方法进行事件处理。

使用说明

1. 打开应用，点击订阅eventId为1的事件按钮会进行事件的订阅
2. 点击发送eventId为1的事件按钮会进行事件的发送
3. 在日志中会打印出具体的事件信息
4. 点击取消订阅eventId为1的事件按钮会取消事件订阅

工程目录

entry/src/main
├─ets                      // ArkTS 源码核心目录
│  ├─entryability          // 应用入口能力类目录（程序启动入口）
│  ├─entrybackupability    // 备份入口能力类目录
│  └─pages                 // 页面代码目录（存放 UI 页面逻辑）
│      └─index             // Emitter通信
└─resources                // 模块专属资源目录
    ├─base                 // 基础资源目录（默认主题）
    │  ├─element           // 基础元素配置（字符串、颜色、尺寸等）
    │  ├─media             // 基础媒体资源（图片、图标等）
    │  └─profile           // 基础配置文件（如页面路由配置）
    ├─dark                 // 深色主题资源目录
    │  └─element           // 深色主题元素配置（字符串、颜色等）
    └─rawfile              // 原始文件目录（存放无需编译的原生文件）

具体实现

使用Emitter实现事件订阅、事件发送以及事件删除，源码参考Index.ets,开发步骤如下。

1. 导入模块：导入emitter和Callback 模块。
2. 订阅事件：点击“订阅eventId为1的事件”按钮，使用on（持续订阅）或者once（单次订阅）接口进行订阅，设置要订阅的事件以及接收到事件后的回调函数。
3. 发送事件：点击“发送eventId为1的事件”按钮，使用emit接口进行发送，设置要发送的事件以及要传递的参数。
4. 取消事件：点击“取消订阅eventId为1的事件”按钮，订阅使用off接口进行取消，已通过emit接口发布但尚未被执行的事件将被取消。

相关权限

不涉及。

依赖

不涉及。

约束与限制

1. 本示例仅支持标准系统上运行，支持设备：RK3568。
2. 本示例支持API version 20及以上版本的SDK。
3. 本示例已支持使DevEco Studio 6.0.0 Release (构建版本：6.0.0.878，构建 2025年12月24日)编译运行。

下载

如需单独下载本工程，执行如下命令：

git init
git config core.sparsecheckout true
echo Basic-Services-Kit/common_event/Emitter > .git/info/sparse-checkout
git remote add origin https://gitcode.com/harmonyos_samples/guide-snippets.git
git pull origin master