Redis 发布订阅功能

发布订阅

Redis 发布订阅 (pub/sub) 是一种消息通信模式:订阅者 (sub) 订阅频道,发送者 (pub) 向频道发送消息,订阅者通过该频道接收消息。

image.png

不过发布订阅模式有2点需要注意:

  1. 新开启的订阅客户端,无法接收到该频道之前的消息,因为redis不会对发布的消息进行持久化
  2. 客户端在执行订阅命令之后进入了订阅状态,只能接收订阅和退订的命令。
  • 订阅频道
    subscribe {channel} {channel} ...
    
  • 发布消息
    publish {channel} {message}
    
  • 取消订阅
    unsubscribe {channel} {channel} ...
    
  • 按照模式订阅
    psubscribe {pattern} 
    
  • 按照模式取消订阅
    punsubscribe {pattern} 
    
  • 查询订阅
    • 查看活跃频道
    • 查看频道订阅数
    • 查看模式订阅数
实例测试:

客户端1输入 SUBSCRIBE runoobChat 订阅频道 runoobChat


image.png

客户端2 在 频道 runoobChat 发布消息,订阅者就能接收到消息。


image.png

客户端1将会接收:


image.png

频道的订阅与退订

Redis 将所有频道的订阅关系保存在服务器状态的字典里面,这个字典的健是某个被订阅的频道,而健的值则是一个链表,链表里面记录了所有订阅这个频道的客户端。

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

每当客户端执行``命令订阅某些频道的时候,服务器斗湖将客户端与被订阅频道在 字典中进行关联。
按照频道是否有订阅者,关联操作可以分为2种情况执行:

  • 如果频道已经有其他订阅者,那么它在pubsub_channels字典中必然有相应的订阅者列表,
  • 如果频道还未有任何订阅者,那么它必然不存在于pubsub_channels字典,程序首先在pubsub_channels字典中,为频道创建一个健,并将这个健的值设置为空链表,然后再将客户端添加到链表,成为一个链表的第一个元素。

调用栈

(gdb) bt
#0  pubsubSubscribeChannel (c=0x5555558dd358, channel=0x5555558dc2c8) at pubsub.c:65
#1  0x00005555555b3670 in subscribeCommand (c=0x5555558dd358) at pubsub.c:480
#2  0x0000555555577528 in call (c=0x5555558dd358, flags=7) at redis.c:2441
#3  0x0000555555578044 in processCommand (c=0x5555558dd358) at redis.c:2766
#4  0x00005555555865c4 in processInputBuffer (c=0x5555558dd358) at networking.c:1539
#5  0x00005555555868b2 in readQueryFromClient (el=0x5555558666f8, fd=7, privdata=0x5555558dd358, mask=1)
    at networking.c:1631
#6  0x00005555555701bf in aeProcessEvents (eventLoop=0x5555558666f8, flags=3) at ae.c:576
#7  0x0000555555570380 in aeMain (eventLoop=0x5555558666f8) at ae.c:635
#8  0x000055555557b30a in main (argc=2, argv=0x7fffffffe4c8) at redis.c:4079
int pubsubSubscribeChannel(redisClient *c, robj *channel) {
    dictEntry *de;
    list *clients = NULL;
    int retval = 0;

    /* Add the channel to the client -> channels hash table */
    // 将 channels 填接到 c->pubsub_channels 的集合中(值为 NULL 的字典视为集合)
    if (dictAdd(c->pubsub_channels,channel,NULL) == DICT_OK) {
        retval = 1;
        incrRefCount(channel);

        // 关联示意图
        // {
        //  频道名        订阅频道的客户端
        //  'channel-a' : [c1, c2, c3],
        // }
        /* Add the client to the channel -> list of clients hash table */
        // 从 pubsub_channels 字典中取出保存着所有订阅了 channel 的客户端的链表
        // 如果 channel 不存在于字典,那么添加进去
        de = dictFind(server.pubsub_channels,channel);
        if (de == NULL) {
            clients = listCreate();
            dictAdd(server.pubsub_channels,channel,clients);
            incrRefCount(channel);
        } else {
            clients = dictGetVal(de);
        }

        // before:
        // 'channel' : [c1, c2]
        // after:
        // 'channel' : [c1, c2, c3]
        // 将客户端添加到链表的末尾
        listAddNodeTail(clients,c);
    }

    /* Notify the client */
    // 回复客户端。
    // 示例:
    // redis 127.0.0.1:6379> SUBSCRIBE xxx
    // Reading messages... (press Ctrl-C to quit)
    // 1) "subscribe"
    // 2) "xxx"
    // 3) (integer) 1
    addReply(c,shared.mbulkhdr[3]);
    // "subscribe\n" 字符串
    addReply(c,shared.subscribebulk);
    // 被订阅的客户端
    addReplyBulk(c,channel);
    // 客户端订阅的频道和模式总数
    addReplyLongLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));

    return retval;
频道退订
/*  
 * 客户端 c 退订频道 channel ,如果取消成功返回 1 ,如果因为客户端未订阅频道,而造成取消失败,返回 0 。
*/
int pubsubUnsubscribeChannel(redisClient *c, robj *channel, int notify) {
    dictEntry *de;
    list *clients;
    listNode *ln;
    int retval = 0;

    // 将频道 channel 从 client->channels 字典中移除
    incrRefCount(channel);

    if (dictDelete(c->pubsub_channels,channel) == DICT_OK) {
        // channel 移除成功,表示客户端订阅了这个频道,执行以下代码
        retval = 1;

        // 从 channel->clients 的 clients 链表中,移除 client
        de = dictFind(server.pubsub_channels,channel);
        redisAssertWithInfo(c,NULL,de != NULL);
        clients = dictGetVal(de);
        ln = listSearchKey(clients,c);
        redisAssertWithInfo(c,NULL,ln != NULL);
        listDelNode(clients,ln);

        // 如果移除 client 之后链表为空,那么删除这个 channel 键
        if (listLength(clients) == 0) {
            dictDelete(server.pubsub_channels,channel);
        }
    }

    /* Notify the client */
    // 回复客户端
    if (notify) {
        addReply(c,shared.mbulkhdr[3]);
        // "ubsubscribe" 字符串
        addReply(c,shared.unsubscribebulk);
        // 被退订的频道
        addReplyBulk(c,channel);
        // 退订频道之后客户端仍在订阅的频道和模式的总数
        addReplyLongLong(c,dictSize(c->pubsub_channels)+
                       listLength(c->pubsub_patterns));
    }

    decrRefCount(channel); /* it is finally safe to release it */

    return retval;
}
模式的订阅

服务器将所有频道的订阅关系保存再服务器状态的,与此类似,服务器也将所有模式的订阅关系都保存在服务器状态的属性里面

struct redisServer
{
    list *pubsub_patterns;
    ...
};

pubsub_patterns 属性是一个链表,链表中的每一个节点都包含着一个pubsubPattern结构,这个结构的属性记录了被订阅的模式,而client性则记录了订阅模式的客户端。

struct pubsubPattern {
    redisClient* client;
    robj *pattern;    // 被订阅的模式
}
image.png

客户端执行命令订阅某些模式的时候,服务器会对每个被订阅的模式执行下列2个操作:

  • 新建一个``结构,将结构的属性设置为被订阅的模式,client属性设置为订阅模式的客户端
  • pubsubPattern结构添加到pubsub_patterns链表的表尾
模式的退订
发送消息
  • 将消息发给频道订阅者
  • 将消息发给模型订阅者
查看订阅信息
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容