github-actions[bot]
99d5aa2589
Created by Github action Co-authored-by: github-actions <github-actions@twenty.com>
43 lines
1.1 KiB
Plaintext
43 lines
1.1 KiB
Plaintext
---
|
|
title: 消息队列
|
|
---
|
|
|
|
队列支持异步操作的执行。 它们可用于执行后台任务，例如在注册时发送欢迎邮件。
|
|
每个用例都将拥有一个继承自 `MessageQueueServiceBase` 的队列类。
|
|
|
|
当前，我们仅支持使用 `bull-mq`[bull-mq](https://bullmq.io/) 作为队列驱动。
|
|
|
|
## 创建和使用新队列的步骤
|
|
|
|
1. 在枚举 `MESSAGE_QUEUES` 下为您的新队列添加队列名称。
|
|
2. 提供以队列名称为依赖令牌的队列工厂实现。
|
|
3. 在所需模块/服务中以队列名称作为依赖令牌注入您创建的队列。
|
|
4. 添加与生产者相同令牌注入的工作类。
|
|
|
|
### 示例用法
|
|
|
|
```ts
|
|
类 Resolver {
|
|
构造函数(@Inject(MESSAGE_QUEUES.custom) 私有队列: MessageQueueService) {}
|
|
|
|
异步某行为事件() {
|
|
//业务逻辑
|
|
await this.queue.add(someData);
|
|
}
|
|
}
|
|
|
|
//异步工作者
|
|
类 CustomWorker {
|
|
构造函数(@Inject(MESSAGE_QUEUES.custom) 私有队列: MessageQueueService) {
|
|
this.initWorker();
|
|
}
|
|
|
|
异步 initWorker() {
|
|
await this.queue.work(async ({ id, data }) => {
|
|
//工作者逻辑
|
|
});
|
|
}
|
|
}
|
|
|
|
```
|