Redis的Pub/Sub(发布/订阅)

Redis 发布订阅(pub/sub)是一种消息通信模式:发送者(pub)发送消息,订阅者(sub)接收消息。redis内置了发布/订阅功能,可以作为消息机制使用。在使用Jedis的Publish/Subscribe功能之前,我们先来看原生版的发布订阅命令。

原生版Redis 发布订阅命令

1.SUBSCRIBE channel [channel ...]

    订阅给定的一个或多个频道的信息。
  时间复杂度:
    O(N),其中 N 是订阅的频道的数量。
  返回值:
    接收到的信息(请参见下面的代码说明)。

# 订阅 msg 和 chat_room 两个频道

# 1 - 6 行是执行 subscribe 之后的反馈信息
# 第 7 - 9 行才是接收到的第一条信息
# 第 10 - 12 行是第二条

redis> subscribe msg chat_room
Reading messages... (press Ctrl-C to quit)
1) "subscribe"       # 返回值的类型:显示订阅成功
2) "msg"             # 订阅的频道名字
3) (integer) 1       # 目前已订阅的频道数量

4) "subscribe"
5) "chat_room"
6) (integer) 2

7) "message"         # 返回值的类型:信息
8) "msg"             # 来源(从那个频道发送过来)
9) "hello moto"      # 信息内容

10) "message"
11) "chat_room"
12) "testing...haha"
2.PSUBSCRIBE pattern [pattern ...]

    订阅一个或多个符合给定模式的频道。每个模式以 * 作为匹配符,比如 it* 匹配所有以 it 开头的频道( it.news 、 it.blog 、 it.tweets 等等), news.* 匹配所有以 news. 开头的频道( news.it 、 news.global.today 等等),诸如此类。
时间复杂度:
    O(N), N 是订阅的模式的数量。
返回值:
    接收到的信息(请参见下面的代码说明)。

# 订阅 news.* 和 tweet.* 两个模式

# 第 1 - 6 行是执行 psubscribe 之后的反馈信息
# 第 7 - 10 才是接收到的第一条信息
# 第 11 - 14 是第二条
# 以此类推。。。

redis> psubscribe news.* tweet.*
Reading messages... (press Ctrl-C to quit)
1) "psubscribe"                  # 返回值的类型:显示订阅成功
2) "news.*"                      # 订阅的模式
3) (integer) 1                   # 目前已订阅的模式的数量

4) "psubscribe"
5) "tweet.*"
6) (integer) 2

7) "pmessage"                    # 返回值的类型:信息
8) "news.*"                      # 信息匹配的模式
9) "news.it"                     # 信息本身的目标频道
10) "Google buy Motorola"         # 信息的内容

11) "pmessage"
12) "tweet.*"
13) "tweet.huangz"
14) "hello"

15) "pmessage"
16) "tweet.*"
17) "tweet.joe"
18) "@huangz morning"

19) "pmessage"
20) "news.*"
21) "news.life"
22) "An apple a day, keep doctors away"
3.UNSUBSCRIBE [channel [channel ...]]

    指示客户端退订给定的频道。如果没有频道被指定,即一个无参数的 UNSUBSCRIBE 调用被执行,那么客户端使用SUBSCRIBE命令订阅的所有频道都会被退订。在这种情况下,命令会返回一个信息,告知客户端所有被退订的频道。
时间复杂度:
    O(N) , N 是客户端已订阅的频道的数量。
返回值:
    这个命令在不同的客户端中有不同的表现

4.PUNSUBSCRIBE [pattern [pattern ...]]

    指示客户端退订所有给定模式。如果没有模式被指定,也即是,一个无参数的 PUNSUBSCRIBE调用被执行,那么客户端使用 PSUBSCRIBE命令订阅的所有模式都会被退订。在这种情况下,命令会返回一个信息,告知客户端所有被退订的模式。
时间复杂度:
    O(N+M) ,其中 N是客户端已订阅的模式的数量, M则是系统中所有客户端订阅的模式的数量。
返回值:
    这个命令在不同的客户端中有不同的表现。

5.PUBSUB CHANNELS [pattern]

列出当前的活跃频道。活跃频道指的是那些至少有一个订阅者的频道, 订阅模式的客户端不计算在内。
pattern 参数是可选的:
如果不给出 pattern 参数,那么列出订阅与发布系统中的所有活跃频道。
如果给出 pattern 参数,那么只列出和给定模式 pattern 相匹配的那些活跃频道。
复杂度: O(N) ,N 为活跃频道的数量(对于长度较短的频道和模式来说,将进行模式匹配的复杂度视为常数)。
返回值: 一个由活跃频道组成的列表。

# client-1 订阅 news.it 和 news.sport 两个频道

client-1> SUBSCRIBE news.it news.sport
Reading messages... (press Ctrl-C to quit)
1) "subscribe"
2) "news.it"
3) (integer) 1
1) "subscribe"
2) "news.sport"
3) (integer) 2

