Adapters (Bộ chuyển đổi)

Module WebSockets độc lập với nền tảng (platform-agnostic), do đó bạn có thể mang theo thư viện riêng (hoặc thậm chí một implementation thuần) bằng cách sử dụng interface WebSocketAdapter. Interface này buộc bạn phải implement một vài phương thức được mô tả trong bảng sau:

Mở rộng socket.io (Extend socket.io)

Package socket.io được bọc (wrap) trong một class IoAdapter. Điều gì sẽ xảy ra nếu bạn muốn mở rộng chức năng cơ bản của adapter? Ví dụ, yêu cầu kỹ thuật của bạn cần khả năng broadcast sự kiện qua nhiều instance load-balanced của web service. Để làm điều này, bạn có thể extend IoAdapter và override một phương thức duy nhất, có nhiệm vụ khởi tạo các socket.io server mới. Nhưng trước tiên, hãy cài đặt package cần thiết.

$ npm i --save redis socket.io @socket.io/redis-adapter

Sau khi cài đặt package xong, ta có thể tạo class RedisIoAdapter.

import { IoAdapter } from '@nestjs/platform-socket.io';
import { ServerOptions } from 'socket.io';
import { createAdapter } from '@socket.io/redis-adapter';
import { createClient } from 'redis';

export class RedisIoAdapter extends IoAdapter {
  private adapterConstructor: ReturnType<typeof createAdapter>;

  async connectToRedis(): Promise<void> {
    const pubClient = createClient({ url: `redis://localhost:6379` });
    const subClient = pubClient.duplicate();

    await Promise.all([pubClient.connect(), subClient.connect()]);

    this.adapterConstructor = createAdapter(pubClient, subClient);
  }

  createIOServer(port: number, options?: ServerOptions): any {
    const server = super.createIOServer(port, options);
    server.adapter(this.adapterConstructor);
    return server;
  }
}

Sau đó, chỉ cần chuyển sang dùng Redis adapter vừa tạo.

const app = await NestFactory.create(AppModule);
const redisIoAdapter = new RedisIoAdapter(app);
await redisIoAdapter.connectToRedis();

app.useWebSocketAdapter(redisIoAdapter);

Thư viện Ws (Ws library)

Một adapter khác có sẵn là WsAdapter, đóng vai trò như một proxy giữa framework và thư viện ws cực nhanh, được kiểm thử kỹ lưỡng. Adapter này tương thích hoàn toàn với WebSocket gốc của trình duyệt (native browser WebSockets) và nhanh hơn đáng kể so với package socket.io. Tuy nhiên, nó có ít tính năng có sẵn hơn nhiều. Trong một số trường hợp, bạn không thực sự cần đến những tính năng đó.

Để dùng ws, trước tiên ta cần cài đặt package cần thiết:

$ npm i --save @nestjs/platform-ws

Sau khi cài đặt package xong, ta có thể chuyển sang adapter khác:

const app = await NestFactory.create(AppModule);
app.useWebSocketAdapter(new WsAdapter(app));

wsAdapter được thiết kế để xử lý message ở định dạng { event: string, data: any }. Nếu bạn cần nhận và xử lý message ở định dạng khác, bạn sẽ cần cấu hình một message parser để chuyển đổi chúng về định dạng yêu cầu này.

const wsAdapter = new WsAdapter(app, {
  // Để xử lý message ở định dạng [event, data]
  messageParser: (data) => {
    const [event, payload] = JSON.parse(data.toString());
    return { event, data: payload };
  },
});

Ngoài ra, bạn cũng có thể cấu hình message parser sau khi adapter đã được tạo, bằng phương thức setMessageParser.

Nâng cao (custom adapter) (Advanced (custom adapter))

Để minh họa, chúng ta sẽ tích hợp thư viện ws một cách thủ công. Như đã đề cập, adapter cho thư viện này đã được tạo sẵn và được export từ package @nestjs/platform-ws dưới dạng class WsAdapter. Dưới đây là cách mà một implementation đơn giản hóa có thể trông như thế nào:

import WebSocket from 'ws';
import { WebSocketAdapter, INestApplicationContext } from '@nestjs/common';
import { MessageMappingProperties } from '@nestjs/websockets';
import { Observable, fromEvent, EMPTY } from 'rxjs';
import { mergeMap, filter } from 'rxjs/operators';

export class WsAdapter implements WebSocketAdapter {
  constructor(private app: INestApplicationContext) {}

  create(port: number, options: any = {}): any {
    return new WebSocket.Server({ port, ...options });
  }

  bindClientConnect(server, callback: Function) {
    server.on('connection', callback);
  }

  bindMessageHandlers(
    client: WebSocket,
    handlers: MessageMappingProperties[],
    process: (data: any) => Observable<any>,
  ) {
    fromEvent(client, 'message')
      .pipe(
        mergeMap(data => this.bindMessageHandler(data, handlers, process)),
        filter(result => result),
      )
      .subscribe(response => client.send(JSON.stringify(response)));
  }

  bindMessageHandler(
    buffer,
    handlers: MessageMappingProperties[],
    process: (data: any) => Observable<any>,
  ): Observable<any> {
    const message = JSON.parse(buffer.data);
    const messageHandler = handlers.find(
      handler => handler.message === message.event,
    );
    if (!messageHandler) {
      return EMPTY;
    }
    return process(messageHandler.callback(message.data));
  }

  close(server) {
    server.close();
  }
}

Sau đó, ta có thể thiết lập một custom adapter bằng phương thức useWebSocketAdapter():

const app = await NestFactory.create(AppModule);
app.useWebSocketAdapter(new WsAdapter(app));

Ví dụ (Example)

Một ví dụ hoạt động sử dụng WsAdapter có sẵn tại đây.