【Redis】Pub/Sub（发布/订阅）

前言 

Pub/Sub（发布/订阅）是一种消息传递模式，其中消息发送者（发布者）将消息发布到一个或多个主题（topics）或频道（channels），而消息接收者（订阅者）订阅特定的主题或频道以接收消息。

在Pub/Sub模式中，发布者和订阅者不直接通信，而是通过一个中介（通常称为消息代理或消息中间件）进行通信。发布者将消息发送到消息代理，消息代理将消息存储在某个地方，并根据订阅者的订阅列表将消息推送给相应的订阅者。

Pub/Sub模式具有以下优点：

1. 异步：发布者和订阅者可以在不同的时间、不同的地点发送和接收消息，从而实现异步通信。
2. 解耦：发布者和订阅者不需要知道彼此的存在，只需要知道消息代理的存在，从而降低了耦合度。
3. 广播：发布者可以将消息发送给多个订阅者，从而实现广播效果。
4. 负载均衡：订阅者可以从多个消息代理中接收消息，从而实现负载均衡的效果。

常见的Pub/Sub框架包括：

1. Apache Kafka：一个分布式流处理平台，支持高吞吐量的Pub/Sub消息传递，可用于数据集成、流处理、事件驱动等场景。
2. RabbitMQ：一个开源的消息代理和消息传递系统，支持多种消息协议，包括AMQP、MQTT和STOMP等。
3. Redis：一个内存中的数据结构存储系统，也支持Pub/Sub功能，可用于实现实时通信和广播。
4. NSQ：一个分布式消息传递系统，基于Go语言编写，支持高吞吐量的Pub/Sub消息传递，可用于实时数据流处理、事件驱动等场景。
5. ZeroMQ：一个简单、高性能的消息传递库，支持多种消息模式，包括Pub/Sub、Push/Pull、REQ/REP等，可用于构建高性能的分布式系统。

Pub/Sub相关流程图

Pub/Sub功能相关的命令 

Redis中的Pub/Sub功能相关的命令：

• PSUBSCRIBE：订阅一个或多个符合给定模式的频道。
• PUBLISH：向一个或多个频道发布消息。
• PUBSUB：返回一个或多个给定频道的订阅者数量。

           1：PUBSUB CHANNELS pattern]：返回一个或多个匹配给定模式的频道的列表。

           2：PUBSUB NUMSUB[channel-1 ... channel-N]：返回一个或多个给定频道的订阅者数量。

           3：PUBSUB NUMPAT：返回当前已订阅模式的数量。

• PUNSUBSCRIBE：取消订阅所有频道。
• SUBSCRIBE：订阅一个或多个频道。
• UNSUBSCRIBE：取消订阅指定的频道。

这些命令用于在Redis中实现发布/订阅模式，使消息的发布者和订阅者能够通过中介进行异步通信。

SUBSCRIBE(订阅一个或多个频道)

说明

1、语法

SUBSCRIBE channel [channel ...]

•  订阅给定的一个或多个频道的信息。

2、时间复杂度

• O(N)，其中 N 是订阅的频道的数量。

3、返回值

• 接收到的信息(见下面的代码说明)。

 示例

• 执行 SUBSCRIBE 之后的反馈信息

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

1) "subscribe"
2) "chatroom"
3) (integer) 2

•  接收到的信息

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

1) "subscribe"
2) "chatroom"
3) (integer) 2


# 接收到的信息，如下↓
1) "message"        # 返回值的类型：信息
2) "msg"            # 来源(从那个频道发送过来)
3) "hello redis"    # 信息内容

1) "message"
2) "msg"
3) "news"

PUBLISH(向一个或多个频道发布消息)

说明

1、语法

PUBLISH channel message

• 将信息 message 发送到指定的频道 channel 。

2、时间复杂度

• O(N+M)，其中 N 是频道 channel 的订阅者数量，而 M 则是使用模式订阅(subscribed patterns)的客户端的数量。

3、返回值

• 接收到信息 message 的订阅者数量。

 示例

# 对没有订阅者的频道发送信息
127.0.0.1:6379> PUBLISH no_channel "is anybody there ?"
(integer) 0


