Socket.io无法连接NestJS 10网关的解决方案咨询

以下是针对NestJS 10下Socket.IO客户端无法连接的排查和解决方案：

1. 显式配置Socket.IO的CORS规则 #

NestJS 10对Socket.IO的CORS默认配置可能与NestJS 9不同，需显式声明允许客户端跨域访问：

• 在网关装饰器中配置：

import { WebSocketGateway } from '@nestjs/websockets';

@WebSocketGateway({
  cors: {
    origin: 'http://your-client-domain.com', // 替换为实际客户端域名，允许所有可设为"*"
    credentials: true,
  },
})
export class ChatGateway {}

• 或全局配置Socket.IO适配器（main.ts）：

import { NestFactory } from '@nestjs/core';
import { IoAdapter } from '@nestjs/platform-socket.io';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  const ioAdapter = new IoAdapter(app);
  ioAdapter.createIOServer({
    cors: {
      origin: '*',
      credentials: true,
    },
  });
  app.useWebSocketAdapter(ioAdapter);
  await app.listen(3000);
}
bootstrap();

2. 匹配客户端连接地址与网关命名空间 #

• 若网关指定了命名空间，客户端连接地址必须对应：
  网关代码：

@WebSocketGateway({ namespace: 'chat' })
export class ChatGateway {}

客户端代码：

import { io } from 'socket.io-client';
const socket = io('http://localhost:3000/chat', {
  transports: ['websocket'], // 强制使用WebSocket传输，避免轮询兼容性问题
});

• 无命名空间时，客户端直接连接服务器根地址即可。

3. 确保依赖版本兼容性 #

虽然你使用的Socket.IO版本（4.6.0）与NestJS 10依赖兼容，但可尝试重新安装依赖排除版本冲突：

rm -rf node_modules package-lock.json
npm install

4. 验证网关连接事件监听 #

确认网关中包含连接/断开事件的监听逻辑，便于排查连接状态：

import { WebSocketGateway, OnGatewayConnection, OnGatewayDisconnect, Socket } from '@nestjs/websockets';

@WebSocketGateway()
export class ChatGateway implements OnGatewayConnection, OnGatewayDisconnect {
  handleConnection(client: Socket) {
    console.log(`客户端已连接: ${client.id}`);
  }

  handleDisconnect(client: Socket) {
    console.log(`客户端已断开: ${client.id}`);
  }
}

5. 检查网络与端口配置 #

• 确保NestJS服务器和客户端使用相同端口，无防火墙、代理或端口占用问题；
• 在客户端添加错误监听，定位具体连接失败原因：

socket.on('connect_error', (err) => {
  console.error('连接错误:', err.message);
});

内容的提问来源于stack exchange，提问作者caspermc