## MQTT [MQTT](http://mqtt.org/)是一个开源的轻量级消息协议，用于高延迟优化。该协议提供了一个可扩展的低开销的方式，使用`publish/subscribe`模式连接设备。一个基于MQTT协议的通讯系统由发布服务器，中间人和一个或多个客户端组成。它设计为应用于受限制的设备和低带宽、高延迟或不可信任的网络中。 ### 安装 在我们开始之前，我们必须安装所需的包： ``` $ npm i --save mqtt ``` ### 概览 为了切换到 `MQTT` 传输协议，我们需要修改传递给该 `createMicroservice()` 函数的选项对象。 > main.ts ```typescript const app = await NestFactory.createMicroservice<MicroserviceOptions>(AppModule, { transport: Transport.MQTT, options: { url: 'mqtt://localhost:1883', }, }); ``` > `Transport` 枚举需要从 `@nestjs/microservices` 包导入。 ### 选项 有很多可用的`options`对象可以决定传输器的行为。更多描述请[查看](https://github.com/mqttjs/MQTT.js)。 ### 客户端 像其他微服务传输器一样，你可以在创建`ClientProxy`实例时传输[一些选项](https://docs.nestjs.com/microservices/basics#client)。 一种来创建实例的方法是使用`ClientsModule`。要使用`ClientsModule`创建一个客户端实例，引入并使用`register()`方法并传递一个 `options` 对象，该对象具有与前面在 `createMicroservice()` 方法具有相同的属性。`name`属性被用于注入`token`，更多关于`ClientsModule`内容参见[这里](https://docs.nestjs.com/microservices/basics#client)。 ```typescript @Module({ imports: [ ClientsModule.register([ { name: 'MATH_SERVICE', transport: Transport.MQTT, options: { url: 'mqtt://localhost:1883', } }, ]), ] ... }) ``` 也可以使用其他创建客户端的实例（ `ClientProxyFactory` 或 `@Client()` ）。 ### 上下文 在更复杂的场景中，您可能希望访问关于传入请求的更多信息。在`MQTT` 中，您可以访问 `MqttContext`对象。 ```typescript @MessagePattern('notifications') getNotifications(@Payload() data: number[], @Ctx() context: MqttContext) { console.log(`Topic: ${context.getTopic()}`); } ``` > `@Payload()`， `@Ctx()` 和 `MqttContext` 需要从 `@nestjs/microservices` 包导入. ### 通配符 一个订阅可能是一个显式的`topic`或者包含通配符，`+`和`#`两个通配符可以用在这里，`+`表示单层通配符而 `#`表示多层通配符，可以涵盖很多`topic`层次。 ```typescript @MessagePattern('sensors/+/temperature/+') getTemperature(@Ctx() context: MqttContext) { console.log(`Topic: ${context.getTopic()}`); } ``` ### 记录建设者 要配置消息选项（调整 `QoS` 级别、设置 `Retain` 或 `DUP` 标志，或向负载添加其他属性），您可以使用 `MqttRecordBuilder` 类。例如，要将 `QoS` 设置为 2，请使用 `setQoS` 方法，如下所示： ~~~typescript const userProperties = { 'x-version': '1.0.0' }; const record = new MqttRecordBuilder(':cat:') .setProperties({ userProperties }) .setQoS(1) .build(); client.send('replace-emoji', record).subscribe(...); ~~~ > **提示** `MqttRecordBuilder` 类是从 `@nestjs/microservices` 包中导出的。 您也可以通过访问 `MqttContext` 在服务器端读取这些选项。 ~~~typescript @MessagePattern('replace-emoji') replaceEmoji(@Payload() data: string, @Ctx() context: MqttContext): string { const { properties: { userProperties } } = context.getPacket(); return userProperties['x-version'] === '1.0.0' ? '🐱' : '🐈'; } ~~~ 在某些情况下，您可能希望为多个请求配置用户属性，您可以将这些选项传递给 `ClientProxyFactory`。 ~~~typescript import { Module } from '@nestjs/common'; import { ClientProxyFactory, Transport } from '@nestjs/microservices'; @Module({ providers: [ { provide: 'API_v1', useFactory: () => ClientProxyFactory.create({ transport: Transport.MQTT, options: { url: 'mqtt://localhost:1833', userProperties: { 'x-version': '1.0.0' }, }, }), }, ], }) export class ApiModule {} ~~~