当前位置：首页 > 文章列表 > 文章 > 前端 > Socket.IO获取活跃连接方法详解

Socket.IO获取活跃连接方法详解

2026-03-16 17:45:31 0浏览收藏

本文深入解析了 Socket.IO 中 `io.fetchSockets()` 方法报错“is not a function”的真实原因——并非代码缺陷，而是因版本不兼容（该方法仅在 v4.0.0+ 支持）导致的常见陷阱，并手把手指导你完成服务端与客户端的同步升级、CDN 资源校验、安全调用实践及运维接口封装，助你可靠获取实时在线连接数，真正掌握构建可观测、高稳定性的 Socket.IO 应用的关键一步。

如何在 Socket.IO 中正确获取所有活跃连接的 Socket 实例

本文详解 io.fetchSockets() 报错“is not a function”的根本原因与解决方案，涵盖版本兼容性检查、服务端/客户端升级步骤及安全调用实践，助你稳定获取全部在线 Socket 连接。

本文详解 `io.fetchSockets()` 报错“is not a function”的根本原因与解决方案，涵盖版本兼容性检查、服务端/客户端升级步骤及安全调用实践，助你稳定获取全部在线 Socket 连接。

io.fetchSockets() 是 Socket.IO v4 引入的核心服务端 API，用于异步获取当前命名空间下所有活跃的 Socket 实例（返回 Promise），常用于广播控制、连接统计或会话管理。但如示例中所示，调用时抛出 TypeError: io.fetchSockets is not a function，根本原因并非代码逻辑错误，而是 Socket.IO 版本不匹配——该方法仅在 v4.0.0 及以上版本中可用，而项目很可能仍在使用 v3.x 或更早版本。

✅ 正确升级与验证步骤

首先确认当前版本：

npm list socket.io socket.io-client

若输出类似 socket.io@3.1.2，则需统一升级服务端与客户端至 v4+：

# 升级服务端（Node.js）
npm install socket.io@latest

# 升级客户端（确保 HTML 中加载的也是 v4+）
npm install socket.io-client@latest
# 或直接使用 CDN（推荐用于快速验证）：
# <script src="https://cdn.socket.io/4.7.2/socket.io.min.js"></script>

⚠️ 关键注意：必须同时升级服务端和客户端。即使服务端为 v4，若前端仍通过 /socket.io/socket.io.js 加载旧版静态资源（例如由 v3 的 socket.io 包自动托管），浏览器实际运行的仍是 v3 客户端，这虽不影响连接，但会导致服务端某些 v4 新特性（如 fetchSockets）因内部协议/类型系统差异而不可用或行为异常。

✅ 修复后的服务端代码（含健壮性增强）

const express = require("express");
const { Server } = require("socket.io"); // 推荐解构导入，更清晰

const app = express();
app.use(express.static(__dirname + "/public"));

const webserver = app.listen(9001, () => {
  console.log("✅ Server running on http://localhost:9001");
});

// 初始化 Socket.IO 服务器（自动挂载到 HTTP server）
const io = new Server(webserver, {
  cors: {
    origin: "http://localhost:9001", // 根据实际前端地址调整
    methods: ["GET", "POST"]
  }
});

io.on("connection", async (socket) => {
  console.log(`? Client connected: ${socket.id}`);

  try {
    // ✅ v4+ 正确调用方式：返回 Promise<Socket[]>
    const allSockets = await io.fetchSockets();
    console.log(`? Total active sockets: ${allSockets.length}`);

    // 示例：向除当前客户端外的所有人广播新用户加入
    socket.broadcast.emit("user_joined", { id: socket.id, count: allSockets.length });

  } catch (err) {
    console.error("❌ Failed to fetch sockets:", err);
  }
});

// ? 额外建议：提供 HTTP 端点供运维查询（避免在 connection 中高频调用）
app.get("/api/sockets/count", async (req, res) => {
  try {
    const sockets = await io.fetchSockets();
    res.json({ count: sockets.length, timestamp: new Date().toISOString() });
  } catch (err) {
    res.status(500).json({ error: err.message });
  }
});

✅ 客户端 HTML（确保加载 v4+ 客户端）

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>Socket.IO v4 Demo</title>
</head>
<body>
  <!-- 使用明确的 v4 CDN 地址，避免缓存旧版 -->
  <script src="https://cdn.socket.io/4.7.2/socket.io.min.js"></script>
  <script>
    const socket = io("http://localhost:9001", {
      transports: ["websocket"] // 强制 WebSocket，排除降级干扰
    });

    socket.on("connect", () => {
      console.log("? Connected to Socket.IO v4 server");
    });

    socket.on("user_joined", (data) => {
      console.log(`? New user joined! Total: ${data.count}`);
    });
  </script>
</body>
</html>

? 常见误区排查清单

❌ 错误：io 对象被意外覆盖（如 const io = ...; io = somethingElse;）→ 检查是否 const 声明且未重赋值；
❌ 错误：使用了 socket.io 的旧版 Express 中间件（如 app.use(require('socket.io')(server))）→ v4 必须使用 new Server() 构造函数；
❌ 错误：NPM 缓存导致升级未生效 → 执行 npm cache clean --force && rm -rf node_modules package-lock.json && npm install；
⚠️ 提示：fetchSockets() 返回的是 所有命名空间下的 Socket（默认 "/"）。如需指定命名空间，请使用 io.of("/custom").fetchSockets()。

掌握版本一致性是使用 Socket.IO 新特性的前提。fetchSockets() 不仅是一个便利方法，更是构建可观察、可管理实时系统的基石——请始终将服务端与客户端版本对齐，并通过 try/catch 和日志保障其生产环境稳定性。

好了，本文到此结束，带大家了解了《Socket.IO获取活跃连接方法详解》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多文章知识！