NestJS WebSocket Gateway如何在URL中传递参数？

NestJS的@WebSocketGateway配置中的path字段不支持像HTTP路由那样的参数占位符（比如:id），这就是你直接写path: 'my/custom/url/:id'导致构建失败的原因。下面是两种正确的实现方式：

方式一：使用查询参数传递 #

客户端连接时将参数放在查询字符串中，比如：

ws://localhost:8080/my/custom/url?id=123

在网关的handleConnection方法中，通过客户端socket的handshake.query获取参数：

import { WebSocketGateway, OnGatewayConnection } from '@nestjs/websockets';
import { Socket } from 'socket.io';

@WebSocketGateway(8080, { path: 'my/custom/url' })
export class MyGateway implements OnGatewayConnection {
  handleConnection(client: Socket) {
    const id = client.handshake.query.id;
    console.log('当前连接的ID:', id);
    // 后续业务逻辑处理
  }
}

方式二：解析URL路径获取参数 #

如果需要用路径形式传递参数（比如ws://localhost:8080/my/custom/url/123），可以保持网关的基础路径配置，然后通过解析socket的请求URL来提取参数：

import { WebSocketGateway, OnGatewayConnection } from '@nestjs/websockets';
import { Socket } from 'socket.io';
import * as url from 'url';

@WebSocketGateway(8080, { path: 'my/custom/url' })
export class MyGateway implements OnGatewayConnection {
  handleConnection(client: Socket) {
    const parsedUrl = url.parse(client.handshake.url, true);
    // 拆分路径片段，过滤空值后取最后一段作为id
    const pathSegments = parsedUrl.pathname.split('/').filter(seg => seg);
    const id = pathSegments[pathSegments.length - 1];
    console.log('当前连接的ID:', id);
    // 后续业务逻辑处理
  }
}

这种方式需要确保客户端连接的URL路径结构符合预期，比如基础路径是my/custom/url，参数放在路径的最后一段。

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