Redis学习笔记 - 发布与订阅

参考：

• <<Redis设计与实现>>
  • 注：这本书是基于Redis3.0版本写的，和后面的版本有点差异
• http://www.redis.cn/commands/slowlog.html
  
  

一、发布订阅命令

Redis的发布订阅功能由PUBLISH、SUBSCRIBE、PSUBSCRIBE、UNSUBSCRIBE、UNPSUBSCRIBE、PUBSUB等命令组成。

• SUBSCRIBE：订阅指定的一个或多个频道
• UNSUBSCRIBE：退订指定的频道
• PSUBSCRIBE：订阅一个或多个符合给定模式的频道
• UNPSUBSCRIBE：退订指定模式的频道
• PUBLISH：发送消息到指定频道
• PUBSUB：查看订阅与发布系统状态

示例：

（1）订阅指定频道

通过SUBSCRIBE命令，客户端可以订阅一个或多个指定的频道，此时客户端就成为这些频道的订阅者(subscriber)。每当有其他客户端向被订阅的频道发送消息（message）时，频道的所有订阅者都会受到消息。

如，A、B、C三个客户端都执行了SUBSCRIBE news.it，则A、B、C就是"news.it"频道的订阅者，订阅关系如下图所示：

此时，其他客户端向"news.it"频道发送消息，PUBLISH news.it hello，那么"news.it"频道的订阅者都将收到消息，如图所示：

（2）订阅模式

通过PSUBSCRIBE命令，客户端可以订阅一个或多个模式，此时客户端成为这些模式的订阅者。

当有客户端向频道发送消息的时候，不仅这个频道所有的订阅者收到消息，消息还会被发送给所有与这个频道相匹配的模式的订阅者。

如：

• 客户端A订阅频道"news.it"、客户端B订阅频道"news.et"
• 客户端C、D订阅模式"news.[ie]t"（与"news.it"、"news.et"频道匹配）

订阅关系如下图所示：

此时，某个客户端向"news.it"发送消息：PUBLISH news.it hello，那么ACD客户顿都会收到这条消息，因为

• A是"news.it"的订阅者
• CD订阅的模式"news.[ie]t"与"news.it"频道匹配

发送消息如下图所示：

二、频道的订阅与退订

客户端执行SUBSCRIBE命令订阅频道时，这个客户端与订阅的频道之间建立起一种订阅关系。

Redis将频道的订阅关系保存在服务器状态的pubsub_channels属性里，这个属性结构是个字典，键：订阅的频道、值：一个链表，链表里记录了所有订阅这个频道的客户端，服务器状态的pubsub_channels属性如下：

struct reidsServer {
	// ...
	// 保存所有频道的订阅关系
	dict *pubsub_channels;
	// ...
};

示例：

• client-1、client-2、client-3三个客户端订阅"news.it"频道
• client-4订阅"news.sport"频道
• client-5、client-6两个客户端订阅"news.business"频道

订阅关系的字典表如下图所示：

2.1 订阅频道

客户端执行SUBSCRIBE命令订阅频道时，服务器会将订阅关系保存到pubsub_channels字典表里：

• 频道已经存在（字典的键），则直接将客户端添加至该频道对应链表的末尾
• 如果频道不存在（字典的键），则在pubsub_channels字典表中为这个频道创建一个键，然后为这个键的值设置一个空链表，最后将客户端添加至链表

上述流程对应的流程图如下：

2.2 退订频道

客户端执行UNSUBSCRIBE命令退订频道时，服务器从pubsub_channels字典表里删除客户端与频道之间的关联：

• 程序根据频道名字，在字典表中找到对应的订阅链表，然后从链表中删除该客户端
• 如果删除客户端后，频道的订阅者链表为空，表示频道已经没有订阅者了，程序会从字典表中删除频道对应的键

上述流程对应流程图如下：

三、模式的订阅与退订

服务器将模式的订阅关系保存在服务器状态的pubsub_patterns属性里，服务器状态结构如下：

struct reidsServer {
	// ...
	// 保存所有模式的订阅关系
	dict *pubsub_patterns;
	// ...
};

pubsub_patterns属性是一个链表，链表中每个节点都是pubsubPattern结构：

• pattern属性记录了被订阅的模式
• client属性记录了订阅模式的客户端：

typedef struct pubsubPattern {
	// 订阅模式的客户端
	redisClient *client;
	// 被订阅的模式
	robj *pattern;
} pubsubPattern;

示例：

client-7订阅模式"music."、client-8订阅模式"book."、client-9订阅模式"news.*"，那么pubsub_patterns链表如下图所示：

3.1 订阅模式

