How to Get websockets working with NestJS

在NestJS中，使用WebSocket通常涉及使用库，如Socket.IO或ws，与NestJS的抽象层一起工作，以便轻松集成和维护。NestJS提供了一个名为@nestjs/websockets的模块，它包含了与WebSocket交互时需要的装饰器和类。

以下是在NestJS中使用WebSocket的基本步骤：

1. 安装必要的包

首先，确保安装了@nestjs/websockets模块和socket.io库（如果你选择使用Socket.IO）：

bash
npm install @nestjs/websockets @nestjs/platform-socket.io socket.io

2. 创建Gateway

在NestJS中，你可以创建一个Gateway，这是一个使用@WebSocketGateway()装饰器的类，它将处理WebSocket连接。例如：

typescript
import { WebSocketGateway, WebSocketServer, SubscribeMessage, MessageBody, ConnectedSocket } from '@nestjs/websockets';
import { Server, Socket } from 'socket.io';

@WebSocketGateway({ cors: true })
export class EventsGateway {
  @WebSocketServer()
  server: Server;

  @SubscribeMessage('message')
  handleMessage(@MessageBody() data: string, @ConnectedSocket() client: Socket): void {
    client.emit('message', data); // Echo the message back to the client
  }
}

在这个例子中，EventsGateway类使用@WebSocketGateway装饰器来创建一个WebSocket服务器。我们监听名为message的事件，并定义了一个处理函数handleMessage来处理收到的消息。

3. 在Module中注册Gateway

接下来，需要在NestJS模块中注册这个Gateway：

typescript
import { Module } from '@nestjs/common';
import { EventsGateway } from './events.gateway';

@Module({
  providers: [EventsGateway],
})
export class AppModule {}

这样，我们的EventsGateway就会被NestJS框架识别，并在应用程序启动时自动启动WebSocket服务器。

4. 连接WebSocket客户端

客户端可以使用socket.io-client库或者其他WebSocket客户端库来连接到服务器：

javascript
// Using socket.io-client in the client-side code
const socket = io('http://localhost:3000');
socket.on('message', function(data) {
  console.log('Received message:', data);
});
socket.emit('message', 'Hello, server!'); // Send a message to the server

上述客户端代码示例是使用socket.io-client连接到NestJS服务并监听message事件。客户端还通过emit发送一个名为message的事件至服务端。

5. 高级功能的使用

NestJS WebSocket模块还支持更高级的功能，如命名空间/房间、异常过滤器、管道、拦截器和守卫，允许开发者构建具有复杂逻辑和安全性的WebSocket应用程序。

举个例子，如果你想要只向特定房间内的客户端发送消息，可以这样做：

typescript
@SubscribeMessage('joinRoom')
async handleJoinRoom(@MessageBody() room: string, @ConnectedSocket() client: Socket) {
  client.join(room); // Join the specified room
}

@SubscribeMessage('leaveRoom')
async handleLeaveRoom(@MessageBody() room: string, @ConnectedSocket() client: Socket) {
  client.leave(room); // Leave the specified room
}

async sendMessageToRoom(room: string, message: string) {
  this.server.to(room).emit('message', message); // Emit a message to all clients in the specified room
}

这个示例中，我们创建了加入和离开房间的事件处理器，以及一个向指定房间内所有客户端发送消息的函数。

通过以上步骤，你可以在NestJS中设置和使用WebSocket通信。当然，根据实际应用场景的不同，可能需要进行相应的调整和优化。