socket.io-redis-adapter完全指南：10分钟实现多服务器事件广播

【免费下载链接】socket.io-redis-adapter Adapter to enable broadcasting of events to multiple separate socket.io server nodes. 项目地址: https://gitcode.com/gh_mirrors/so/socket.io-redis-adapter

socket.io-redis-adapter是一个强大的适配器，允许在多个Socket.IO服务器之间广播事件，轻松实现分布式实时应用架构。本文将为你提供简单快速的配置指南，帮助你在10分钟内完成多服务器事件广播的设置。

为什么需要socket.io-redis-adapter？

在构建实时应用时，单个Socket.IO服务器可能无法满足高并发需求。通过水平扩展多个服务器节点，你可以显著提升应用的承载能力。然而，默认情况下，Socket.IO服务器之间无法直接通信，导致事件无法跨服务器广播。

socket.io-redis-adapter正是为解决这一问题而生！它利用Redis的发布/订阅机制，在多个Socket.IO服务器之间建立通信桥梁，确保事件能够无缝地广播到所有连接的客户端。

图：socket.io-redis-adapter通过Redis实现多服务器间事件广播的架构图

快速开始：安装与基础配置

环境要求

• Node.js 10.0.0或更高版本
• Redis服务器
• Socket.IO 4.3.1或更高版本

安装步骤

首先，克隆项目仓库：

git clone https://gitcode.com/gh_mirrors/so/socket.io-redis-adapter

然后安装必要的依赖：

npm install @socket.io/redis-adapter

基础使用示例

以下是使用redis包的基本配置示例：

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

// 创建Redis客户端
const pubClient = createClient({ url: "redis://localhost:6379" });
const subClient = pubClient.duplicate();

// 连接到Redis
await Promise.all([
  pubClient.connect(),
  subClient.connect()
]);

// 创建Socket.IO服务器并使用Redis适配器
const io = new Server({
  adapter: createAdapter(pubClient, subClient)
});

io.listen(3000);

进阶配置：多种Redis连接方式

使用ioredis包

如果你偏好使用ioredis包，可以这样配置：

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

const pubClient = new Redis();
const subClient = pubClient.duplicate();

const io = new Server({
  adapter: createAdapter(pubClient, subClient)
});

io.listen(3000);

Redis集群支持

对于生产环境，你可能需要使用Redis集群来确保高可用性：

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

const pubClient = new Cluster([
  { host: "localhost", port: 7000 },
  { host: "localhost", port: 7001 },
  { host: "localhost", port: 7002 }
]);
const subClient = pubClient.duplicate();

const io = new Server({
  adapter: createAdapter(pubClient, subClient)
});

io.listen(3000);

Redis分片Pub/Sub

Redis 7.0引入了分片Pub/Sub功能，可通过createShardedAdapter方法使用：

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

const pubClient = createClient({ host: "localhost", port: 6379 });
const subClient = pubClient.duplicate();

await Promise.all([
  pubClient.connect(),
  subClient.connect()
]);

const io = new Server({
  adapter: createShardedAdapter(pubClient, subClient)
});

io.listen(3000);

适配器选项配置

socket.io-redis-adapter提供了多种选项来自定义其行为：

默认适配器选项

名称	描述	默认值
key	Redis Pub/Sub通道的前缀	socket.io
requestsTimeout	等待请求响应的超时时间(毫秒)	5000
publishOnSpecificResponseChannel	是否向特定于请求节点的通道发布响应	false

分片适配器选项

名称	描述	默认值
channelPrefix	Redis Pub/Sub通道的前缀	socket.io
subscriptionMode	订阅模式，影响适配器使用的Redis Pub/Sub通道数量	dynamic

兼容性说明

确保你的socket.io-redis-adapter版本与Socket.IO服务器版本兼容：

Redis Adapter版本	Socket.IO服务器版本
4.x	1.x
5.x	2.x
6.0.x	3.x
6.1.x	4.x
7.x及以上	4.3.1及以上

结语

socket.io-redis-adapter是构建分布式实时应用的必备工具，它通过简单的配置即可实现多服务器间的事件广播。无论你是构建聊天应用、实时协作工具还是在线游戏，socket.io-redis-adapter都能帮助你轻松扩展应用规模，提供稳定可靠的实时通信体验。

现在，你已经掌握了socket.io-redis-adapter的基本使用和进阶配置，快去尝试构建你的分布式实时应用吧！

【免费下载链接】socket.io-redis-adapter Adapter to enable broadcasting of events to multiple separate socket.io server nodes. 项目地址: https://gitcode.com/gh_mirrors/so/socket.io-redis-adapter