Redis 发布订阅

Redis 发布订阅(pub/sub)是一种消息通信模式：发送者(pub)发送消息，订阅者(sub)接收消息。

Redis 客户端可以订阅任意数量的频道。

下图展示了频道 channel1 ， 以及订阅这个频道的三个客户端 —— client2 、 client5 和 client1 之间的关系：

当有新消息通过 PUBLISH 命令发送给频道 channel1 时， 这个消息就会被发送给订阅它的三个客户端：

Redis 发布订阅命令

下表列出了 redis 发布订阅常用命令：

序号	命令及描述
1	PSUBSCRIBE pattern [pattern ...] 订阅一个或多个符合给定模式的频道。
2	PUBSUB subcommand [argument [argument ...]] 查看订阅与发布系统状态。
3	PUBLISH channel message 将信息发送到指定的频道。
4	PUNSUBSCRIBE [pattern [pattern ...]] 退订所有给定模式的频道。
5	SUBSCRIBE channel [channel ...] 订阅给定的一个或多个频道的信息。
6	UNSUBSCRIBE [channel [channel ...]] 指退订给定的频道。

实例

以下实例演示了发布订阅是如何工作的。在我们实例中我们创建了订阅频道名为 redisChat:redis 127.0.0.1:6379> SUBSCRIBE redisChat
Reading messages... (press Ctrl-C to quit)
1) "subscribe"
2) "redisChat"
3) (integer) 1

现在，我们先重新开启个 redis 客户端，然后在同一个频道 redisChat 发布两次消息，订阅者就能接收到消息。
redis 127.0.0.1:6379> PUBLISH redisChat "Redis is a great caching technique"
(integer) 1

redis 127.0.0.1:6379> PUBLISH redisChat "Learn redis by runoob.com"
(integer) 1

# 订阅者的客户端会显示如下消息
1) "message"
2) "redisChat"
3) "Redis is a great caching technique"
1) "message"
2) "redisChat"
3) "Learn redis by runoob.com"

 

发布订阅命令说明

1.PSUBSCRIBE(订阅一个或多个符合给定模式的频道)
PSUBSCRIBE pattern [pattern …]
订阅一个或多个符合给定模式的频道。
每个模式以* 作为匹配符，比如it* 匹配所有以it 开头的频道( it.news 、it.blog 、it.tweets 等等)，
news.* 匹配所有以news. 开头的频道( news.it 、news.global.today 等等)，诸如此类。
可用版本： >= 2.0.0
时间复杂度： O(N)，N 是订阅的模式的数量。
返回值： 接收到的信息(请参见下面的代码说明)。
redis> psubscribe news.*
Reading messages... (press Ctrl-C to quit)
1) "psubscribe" # 返回值的类型：显示订阅成功
2) "news.*" # 订阅的模式
3) (integer) 1 # 目前已订阅的模式的数量

1) "pmessage" # 返回值的类型：信息
2) "news.*" # 信息匹配的模式
3) "news.it" # 信息本身的目标频道
4) "Google buy Motorola" # 信息的内容

2.PUBLISH(将信息message 发送到指定的频道channel )
PUBLISH channel message
将信息message 发送到指定的频道channel 。
可用版本： >= 2.0.0
时间复杂度： O(N+M)，其中N 是频道channel 的订阅者数量，而M 则是使用模式订阅(subscribed
patterns) 的客户端的数量。
返回值： 接收到信息message 的订阅者数量。

# 对没有订阅者的频道发送信息
redis> publish bad_channel "can any body hear me?"
(integer) 0
# 向有一个订阅者的频道发送信息
redis> publish msg "good morning"
(integer) 1
# 向有多个订阅者的频道发送信息
redis> publish chat_room "hello~ everyone"
(integer) 3

3.PUBSUB(是一个查看订阅与发布系统状态的内省命令)
3.1.PUBSUB [argument [argument …]]
PUBSUB 是一个查看订阅与发布系统状态的内省命令，它由数个不同格式的子命令组成，以下将分别对这
些子命令进行介绍。
可用版本： >= 2.8.0
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"

3.2.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"

3.3.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

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

5.SUBSCRIBE (订阅给定的一个或多个频道的信息)
订阅给定的一个或多个频道的信息。
可用版本： >= 2.0.0
时间复杂度： 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 # 目前已订阅的频道数量
1) "subscribe"
2) "chat_room"
3) (integer) 2
1) "message" # 返回值的类型：信息
2) "msg" # 来源 (从那个频道发送过来)
3) "hello moto" # 信息内容
1) "message"
2) "chat_room"
3) "testing...haha"

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

---