1# 使用Emitter进行线程间通信
2
3
4Emitter是一种作用在进程内的事件处理机制，为应用程序提供订阅事件、发布事件、取消事件订阅的能力。
5
6## 场景介绍
7
8Emitter用于同一进程内相同线程或不同线程间的事件处理，事件异步执行。使用时需要先订阅一个事件，然后发布该事件，发布完成后Emitter会将已发布的事件分发给订阅者，订阅者就会执行该事件订阅时设置的回调方法。当不需要订阅该事件时应及时取消订阅释放Emitter资源。
9
10## 运作机制
11Emitter通过维护一个内部事件队列，来进行任务分发。应用需要先订阅某个事件并设置好该事件的回调方法，当应用程序发布事件后，就会往队列里面插入一个事件。任务队列会串行执行队列里面的任务，执行任务时会调用该任务订阅者的回调方法进行事件处理。
12
13![emitter](figures/emitter.png)
14
15## 接口说明
16详细请参见[Emitter接口文档](../../reference/apis-basic-services-kit/js-apis-emitter.md)。
17| 接口名  | 用途   | 说明     |
18| ------- | ------ | -------- |
19| on | 订阅事件 | 持续订阅事件，直至该事件被取消订阅。 |
20| once | 订阅事件 | 订阅事件一次。 |
21| emit | 发布事件 | 发布事件一次。 |
22| off | 取消事件订阅 | 取消事件订阅后，将不再接收该事件的消息。 |
23
24## 开发步骤
25
26使用Emitter实现事件订阅、事件发送以及事件删除，开发步骤如下。
27
281. 导入模块。
29
30   ```ts
31   import { emitter } from '@kit.BasicServicesKit';
32   ```
33
342. 订阅事件。
35
36   订阅事件使用on（持续订阅）或者once（单次订阅）接口进行订阅，设置要订阅的事件以及接收到事件后的回调函数。
37   ```ts
38    // 定义一个eventId为1的事件。
39    let event: emitter.InnerEvent = {
40      eventId: 1
41    };
42
43    // on订阅事件，收到eventId为1的事件后执行回调函数。
44    emitter.on(event, () => {
45      console.info('on callback');
46    });
47   ```
48
49   ```ts
50   // 收到eventId为1的事件后执行回调函数。
51   // 注意：once订阅只接收一次事件，on订阅则一直接收直到取消订阅为止。
52   emitter.once(event, () => {
53     console.info('once callback');
54   });
55   ```
56
573. 发送事件。
58
59   发送事件使用emit接口进行发送，设置要发送的事件以及要传递的参数。
60   ```ts
61   // 定义一个eventId为1的事件，事件优先级为Low。
62   let event: emitter.InnerEvent = {
63     eventId: 1,
64     priority: emitter.EventPriority.LOW
65   };
66
67   //订阅该事件，并接收eventData数据。
68   emitter.once(event, (eventData : emitter.EventData) => {
69     console.info('enter callback, eventData-content:' + eventData?.data?.content);
70     console.info('enter callback, eventData-id:' + eventData?.data?.id);
71     console.info('enter callback, eventData-isEmpty:' + eventData?.data?.isEmpty);
72   });
73
74   let eventData: emitter.EventData = {
75     data: {
76       content: 'emitter',
77       id: 1,
78       isEmpty: false
79     }
80   };
81
82   // 发送eventId为1的事件，事件内容为eventData。
83   emitter.emit(event, eventData);
84   ```
85
864. 取消事件订阅。
87    > **说明：**
88    >
89    > 当不需要订阅某个事件时，需要及时取消订阅避免造成内存泄漏。
90
91    取消事件订阅使用off接口进行取消，设置要取消的事件ID。
92   ```ts
93   // 取消eventId为1的事件。
94   emitter.off(1);
95   ```
96