订阅与发布
订阅频道
每当客户端执行SUBSCRIBE命令订阅某个或某些频道的时候,服务器都会将客户端与被订阅的频道
在pubsub_channels字典中进行关联。
根据频道是否已经有其他订阅者,关联操作分为两种情况执行:
- 1.如果频道已经有其他订阅者,那么它在pubsub_channels字典中必然有相应的订阅者链表,程序唯一要做的就是将客户端添加到订阅者链表的末尾
- 2.如果频道还未有任何订阅者,那么它必然不存在于pubsub_channels字典,程序首先要在pubsub_channels字典中为频道创建一个键,并将这个键的值设置为空链表,然后再将客户端添加到链表,成为链表的第一个元素
例子
- 举个例子。假设服务器pubsub_channels字典的当前状态如图所示,那么当客户端client-10086执行命令
SUBSCRIBE "news.sport" "news.movie"
之后,pubsub_channels字典将更新至如图所示的状态,其中用虚线包围的是新添加的节点:
1.更新后的pubsub_channels字典新增了"news.movie"键,该键对应的链表值只包含一个client-10086节点,表示目前只有client-10086一个客户端在订阅"news.movie"频道
2.至于原本就已经有客户端在订阅的"news.sport"频道,client-10086的节点放在了频道对应链表的末尾,排在client-4节点的后面
SUBSCRIBE命令的实现
可以用以下伪代码来描述:
def subscribe(*all_input_channels):
# 遍历输入的所有频道
for channel in all_input_channels:
# 如果channel不存在于pubsub_channels字典(没有任何订阅者)
# 那么在字典中添加channel键,并设置它的值为空链表
if channel not in server.pubsub_channels:
server.pubsub_channels[channel] = []
# 将订阅者添加到频道所对应的链表的末尾
server.pubsub_channels[channel].append(client)
退订频道
UNSUBSCRIBE命令的行为和SUBSCRIBE命令的行为正好相反,当一个客户端退订某个或某些频道的时候,服务器将从pubsub_channels
中解除客户端与被退订频道之间的关联:
- 1.程序会根据被退订频道的名字,在pubsub_channels字典中找到频道对应的订阅者链表,然后从订阅者链表删除退订客户端的信息
- 2.如果删除退订客户端之后,频道的订阅者链表变成了空链表,那么说明这个频道已经没有任何订阅者了,程序将从pubsub_channels
字典中删除频道对应的键。
例子
- 举个例子,假设pubsub_channels的当前状态如图所示,那么当客户端client-10086执行命令:
UNSUBSCRIBE "news.sport" "news.movie"
之后,图中用虚线包围的两个节点将被删除如图所示
1.在pubsub_channels字典更新之后,client-10086的信息已经从"news.sport"频道和"news.movie"频道的订阅者链表中被删除了
2.另外,因为删除client-10086之后,频道"news.movie"已经没有任何订阅者,因此键"news.movie"也从字典中被删除了
UNSUBSCRIBE命令的实现
可以用以下伪代码来描述:
def unsubscribe(*all_input_channels):
# 遍历要退订的所有频道
for channel in all_input_channels:
# 在订阅者链表中删除退订
server.pubsub_channels[channel].remove(client);
# 如果频道已经没有任何订阅者(订阅者链表为空)
# 那么将频道从字典中删除
if len(server.pubsub_channels[channel]) == 0:
server.pubsub_channels.remove(channel)
模式的订阅与退订
服务器将所有频道的订阅关系都保存在服务器状态的pubsub_channels属性里面,与此类似,服务器也将所有模式的订阅都保存在服务器状态的pubsub_patterns属性里面:
struct redisServer {
// ...
// 保存所有模式订阅关系
list *pubsub_patterns;
// ...
};
pubsub_patterns属性是一个链表,链表中的每个节点都包含着一个pubsubPatttern结构,这个结构的pattern属性记录了被订阅的模式,而client属性则记录了订阅模式的客户端:
typedef struct pubsubPattern{
// 订阅模式的客户端
redisClient *client;
// 被订阅的模式
robj *pattern;
} pubsubPattern;
例子
- 举个例子。如图所示是一个pubsubPattern结构示例,它显示客户端client-9正在订阅模式"news.".
图中展示了pubsub_patterns链表示例,这个链表记录了以下信息:
1.客户端client-7正在订阅模式"music."
2.客户端client-8正在订阅模式"book."
3.客户端client-9正在订阅模式"news."
订阅模式
每当客户端执行PSUBSCIRBE命令订阅某个或某些模式的时候,服务器会对每个被订阅的模式执行以下两个操作:
- 1.新键一个pubsubPattern结构,将结构的pattern属性设置为被订阅的模式,client属性设置为订阅模式的客户端
- 2.将pubsubPattern结构添加到pubsub_patterns链表的表尾。
例子
- 举个例子,假设服务器中的pubsub_pattern链表的当前状态如图所示。
当客户端client-9执行命令:
PSUBSCRIBE "news.*"
之后,pubsub_patterns链表将更新至如图所示的状态,其中用虚线包围的是新添加的pubsubPattern结构
PSUBSCRIBE命令的实现原理
可以用以下伪代码来描述
def psubscribe(*all_input_patterns):
# 遍历输入的所有模式
for pattern in all_input_patterns:
# 创建新的pubsubPattern结构
# 记录被订阅的模式,以及订阅模式的客户端
pubsubPattern = create_new_pubsubPattern()
pubsubPattern.client = client
pubsubPattern.pattern = pattern
# 将新的pubsubPattern追加到pubsub_patterns链表末尾
server.pubsub_patterns.append(pubsubPattern)
退订模式
模式的退订模式PUNSUBSCRIBE是PSUBSCRIBE命令的反操作:当一个客户端退订某个或某些模式的时候,服务器将在pubsub_patterns链表中查找并删除那些pattern属性为退订模式,并且client属性为执行退订命令的客户端的pubsubPattern结构
例子
- 举个例子。假设服务器pubsub_patterns链表的当前状态如图所示,当客户端client-9执行命令:
PUNSUBSCRIBE "news.*"
之后,client属性为client-9,pattern属性为"news.*"的pubsubPattern结构将被删除,pubsub_patterns链表将更新至如图所示的样子
PUNSUBSCRIBE命令的实现原理
可以用以下伪代码来描述
def punsubscribe(*all_input_patterns):
# 遍历所有要退订的模式
for pattern in all_input_patterns:
# 遍历pubsub_patterns
for pubsubPattern in server.pubsub_patterns:
# 如果当前客户端和pubsubPattern记录的客户端相同
# 并且要退订的模式也和pubsubPattern记录的模式相同
if client == pubsubPattern.client and \ pattern == pubsubPattern.pattern:
# 那么将这个pubsubPattern从链表删除
server.pubsub_patterns.remove(pubsubPattern)