Socket.io v4连接实例中间件不生效问题排查求助

• 确认中间件添加时机：Socket实例的中间件必须在任何事件监听之前添加。如果在connection事件里先绑定事件再挂载中间件，后续触发的事件不会经过该中间件。示例：

  io.on('connection', (socket) => {
    // 错误顺序：先绑定事件，后加中间件
    socket.on('some-event', () => {});
    socket.use((packet, next) => { /* 中间件逻辑 */ });
  
    // 正确顺序：先加中间件，再绑定事件
    socket.use((packet, next) => { /* 中间件逻辑 */ });
    socket.on('some-event', () => {});
  });
  

• 验证中间件语法正确性：必须调用next()（或next(new Error())触发错误断开），否则中间件链会中断，无法触发后续逻辑。示例：

  // 错误写法：未调用next
  socket.use((packet, next) => {
    console.log('中间件触发');
  });
  
  // 正确写法：调用next继续执行
  socket.use((packet, next) => {
    console.log('中间件触发');
    next();
  });
  

• 检查事件触发来源：Socket中间件仅对客户端主动发送的事件生效，服务器端调用socket.emit()不会经过中间件。测试时必须从客户端触发事件，比如：

  // 客户端代码示例
  socket.emit('test-event', 'test-data');
  

• 确认命名空间匹配：如果使用自定义命名空间，要确保中间件挂载到对应命名空间的Socket实例上，而非默认命名空间。示例：

  const customNsp = io.of('/my-namespace');
  customNsp.on('connection', (socket) => {
    socket.use((packet, next) => { /* 中间件逻辑 */ });
  });
  

• 核对Socket.io版本：确保使用v4.x版本，部分中间件逻辑在v3及以下版本存在差异。可通过npm list socket.io查看当前版本。

• 测试最简示例：剥离业务逻辑，编写极简测试用例验证中间件是否生效，排除其他代码干扰：

  // 服务器端
  const { Server } = require('socket.io');
  const io = new Server(3000);
  
  io.on('connection', (socket) => {
    console.log('客户端已连接');
    socket.use((packet, next) => {
      console.log('Socket中间件触发，数据包：', packet);
      next();
    });
    socket.on('test', (data) => {
      console.log('收到客户端事件：', data);
    });
  });
  
  // 客户端
  const { io } = require('socket.io-client');
  const socket = io('http://localhost:3000');
  socket.on('connect', () => {
    socket.emit('test', 'hello');
  });
  

内容的提问来源于stack exchange，提问作者aii-yin