# client-2 订阅 news.it 和 news.internet 两个频道

client-2> SUBSCRIBE news.it news.internet
Reading messages... (press Ctrl-C to quit)
1) "subscribe"
2) "news.it"
3) (integer) 1
1) "subscribe"
2) "news.internet"
3) (integer) 2

# 首先, client-3 打印所有活跃频道
# 注意,即使一个频道有多个订阅者,它也只输出一次,比如 news.it

client-3> PUBSUB CHANNELS
1) "news.sport"
2) "news.internet"
3) "news.it"

# 接下来, client-3 打印那些与模式 news.i* 相匹配的活跃频道
# 因为 news.sport 不匹配 news.i* ,所以它没有被打印

redis> PUBSUB CHANNELS news.i*
1) "news.internet"
2) "news.it"
6.PUBSUB NUMSUB [channel-1 ... channel-N]

返回给定频道的订阅者数量, 订阅模式的客户端不计算在内。
复杂度: O(N) , N 为给定频道的数量。
返回值:一个多条批量回复(Multi-bulk reply),回复中包含给定的频道,以及频道的订阅者数量。 格式为:频道 channel-1 , channel-1 的订阅者数量,频道 channel-2 , channel-2 的订阅者数量,诸如此类。 回复中频道的排列顺序和执行命令时给定频道的排列顺序一致。 不给定任何频道而直接调用这个命令也是可以的, 在这种情况下, 命令只返回一个空列表。

# client-1 订阅 news.it 和 news.sport 两个频道

client-1> SUBSCRIBE news.it news.sport
Reading messages... (press Ctrl-C to quit)
1) "subscribe"
2) "news.it"
3) (integer) 1
1) "subscribe"
2) "news.sport"
3) (integer) 2

# client-2 订阅 news.it 和 news.internet 两个频道

client-2> SUBSCRIBE news.it news.internet
Reading messages... (press Ctrl-C to quit)
1) "subscribe"
2) "news.it"
3) (integer) 1
1) "subscribe"
2) "news.internet"
3) (integer) 2

# client-3 打印各个频道的订阅者数量

client-3> PUBSUB NUMSUB news.it news.internet news.sport news.music
1) "news.it"    # 频道
2) "2"          # 订阅该频道的客户端数量
3) "news.internet"
4) "1"
5) "news.sport"
6) "1"
7) "news.music" # 没有任何订阅者
8) "0"
7.PUBSUB NUMPAT

返回订阅模式的数量。
注意,这个命令返回的不是订阅模式的客户端的数量, 而是客户端订阅的所有模式的数量总和。
复杂度: O(1) 。
返回值: 一个整数回复(Integer reply)。

# client-1 订阅 news.* 和 discount.* 两个模式

client-1> PSUBSCRIBE news.* discount.*
Reading messages... (press Ctrl-C to quit)
1) "psubscribe"
2) "news.*"
3) (integer) 1
1) "psubscribe"
2) "discount.*"
3) (integer) 2

# client-2 订阅 tweet.* 一个模式

client-2> PSUBSCRIBE tweet.*
Reading messages... (press Ctrl-C to quit)
1) "psubscribe"
2) "tweet.*"
3) (integer) 1

# client-3 返回当前订阅模式的数量为 3

client-3> PUBSUB NUMPAT
(integer) 3

# 注意,当有多个客户端订阅相同的模式时,相同的订阅也被计算在 PUBSUB NUMPAT 之内
# 比如说,再新建一个客户端 client-4 ,让它也订阅 news.* 频道

client-4> PSUBSCRIBE news.*
Reading messages... (press Ctrl-C to quit)
1) "psubscribe"
2) "news.*"
3) (integer) 1

# 这时再计算被订阅模式的数量,就会得到数量为 4

client-3> PUBSUB NUMPAT
(integer) 4

Jedis发布订阅命令

要使用JedisPublish/Subscribe功能,必须编写对JedisPubSub的自己的实现,其中的函数的功能如下:

public class PubSubListener extends JedisPubSub{

    // 取得订阅的消息后的处理
    public void onMessage(String channel, String message) {
        //TODO:接收订阅频道消息后,业务处理逻辑
        System.out.println(channel + "=" + message);
    }

    // 初始化订阅时候的处理
    public void onSubscribe(String channel, int subscribedChannels) {
         System.out.println(channel + "=" + subscribedChannels);
    }

    // 取消订阅时候的处理
    public void onUnsubscribe(String channel, int subscribedChannels) {
         System.out.println(channel + "=" + subscribedChannels);
    }

    // 初始化按表达式的方式订阅时候的处理
    public void onPSubscribe(String pattern, int subscribedChannels) {
         System.out.println(pattern + "=" + subscribedChannels);
    }

    // 取消按表达式的方式订阅时候的处理
    public void onPUnsubscribe(String pattern, int subscribedChannels) {
         System.out.println(pattern + "=" + subscribedChannels);
    }

