Express结合Socket.IO开发报listen is not a function错误求助
报错本质原因
- 当前安装的
socket.io为v3.0及以上版本,该版本彻底移除了旧版对外暴露的静态.listen()方法。默认导出的内容是Server类构造函数,不存在挂在导出对象上的listen方法,调用时会直接抛出TypeError: require(...).listen is not a function。 - 原代码的链式传参逻辑本身不符合新版本设计:
app.listen(port)会直接启动服务监听,而socket.io新版本需要显式接收独立的http服务实例,无法对app.listen()返回的临时实例完成连接绑定。
标准修复方案
按照当前主流socket.io版本的规范调整实例化顺序即可,完整可运行代码如下:
const express = require("express"); const app = express(); const port = 3800; // 引入原生http模块,将express应用作为请求处理回调创建服务 const http = require("http"); const server = http.createServer(app); // 从socket.io中解构出Server构造函数,传入http服务实例完成初始化 const { Server } = require("socket.io"); const io = new Server(server); // 启动服务监听端口 server.listen(port, () => { console.log(`服务已在${port}端口启动`); });
常见踩坑提醒
- 不要为了图省事直接把
app.listen(port)的返回值塞进socket.io构造函数,这种写法虽然不会立刻报错,但会导致socket.io的连接路径和express服务的监听配置脱节,后续大概率出现跨域拒绝、连接超时的问题。 - 如果项目还在使用socket.io v2版本,原写法是可以正常运行的,出现这个报错说明安装版本不符合预期,可以通过指定版本号
npm install socket.io@2回退到对应版本适配旧代码逻辑,但不推荐长期使用已停更的旧版本。
内容的提问来源于stack exchange,提问作者Juliver Galleto
相关产品推荐
相关产品推荐