# 向有一个订阅者的频道发送信息
127.0.0.1:6379> PUBLISH msg "good morning"
(integer) 1


# 向有多个订阅者的频道发送信息
127.0.0.1:6379> PUBLISH chatroom "good morning"
(integer) 3
127.0.0.1:6379>

PUBSUB

1、PUBSUB CHANNELS pattern](返回一个或多个匹配给定模式的频道的列表)

说明

1.1、语法

PUBSUB CHANNELS pattern]

• 列出当前的活跃频道。
• 活跃频道指的是那些至少有一个订阅者的频道， 订阅模式的客户端不计算在内。

1.2、pattern 参数是可选的

• 如果不给出 pattern 参数，那么列出订阅与发布系统中的所有活跃频道。
• 如果给出 pattern 参数，那么只列出和给定模式 pattern 相匹配的那些活跃频道。

1.3、时间复杂度

• O(N) ， N 为活跃频道的数量（对于长度较短的频道和模式来说，将进行模式匹配的复杂度视为常数）。

1.4、返回值

• 一个由活跃频道组成的列表。

 示例

# 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"

2、PUBSUB NUMSUB[channel-1 ... channel-N](返回一个或多个给定频道的订阅者数量)

说明

2.1、语法

PUBSUB NUMSUB[channel-1 ... channel-N]

• 返回给定频道的订阅者数量， 订阅模式的客户端不计算在内。

2.2、时间复杂度

• O(N) ， N 为给定频道的数量。

2.3、返回值

• 一个多条批量回复（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、PUBSUB NUMPAT(返回当前已订阅模式的数量)

3.1、语法

PUBSUB NUMPAT

• 返回订阅模式的数量。
• 注意， 这个命令返回的不是订阅模式的客户端的数量， 而是客户端订阅的所有模式的数量总和。

3.2、时间复杂度

• O(1) 。

3.3、返回值

• 一个整数回复（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

SUBSCRIBE(订阅一个或多个符合给定模式的频道)

说明

1、语法

PSUBSCRIBE pattern [pattern ...]

• 订阅一个或多个符合给定模式的频道。

• 每个模式以 * 作为匹配符，比如 it* 匹配所有以 it 开头的频道( it.news 、 it.blog 、 it.tweets 等等)， news.* 匹配所有以 news. 开头的频道( news.it 、 news.global.today 等等)，诸如此类。

2、时间复杂度

• O(N)，N 是订阅的模式的数量。

3、返回值

• 接收到的信息(请参见下面的代码说明)。

 示例

# 订阅 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                   # 目前已订阅的模式的数量

1) "psubscribe"
2) "tweet.*"
3) (integer) 2

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

1) "pmessage"
2) "tweet.*"
3) "tweet.huangz"
4) "hello"

1) "pmessage"
2) "tweet.*"
3) "tweet.joe"
4) "@huangz morning"

1) "pmessage"
2) "news.*"
3) "news.life"
4) "An apple a day, keep doctors away"

PUNSUBSCRIBE(取消订阅所有频道)

1、语法

PUNSUBSCRIBE [pattern [pattern ...]]

•  指示客户端退订所有给定模式。
• 如果没有模式被指定，也即是，一个无参数的 PUNSUBSCRIBE 调用被执行，那么客户端使用 PSUBSCRIBE 命令订阅的所有模式都会被退订。在这种情况下，命令会返回一个信息，告知客户端所有被退订的模式。    

2、时间复杂度

• O(N+M) ，其中 N 是客户端已订阅的模式的数量， M 则是系统中所有客户端订阅的模式的数量。

3、返回值

• 这个命令在不同的客户端中有不同的表现。

UNSUBSCRIBE(取消订阅指定的频道)

1、语法

UNSUBSCRIBE [channel [channel ...]]

•  指示客户端退订给定的频道。

• 如果没有频道被指定，也即是，一个无参数的 UNSUBSCRIBE 调用被执行，那么客户端使用 SUBSCRIBE 命令订阅的所有频道都会被退订。在这种情况下，命令会返回一个信息，告知客户端所有被退订的频道。

2、时间复杂度

• O(N) ， N 是客户端已订阅的频道的数量。

3、返回值

• 这个命令在不同的客户端中有不同的表现。