    // 取得按表达式的方式订阅的消息后的处理
    public void onPMessage(String pattern, String channel, String message) {
        System.out.println(pattern + "=" + channel + "=" + message);
    }

}

Jedis有两种订阅模式:subsribe(一般模式设置频道)和psubsribe(使用模式匹配来设置频道)。不管是那种模式都可以设置个数不定的频道。订阅得到信息在将会lister的onMessage(…)方法或者onPMessage(…)中进行进行处理,这里我们只是做了简单的输出。 具体代码见GitHup:https://github.com/granett/Redis/tree/master/src/main/java/com/redis/pubsub

public class Subscribe {

    private Jedis jedis = new Jedis("192.168.1.207",6379);

    /**
     * SUBSCRIBE channel [channel ...]
     * 订阅给定的一个或多个频道的信息
     */
    @Test
    public void subscribe(){
        final PubSubListener listener = new PubSubListener();
        jedis.subscribe(listener, "channel");
    }

    /**
     * UNSUBSCRIBE [channel [channel ...]]
     * 指示客户端退订给定的频道
     * 如果没有频道被指定,即一个无参数的 UNSUBSCRIBE 调用被执行,
     * 那么客户端使用 SUBSCRIBE 命令订阅的所有频道都会被退订。
     * 在这种情况下,命令会返回一个信息,告知客户端所有被退订的频道。
     */
    @Test
    public void unsubscribe(){
        final PubSubListener listener = new PubSubListener();
        listener.unsubscribe("channel");
    }

    /**
     * PSUBSCRIBE pattern [pattern ...]
     * 订阅一个或多个符合给定模式的频道
     * 每个模式以 * 作为匹配符,比如 it* 匹配所有以 it 开头的频道( it.news 、 it.blog 、 it.tweets 等等),
     * news.* 匹配所有以 news. 开头的频道( news.it 、 news.global.today 等等),诸如此类。
     */
    @Test
    public void psubscribe(){
        final PubSubListener listener = new PubSubListener();
        jedis.psubscribe(listener, "ch*");
    }

    /**
     * PUNSUBSCRIBE [pattern [pattern ...]]
     * 指示客户端退订所有给定模式
     * 如果没有模式被指定,即一个无参数的 PUNSUBSCRIBE 调用被执行,
     * 那么客户端使用 PSUBSCRIBE 命令订阅的所有模式都会被退订。
     * 在这种情况下,命令会返回一个信息,告知客户端所有被退订的模式。
     */
    @Test
    public void punsubscribe(){
        final PubSubListener listener = new PubSubListener();
        listener.punsubscribe("ch*");
    }

    /**
     * PUBLISH channel message
     * 将信息 message 发送到指定的频道 channel
     * 返回值:接收到信息 message 的订阅者数量
     */
    @Test
    public void publish(){
        jedis.publish("channel", "bar123");
        System.out.println("发布消息");
    }

    /**
     * PUBSUB CHANNELS [pattern]
     * 列出当前的活跃频道。 活跃频道指的是那些至少有一个订阅者的频道, 订阅模式的客户端不计算在内。
     * pattern 参数是可选的:
     *    如果不给出 pattern 参数,那么列出订阅与发布系统中的所有活跃频道。
     *    如果给出 pattern 参数,那么只列出和给定模式 pattern 相匹配的那些活跃频道。
     */
    @Test
    public void PUBSUB(){
        List<String> list = jedis.pubsubChannels("*");
        System.out.println(list);
    }

    /**
     * PUBSUB NUMSUB [channel-1 ... channel-N]
     * 返回给定频道的订阅者数量, 订阅模式的客户端不计算在内。
     */
    @Test
    public void pubsubNumSub(){
        Map<String,String> map = jedis.pubsubNumSub();
        System.out.println(map);
    }

    /**
     * PUBSUB NUMPAT
     * 返回订阅模式的数量。
     * 注意, 这个命令返回的不是订阅模式的客户端的数量, 而是客户端订阅的所有模式的数量总和。
     */
    @Test
    public void pubsubNumPat(){
        Long count = jedis.pubsubNumPat();
        System.out.println(count);
    }

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,087评论 18 139
  • redis-订阅与发布 Redis 通过 PUBLISH 、 SUBSCRIBE 等命令实现了订阅与发布模式, 这...
    全能程序猿阅读 5,806评论 0 4
  • Redis 发布订阅 Redis 发布订阅(pub/sub)是一种消息通信模式:发送者(pub)发送消息,订阅者(...
    stakeing阅读 272评论 0 0
  • ——记2017年武汉马拉松 终于,终于把马拉松跑完了。按照原计划,去年就应该完成,可是一直拖,又不肯努力训练。就这...
    我的闺蜜是只猫阅读 213评论 0 0
  • 在《少有人走的路》第一部分中,作者提出了:自律是解决人生的首要方案。而在第二部分中,探讨的是:自律的原动力——爱。...
    Glimin阅读 463评论 0 1