NodeRedis Pub/Sub 功能详解：实现高效消息发布订阅

NodeRedis Pub/Sub 功能详解：实现高效消息发布订阅

node-redis 项目地址: https://gitcode.com/gh_mirrors/nod/node-redis

什么是 Pub/Sub 模式

Pub/Sub（发布/订阅）是一种消息通信模式，它允许消息发送者（发布者）将消息发送到特定频道，而无需知道哪些订阅者（如果有的话）正在监听。同时，订阅者可以监听一个或多个频道，并接收这些频道的消息，而无需知道发布者是谁。

NodeRedis 提供了完整的 Pub/Sub 实现，支持标准 Pub/Sub 和分片 Pub/Sub 两种模式，能够满足不同场景下的消息通信需求。

准备工作：创建订阅客户端

在使用 Pub/Sub 功能前，我们需要创建一个专用的订阅客户端。这是因为 Redis 的订阅模式会独占连接，订阅后的连接将无法执行其他命令。

// 复制现有客户端创建订阅者
const subscriber = client.duplicate();

// 处理可能的错误
subscriber.on('error', err => console.error(err));

// 连接订阅客户端
await subscriber.connect();

对于 Redis 集群环境，NodeRedis 会自动处理这些细节，开发者无需手动创建副本客户端。

订阅消息的三种模式

NodeRedis 提供了三种订阅方式，适应不同场景需求：

1. 标准订阅 (subscribe)

const messageHandler = (message, channel) => {
  console.log(`收到来自频道 ${channel} 的消息: ${message}`);
};

// 订阅单个频道
await client.subscribe('news', messageHandler);

// 订阅多个频道
await client.subscribe(['sports', 'weather'], messageHandler);

2. 模式订阅 (pSubscribe)

支持使用通配符订阅多个频道：

// 订阅所有以"news_"开头的频道
await client.pSubscribe('news_*', messageHandler);

3. 分片订阅 (sSubscribe)

针对 Redis 集群优化的分片 Pub/Sub：

await client.sSubscribe('cluster_channel', messageHandler);

重要提示：多次订阅同一频道会创建多个监听器，当消息到达时每个监听器都会被调用。

发布消息

发布消息同样简单，根据订阅模式选择对应方法：

// 标准发布
await client.publish('news', '今日快讯：NodeRedis发布新版本');

// 分片发布
await client.sPublish('cluster_channel', '集群消息测试');

取消订阅

NodeRedis 提供了灵活的取消订阅方式：

取消所有订阅

// 取消所有标准订阅
await client.unsubscribe();

// 取消所有模式订阅
await client.pUnsubscribe();

// 取消所有分片订阅
await client.sUnsubscribe();

取消特定频道订阅

// 取消单个频道
await client.unsubscribe('news');

// 取消多个频道
await client.unsubscribe(['sports', 'weather']);

取消特定监听器

// 只取消特定频道的特定监听器
await client.unsubscribe('news', messageHandler);

二进制数据支持

NodeRedis 完全支持二进制数据的发布和订阅：

// 订阅二进制频道
await subscriber.subscribe('binary_channel', message => {
  console.log(message); // 输出 Buffer 对象
}, true); // 设置为 true 表示使用 Buffer 模式

// 发布二进制消息
await subscriber.publish(
  Buffer.from('binary_channel'), 
  Buffer.from('这是一个二进制消息')
);

注意：频道名和消息内容可以自由组合字符串和 Buffer 类型，NodeRedis 会正确处理各种组合情况。

高级特性：分片频道迁移事件

在使用分片 Pub/Sub 时，当频道的集群槽位(slot)被迁移到其他分片时，NodeRedis 会触发 sharded-channel-moved 事件：

client.on('sharded-channel-moved', (channel, listeners) => {
  console.log(`频道 ${channel} 已被迁移到其他分片`);
  // listeners 包含当前频道的所有监听器
});

这个机制确保了在集群重新分片时，订阅关系能够自动维护，开发者无需手动处理。

最佳实践建议

1. 专用连接：始终为订阅创建专用客户端，避免阻塞其他操作
2. 错误处理：务必监听错误事件，避免静默失败
3. 资源释放：不再需要订阅时及时取消，释放资源
4. 集群环境：在集群环境中优先考虑使用分片 Pub/Sub 以获得更好的性能
5. 二进制数据：传输二进制数据时显式指定 Buffer 模式，避免编码问题

通过 NodeRedis 强大的 Pub/Sub 功能，开发者可以轻松构建实时消息系统、事件驱动架构和实时数据推送服务。

node-redis 项目地址: https://gitcode.com/gh_mirrors/nod/node-redis