NestJS WebSocket Gateway事件未触发，连接返回404求助

问题诊断与解决步骤 #

1. 安装缺失的核心依赖 #

NestJS WebSocket网关依赖socket.io和@nestjs/platform-socket.io包，先确认是否已安装：

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

2. 处理全局前缀对Socket.IO路径的影响 #

代码中设置了app.setGlobalPrefix(appGlobalPrefix)，这会将Socket.IO的默认路径从/socket.io修改为/{appGlobalPrefix}/socket.io：

• 若appGlobalPrefix为空字符串，可忽略此步；若有具体值（如api），Postman连接时需使用ws://localhost:3000/api/socket.io
• 若想让Socket.IO不受全局前缀影响，可修改网关配置强制指定路径：

// gateway.ts
import { MessageBody, SubscribeMessage, WebSocketGateway, WebSocketServer } from "@nestjs/websockets";
import { Server } from 'socket.io';

@WebSocketGateway({ path: '/socket.io' }) // 绕过全局前缀，固定Socket.IO路径
export class MyGateway{
  @WebSocketServer()
  server: Server;

  @SubscribeMessage('newMessage')
  onNewMessage(@MessageBody() body: any){
      console.log(body);
      // 新增回复逻辑，方便验证连接有效性
      this.server.emit('messageReceived', body);
  }
}

3. 配置CORS（跨域连接场景） #

如果是跨域环境下连接，需在网关中配置CORS规则：

@WebSocketGateway({ 
  path: '/socket.io',
  cors: {
    origin: '*', // 生产环境请替换为具体允许的域名
    credentials: true
  }
})

4. 确认网关初始化状态 #

启动应用后，控制台应输出类似WebSocket Gateway is listening on "http://localhost:3000"的日志。若未出现：

• 检查GatewayModule是否已正确导入AppModule（你的代码已完成此步骤）
• 确认MyGateway类上的@WebSocketGateway()装饰器未遗漏

连接验证 #

修改完成后，根据全局前缀情况选择对应地址连接：

• 无全局前缀：ws://localhost:3000/socket.io
• 有全局前缀：ws://localhost:3000/{prefix}/socket.io
  连接成功后发送newMessage事件，即可在控制台看到接收的消息内容。

内容的提问来源于stack exchange，提问作者Omar A. Lebda