Redis系列(八)：发布与订阅

野性酷女 2023-02-21 09:27 28阅读 0赞

Redis的发布与订阅，有点类似于**消息队列**，发送者往频道发送消息，频道的订阅者接收消息。

## 1. 发布与订阅示例 ##

首先，在本机开启第1个Redis客户端，执行如下命令订阅`blog.redis`频道：

SUBSCRIBE "blog.redis"

![format_png][]

然后，在本机开启第2个Redis客户端，执行相同的命令订阅`blog.redis`频道：

![format_png 1][]

然后，开启第3个Redis客户端，执行如下命令往`blog.redis`频道发送消息：

PUBLISH blog.redis "redis-in-action-01"

![format_png 2][]

查看客户端1和客户端2，分别看到如下信息：

![format_png 3][]

![format_png 4][]

3个客户端与频道的关系如下图所示：

![format_png 5][]

可以通过`INFO clients`命令查看连接的客户端数：

![format_png 6][]

## 2. 订阅/退订频道 ##

### 2.1 订阅频道 ###

Redis的`SUBSCRIBE`命令用来订阅频道，使用方式如下所示：

SUBSCRIBE "blog.redis"

如果是订阅多个频道，可以使用如下所示命令：

SUBSCRIBE "blog.redis" "blog.rocketmq"

Redis将所有频道的订阅关系保存在服务器状态的`pubsub_channels`字典里，字典的键是某个被订阅的频道，键对应的值是1个链表，链表里记录了所有订阅这个频道的客户端。

![format_png 7][]

以上图为例，说明客户端1、客户端2正在订阅频道"blog.redis"，客户端3、客户端4正在订阅频道“blog.rocketmq”。

如果此时有1个客户端5，执行了如下命令：

SUBSCRIBE "blog.rocketmq" "blog.java"

那么服务器状态保存的频道订阅关系将变为如下图所示：

![format_png 8][]

### 2.2 退订频道 ###

Redis的`UNSUBSCRIBE`命令用来退订频道，使用方式如下所示：

UNSUBSCRIBE "blog.redis"

如果是退订多个频道，可以使用如下所示命令：

UNSUBSCRIBE "blog.redis" "blog.rocketmq"

假设现在服务器状态保存的频道订阅关系如下图所示：

![format_png 8][]

如果此时客户端5，执行了如下命令：

UNSUBSCRIBE "blog.rocketmq" "blog.java"

那么服务器状态保存的频道订阅关系将变为如下图所示：

![format_png 7][]

## 3. 订阅/退订模式 ##

### 3.1 示例 ###

首先，启动1个Redis客户端，执行如下命令订阅模式“blog.r\*”：

PSUBSCRIBE "blog.r*"

![format_png 9][]

然后，启动另1个Redis客户端，执行`PUBLISH`命令往频道发送消息：

PUBLISH "blog.redis" "redis-in-action-01"
    
    PUBLISH "blog.rocketmq" "rocketmq-in-action-01"
    
    PUBLISH "blog.java" "java-in-action-01"

![format_png 10][]

可以看到，第1次启动的客户端可以接收到前2条消息，因为频道"blog.redis"、"blog.rocketmq"匹配模式“blog.r\*”：

![format_png 11][]

但频道"blog.java"不匹配该模式，所以最后1次发送的消息，该客户端未接收到。

### 3.2 订阅模式 ###

Redis的`PSUBSCRIBE`命令用来订阅模式，使用方式如下所示：

PSUBSCRIBE "blog.r*"

如果是订阅多个模式，可以使用如下所示命令：

PSUBSCRIBE "blog.r*" "blog.j?va" "blog.j[ae]va"

Redis将所有模式的订阅关系保存在服务器状态的`pubsub_patterns`属性里。

`pubsub_patterns`属性是1个链表，链表中的每个节点是1个`pubsub_Pattern`结构，这个结构的`pattern`属性记录被订阅的模式，`client`属性记录订阅模式的客户端。

![format_png 12][]

以上图为例，说明客户端1正在订阅模式"blog.r\*，客户端2正在订阅模式“blog.j?va”。

如果此时有1个客户端3，执行了如下命令：

PSUBSCRIBE "blog.j[ae]va"

那么服务器状态保存的模式订阅关系将变为如下图所示：

![format_png 13][]

### 3.3 退订模式 ###

Redis的`PUNSUBSCRIBE`命令用来退订模式，使用方式如下所示：

PUNSUBSCRIBE "blog.r*"

如果是退订多个模式，可以使用如下所示命令：

PUNSUBSCRIBE "blog.j?va" "blog.j[ae]va"

假设现在服务器状态保存的模式订阅关系如下图所示：

![format_png 13][]

如果此时客户端3，执行了如下命令：

PUNSUBSCRIBE "blog.j[ae]va"

那么服务器状态保存的模式订阅关系将变为如下图所示：

![format_png 12][]

## 4. 发送消息 ##

如果，服务器状态保存的频道订阅关系如下图所示：

![format_png 7][]

服务器状态保存的模式订阅关系如下图所示：

![format_png 14][]

此时，如果1个Redis客户端执行了以下PUBLISH命令：

