Express+Socket.io拆分Server与路由后Socket连接报错问题

你遇到的TypeError: Cannot read properties of undefined (reading 'socket_listen')有两个核心原因：

1. socket_listen是Server类的实例属性，但你在index.js里直接通过Server.socket_listen访问（把它当成了静态属性），自然会返回undefined。
2. server.js的构造函数中，你在调用listen()之前就初始化了socket_listen，此时this.server还未被赋值（listen()方法才会创建HTTP服务器实例），导致Socket.io初始化时传入了无效的undefined参数，即使后续能访问到socket_listen，它也是无效的。

步骤1：调整Server类的初始化顺序 #

把Socket.io的初始化移到listen()方法中，确保HTTP服务器实例创建完成后再初始化Socket.io：

// server.js
const express = require("express");
const socket = require("socket.io");

class Server {
  constructor() {
    this.app = express();
    this.port = 4000;
    this.paths = { app: "/app" };

    this.middlewares();
    this.routes();
  }

  // 补充缺失的中间件初始化方法
  middlewares() {
    this.app.use(express.json()); // 示例：解析JSON请求体
  }

  routes() {
    this.app.use(this.paths.app, require("../routes/app"));
  }

  listen() {
    // 先创建HTTP服务器实例
    this.server = this.app.listen(this.port, () => {
      console.log(`Server running on port ${this.port}`);
    });
    // 再初始化Socket.io
    this.socket_listen = socket(this.server, { 
      cors: {
        origin: 'http://localhost:3000'
      }
    });
    return this.socket_listen;
  }
}

module.exports = Server;

步骤2：在入口文件暴露Socket.io实例 #

修改app.js，创建Server实例后，把Socket.io实例导出，供路由或其他模块使用：

// app.js
const Server = require('./models/server');
const server = new Server();
const io = server.listen();

// 导出Socket.io实例
module.exports = { io };

步骤3：在路由中正确使用Socket.io #

修改index.js，导入入口文件导出的Socket.io实例，而不是直接访问Server类：

// index.js
var express = require('express');
var router = express.Router();
// 导入Socket.io实例
const { io } = require('../app');

router.get('/', function(req, res, next) {
    return res.status(400).send('Bad Request'); // 补充响应内容，避免客户端挂起
});

// 注册Socket连接监听（注意：这个监听只需要注册一次，不要放在路由处理函数里）
io.on('connection', function(socket) {
    console.log('A user connected');

    socket.on('disconnect', function () {
       console.log('A user disconnected');
    });
});

module.exports = router;

可选：路由内调用Socket.io发消息 #

如果需要在路由处理逻辑中给客户端发消息，可以通过req.app.locals.io访问（需要先在Server类的listen()方法中挂载）：
在server.js的listen()方法里添加：

this.app.locals.io = this.socket_listen;

然后在路由中使用：

router.post('/notify', (req, res) => {
  req.app.locals.io.emit('notification', 'New message received');
  res.status(200).send('Notification sent');
});

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