跳到主要内容
版本：4.x

Redis Streams 适配器

工作原理​

该适配器将使用 Redis 流 在 Socket.IO 服务器之间转发数据包。

与现有的 Redis 适配器（使用 Redis Pub/Sub 机制）的主要区别在于，该适配器将正确处理与 Redis 服务器的任何临时断开连接，并在不丢失任何数据包的情况下恢复流。

注意事项：

  • 所有命名空间使用单个流
  • maxLen 选项允许限制流的大小
  • 与基于 Redis PUB/SUB 机制的适配器不同，该适配器将正确处理与 Redis 服务器的任何临时断开连接，并恢复流
  • 如果启用了连接状态恢复，会话将作为经典的键/值对存储在 Redis 中

源代码: https://github.com/socketio/socket.io-redis-streams-adapter

安装​

npm install @socket.io/redis-streams-adapter redis

使用方法​

import { createClient } from "redis";
import { Server } from "socket.io";
import { createAdapter } from "@socket.io/redis-streams-adapter";

const redisClient = createClient({ host: "localhost", port: 6379 });

await redisClient.connect();

const io = new Server({
  adapter: createAdapter(redisClient)
});

io.listen(3000);

选项​

名称描述默认值
streamNameRedis 流的名称。socket.io
maxLen流的最大大小。使用近似修剪（~）。10_000
readCount每次 XREAD 调用要获取的元素数量。100
heartbeatInterval两次心跳之间的毫秒数。5_000
heartbeatTimeout在我们认为节点宕机之前没有心跳的毫秒数。10_000

常见问题​

  • 使用 Redis Streams 适配器时，我仍然需要启用粘性会话吗？

是的。如果不这样做，将导致 HTTP 400 响应（您正在访问一个不了解 Socket.IO 会话的服务器）。

更多信息请参见这里。

  • 当 Redis 服务器宕机时会发生什么？

与经典的 Redis 适配器不同，该适配器将正确处理与 Redis 服务器的任何临时断开连接，并在不丢失任何数据包的情况下恢复流。

最新版本​