PUBLISH blog.redis "redis-in-action-01"

那么，服务器会执行以下2个动作：

1.  将消息"redis-in-action-01"发送给频道“blog.redis”的所有订阅者
2.  将消息"redis-in-action-01"发送给与频道“blog.redis”相匹配模式的订阅者

也就是说，消息"redis-in-action-01"不仅会发送给频道“blog.redis”的订阅者客户端1、客户端2，也会发送给与频道“blog.redis”相匹配的模式“blog.r\*”的订阅者客户端5。

## 5. 查看订阅信息 ##

可以使用Redis的`PUBSUB`命令来查看频道或者模式的相关信息。

### 5.1 查看被订阅的频道 ###

如果想要查看被订阅的频道信息，可以使用命令`PUBSUB CHANNELS [pattern]`，其中pattern参数是可选的：

1.  如果不指定pattern参数，返回服务器当前被订阅的所有频道
2.  如果指定pattern参数，返回服务器被订阅的频道中与pattern模式相匹配的频道

这个命令的实现原理是通过遍历服务器状态保存的`pubsub_channels`字典来实现的。

举个具体的例子，如果服务器状态保存的`pubsub_channels`字典如下所示：

![format_png 8][]

那么执行命令`PUBSUB CHANNELS`的返回结果如下所示：

![format_png 15][]

执行命令`PUBSUB CHANNELS r*`的返回结果如下所示：

![format_png 16][]

### 5.2 查看频道的订阅者数量 ###

如果想要查看频道的订阅者数量，可以使用命令`PUBSUB NUMSUB [channel1 channel2 ... channeln]`。

这个命令的实现原理是通过遍历服务器状态保存的`pubsub_channels`字典来实现的，频道对应的订阅者链表的长度就是该频道的订阅者数量。

举个具体的例子，如果服务器状态保存的`pubsub_channels`字典如下所示：

![format_png 8][]

那么执行命令`PUBSUB NUMSUB blog.redis blog.rocketmq blog.java`的返回结果如下所示：

![format_png 17][]

### 5.3 查看被订阅模式的数量 ###

如果想要查看被订阅模式的数量，可以使用命令`PUBSUB NUMPAT`。

这个命令的实现原理是返回服务器状态保存的`pubsub_patterns`链表的长度。

举个具体的例子，如果服务器状态保存的`pubsub_patterns`链表如下所示：

![format_png 13][]

那么执行命令`PUBSUB NUMPAT`的返回结果如下所示：

![format_png 18][]

## 6. 总结 ##

Redis的发布与订阅有点类似于消息队列的发布与订阅，主要包含以下7个命令：

1.  SUBSCRIBE
2.  UNSUBSCRIBE
3.  PSUBSCRIBE
4.  PUNSUBSCRIBE
5.  PUBSUB CHANNELS
6.  PUBSUB NUMSUB
7.  PUBSUB NUMPAT

这7个命令的核心都是基于存储在服务器状态的`pubsub_channels`字典和`pubsub_patterns`链表实现的。

## 7. 参考 ##

黄健宏 《Redis设计与实现》

--------------------

注：如果觉得本篇博客有任何错误或者更好的建议，欢迎留言，我会及时跟进并更正博客内容！

> 文章持续更新，欢迎关注微信公众号「申城异乡人」第一时间阅读！

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjA5XzIwMzM1NS5wbmc?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjA5XzIwMzYwNi5wbmc?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjA5XzIwNDA0Ni5wbmc?x-oss-process=image/format,png
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjA5XzIwNDUxMi5wbmc?x-oss-process=image/format,png
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjA5XzIwNDU1NC5wbmc?x-oss-process=image/format,png
[format_png 5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjIzXzE5NTc0Mi5wbmc?x-oss-process=image/format,png
[format_png 6]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjEwXzA5NDgyMC5wbmc?x-oss-process=image/format,png
[format_png 7]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjIzXzIwMjMzMS5wbmc?x-oss-process=image/format,png
[format_png 8]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjIzXzIwMzMzNy5wbmc?x-oss-process=image/format,png
[format_png 9]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjI0XzE1MzY1MS5wbmc?x-oss-process=image/format,png
[format_png 10]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjI0XzE1NDAwNS5wbmc?x-oss-process=image/format,png
[format_png 11]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjI0XzE1NDE0Ny5wbmc?x-oss-process=image/format,png
[format_png 12]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjI5XzEwMzk1NC5wbmc?x-oss-process=image/format,png
[format_png 13]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjI5XzEwNDQxMS5wbmc?x-oss-process=image/format,png
[format_png 14]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjI5XzExMTY1OC5wbmc?x-oss-process=image/format,png
[format_png 15]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjI5XzExNTEwNC5wbmc?x-oss-process=image/format,png
[format_png 16]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjI5XzExNTIzNi5wbmc?x-oss-process=image/format,png
[format_png 17]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjI5XzEzMTU0My5wbmc?x-oss-process=image/format,png
[format_png 18]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMuend3aG5seS5jb20vcGljdHVyZS8yMDIwLzA2L3NuaXBhc3RlXzIwMjAwNjI5XzE5MjAyNi5wbmc?x-oss-process=image/format,png