NATS · Nest.js 中文文档

## NATS [NATS](https://nats.io) 是一个简单、高性能的云应用原生、物联网和微服务架构应用的开源消息系统。`NATS`服务器使用`Go`语言编写，但客户端可以通过各种主流语言与服务器交互。`NATS`支持最多一次和最少一次的传输。可以在任何地方运行，从大型服务器和云实例到边缘网关甚至物联网设备都能运行。 ### 安装在开始之前，我们必须安装所需的软件包: ``` $ npm i --save nats@^1.4.12 ``` ### 概述为了切换到 **NATS** 传输器，我们需要修改传递到 `createMicroservice()` 方法的选项对象。 > main.ts ```typescript const app = await NestFactory.createMicroservice<MicroserviceOptions>(AppModule, { transport: Transport.NATS, options: { url: 'nats://localhost:4222', }, }); ``` > `Transport` 需要从 `@nestjs/microservices` 包导入。 ### 选项 `options`对象和选择的传输器有关，`NATS`传输器暴露了一些属性，见[这里](https://github.com/nats-io/node-nats#connect-options)，它还有一个额外的`queue`属性，允许你指定要从服务器订阅的队列名称。(如果要忽略该配置可以设置为`undefined`)。 ### 客户端像其他微服务传输器一样，你可以在创建`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.NATS, options: { url: 'nats://localhost:4222', } }, ]), ] ... }) ``` 也可以使用其他创建客户端的实例（ `ClientProxyFactory` 或 `@Client()` ）。 ### 请求-响应请求-响应消息风格下，NATS不是使用内置的[请求-应答(Request-Reply](https://docs.nats.io/nats-concepts/reqreply)机制。相反，一个“请求”通过给定主题使用```publish()```方法携带一个答复主题名称发布，，监听该主题的响应者将响应发送给答复主题(reply subject)。答复主题无论位于何处，它都将动态地直接返回给请求者。 ### 基于事件基于事件的风格下，NATS使用内置的[发布-订阅(Publish-Subscribe)](https://docs.nats.io/nats-concepts/pubsub)机制。发布者发布一个基于主题的消息，该消息的订阅者都会收到此消息。订阅者也可以通过通配符来实现类似正则表达式的订阅。这种一对多的模式有时被称为扇出(fan-out)。 ### 队列分类 NATS提供了一个内置的平衡特性叫做[分布式队列](https://docs.nats.io/nats-concepts/queue)。如下使用`queue`属性创建一个队列订阅。 ```typescript const app = await NestFactory.createMicroservice(AppModule, { transport: Transport.NATS, options: { url: 'nats://localhost:4222', queue: 'cats_queue', }, }); ``` ### 上下文在更复杂的场景中，您可能希望访问关于传入请求的更多信息。在`NATS` 中，您可以访问 `NatsContext`对象。 ```typescript @MessagePattern('notifications') getNotifications(@Payload() data: number[], @Ctx() context: NatsContext) { console.log(`Subject: ${context.getSubject()}`); } ``` > `@Payload()`， `@Ctx()` 和 `NatsContext` 需要从 `@nestjs/microservices` 包导入. ### 通配符订阅可以是确定的或者包含通配符的。 ```typescript @MessagePattern('time.us.*') getDate(@Payload() data: number[], @Ctx() context: NatsContext) { console.log(`Subject: ${context.getSubject()}`); // e.g. "time.us.east" return new Date().toLocaleTimeString(...); } ``` ### 记录建设者要配置消息选项，您可以使用`NatsRecordBuilder`该类（注意：这对于基于事件的流也是可行的）。例如添加`x-version`header，使用`setHeaders`方法，如下： ~~~typescript import * as nats from 'nats'; // somewhere in your code const headers = nats.headers(); headers.set('x-version', '1.0.0'); const record = new NatsRecordBuilder(':cat:').setHeaders(headers).build(); this.client.send('replace-emoji', record).subscribe(...); ~~~ > **提示**`NatsRecordBuilder``@nestjs/microservices`类是从包中导出的。您也可以通过访问来在服务器端读取这些标头`NatsContext`，如下所示： ~~~typescript @MessagePattern('replace-emoji') replaceEmoji(@Payload() data: string, @Ctx() context: NatsContext): string { const headers = context.getHeaders(); return headers['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.NATS, options: { servers: ['nats://localhost:4222'], headers: { 'x-version': '1.0.0' }, }, }), }, ], }) export class ApiModule {} ~~~