客户端执行PSUBSCRIBE命令订阅模式时，服务器对每个被订阅的模式执行以下两个操作：

• 新建一个pubsubPattern结构，将结构的pattern属性设置为订阅的模式，client属性设置为订阅模式的客户端
• 将pubsubPattern结构添加到pubsub_pattern链表的尾部

流程如下图所示：

3.2 退订模式

客户端执行PUNSUBSCRIBE命令退订模式时，服务器在pubsub_patterns链表中根据模式、客户端查找并删除pubsubPattern结构。

示例：

假如当前服务器状态的pubsub_patterns链表的当前状态如下图所示：

此时客户端client-9执行命令：PUNSUBSCRIBE news.*，那么client属性为client-9、pattern属性为:"news.*"的pubsubPattern结构会被删除，删除后的链表如下图所示：

四、发布消息

当Redis客户端执行 PUBLISH <channel> <message>命令将消息message发送给频道channel时，服务器要执行以下两个操作：

• 将消息发送给channel频道的所有订阅者
• 如果有一个或多个模式pattern与频道channel相匹配，那么将消息message发送给pattern模式的订阅者

4.1 将消息发送给频道订阅者

服务器状态的pubsub_channels字典记录了所有频道的订阅关系，所以PUBLISH命令发送消息时：

• 在pubsub_channels字典里找到channel的订阅者（一个链表）
• 将消息发送给链表里的每个客户端

示例：

假如服务器pubsub_channels字典当前状态如下图所示：

此时，某个客户端执行PUBLISH news.it hello命令，那么将会在字典里找到"news.it"对应的链表，遍历整个链表将消息"hello"发送个该频道的三个订阅者：client-1、client-2、client-3。

发送消息流程如下图所示：

4.2 将消息发送给模式订阅者

服务器状态的pubsub_patterns链表记录了所有模式的订阅关系，所以发送给模式的订阅者：

• 遍历整个pubsub_patterns链表，查找与channel频道向匹配的模式
• 将发送给消息给模式关联的客户端。

示例：

假如当前的pubsub_patterns链表状态如下图所示：

此时，某个客户端执行命令：‘PUBLISH news.it hello’，那么：

• 消息hello会被发送给news.it频道的的所有订阅者
• 在pubsub_patterns链表中查找与频道匹配的模式，结果发现"news.*"模式与频道"new.it"匹配，所有将消息发送给客户端client-9

上述流程如下图所示：

五、查看订阅信息

查看订阅信息主要用到PUBSUB命令，该命令格式如下：

PUBSUB <subcommand> [argument [argument ...]]

主要可以查询三类信息：

• PUBSUB CHANNELS [pattern]：返回服务器当前被订阅的频道
• PUBSUB NUMSUB [channel-1 channel-2 …]：返回频道的订阅者数量
• PUBSUB NUMPAT：返回服务器当前被订阅模式的数量

5.1 PUBSUB CHANNELS

PUBSUB CHANNELS [pattern]：返回服务器当前被订阅的频道，pattern参数可选：

• 不给定pattern参数，命令返回服务器当前被订阅的所有频道
• 给定pattern参数，命令返回服务器当前被订阅的频道中与pattern模式相匹配的频道

这个命令通过遍历服务器pubsub_channels字典的所有键（每个键都是一个被订阅的频道），然后返回所有符合条件的频道来实现的。

示例：
有下图所示的pubsub_channels字典，执行PUBSUB CHANNELS命令会返回服务器目前被订阅的4个频道：

redis> PUBSUB CHANNELS
1) "news.it"
2) "news.sport"
3) "news.business"
4) "news.movie"

redis> PUBSUB CHANNELS 'news.[is]*'
1) "news.it"
2) "news.sport"

5.2 PUBSUB NUMSUB

PUBSUB NUMSUB [channel-1 channel-2 ...]：接受任意多个频道，返回这些频道的订阅者数量。

• 这个命令是在pubsub_channels字典中找到频道对应的订阅者链表，然后返回订阅者链表的长度。

示例：

有如下图所示的pubsub_channels字典，执行PUBSUB NUMSUB news.it news.sport news.business news.movie命令：

redis> PUBSUB NUMSUB news.it news.sport news.business news.movie
1) "news.it"
2) "3"
3) "news.sport"
4) "2"
5) "news.business"
6) "2"
7) "news.movie"
8) "1"

5.3 PUBSUB NUMPAT

PUBSUB NUMPAT：返回服务器当前被订阅模式的数量

• 这个命令通过返回pubsub_patterns链表的长度来实现的

示例：

有如下图所示的pubsub_patterns链表，执行PUBSUB NUMPAT命令：

redis> PUBSUB NUMPAT
(integer) 3