Redis的发布订阅以及Java实现

最新推荐文章于 2023-06-13 11:22:50 发布

lpfasd123

最新推荐文章于 2023-06-13 11:22:50 发布

阅读量357

点赞数

本文链接：https://blog.csdn.net/lpfasd123/article/details/97190390

版权

转自订阅与发布

Redis 通过 PUBLISH 、 SUBSCRIBE等命令实现了订阅与发布模式，这个功能提供两种信息机制，分别是订阅/发布到频道和订阅/发布到模式，下文先讨论订阅/发布到频道的实现，再讨论订阅/发布到模式的实现。

频道的订阅与信息发送

Redis 的SUBSCRIBE命令可以让客户端订阅任意数量的频道，每当有新信息发送到被订阅的频道时，信息就会被发送给所有订阅指定频道的客户端。

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

image.png

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

image.png

在后面的内容中，我们将探讨 SUBSCRIBE和 PUBLISH命令的实现，以及这套订阅与发布机制的运作原理。

订阅频道

每个 Redis 服务器进程都维持着一个表示服务器状态的 redis.h/redisServer 结构，结构的 pubsub_channels 属性是一个字典，这个字典就用于保存订阅频道的信息：

struct redisServer {
    // ...
    dict *pubsub_channels;
    // ...
};

其中，字典的键为正在被订阅的频道，而字典的值则是一个链表，链表中保存了所有订阅这个频道的客户端。

比如说，在下图展示的这个 pubsub_channels 示例中， client2 、 client5 和 client1 就订阅了 channel1 ，而其他频道也分别被别的客户端所订阅：

image.png

当客户端调用 SUBSCRIBE命令时，程序就将客户端和要订阅的频道在 pubsub_channels 字典中关联起来。

举个例子，如果客户端 client10086 执行命令 SUBSCRIBE channel1 channel2 channel3 ，那么前面展示的 pubsub_channels 将变成下面这个样子：

image.png

SUBSCRIBE 命令的行为可以用伪代码表示如下：

def SUBSCRIBE(client, channels):

    # 遍历所有输入频道
    for channel in channels:

        # 将客户端添加到链表的末尾
        redisServer.pubsub_channels[channel].append(client)

通过 pubsub_channels 字典，程序只要检查某个频道是否为字典的键，就可以知道该频道是否正在被客户端订阅；只要取出某个键的值，就可以得到所有订阅该频道的客户端的信息。

发送信息到频道

了解了 pubsub_channels 字典的结构之后，解释 PUBLISH命令的实现就非常简单了：当调用 PUBLISH channel message 命令，程序首先根据 channel 定位到字典的键，然后将信息发送给字典值链表中的所有客户端。

比如说，对于以下这个 pubsub_channels 实例，如果某个客户端执行命令 PUBLISH channel1 "hello moto" ，那么 client2 、 client5 和 client1 三个客户端都将接收到 "hello moto" 信息：

image.png

PUBLISH 命令的实现可以用以下伪代码来描述：

def PUBLISH(channel, message):
    # 遍历所有订阅频道 channel 的客户端
    for client in server.pubsub_channels[channel]:
        # 将信息发送给它们
        send_message(client, message)

退订频道

使用 UNSUBSCRIBE命令可以退订指定的频道，这个命令执行的是订阅的反操作：它从 pubsub_channels 字典的给定频道（键）中，删除关于当前客户端的信息，这样被退订频道的信息就不会再发送给这个客户端。

模式的订阅与信息发送

当使用 PUBLISH命令发送信息到某个频道时，不仅所有订阅该频道的客户端会收到信息，如果有某个/某些模式和这个频道匹配的话，那么所有订阅这个/这些频道的客户端也同样会收到信息。

下图展示了一个带有频道和模式的例子，其中 tweet.shop.* 模式匹配了 tweet.shop.kindle 频道和 tweet.shop.ipad 频道，并且有不同的客户端分别订阅它们三个：

image.png

当有信息发送到 tweet.shop.kindle 频道时，信息除了发送给 clientX 和 clientY 之外，还会发送给订阅 tweet.shop.* 模式的 client123 和 client256 ：

[图片上传失败...(image-761baf-1563952369612)]

另一方面，如果接收到信息的是频道 tweet.shop.ipad ，那么 client123 和 client256 同样会收到信息：

image.png

订阅模式

redisServer.pubsub_patterns 属性是一个链表，链表中保存着所有和模式相关的信息：

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

链表中的每个节点都包含一个 redis.h/pubsubPattern 结构：

typedef struct pubsubPattern {
    redisClient *client;
    robj *pattern;
} pubsubPattern;

client 属性保存着订阅模式的客户端，而 pattern 属性则保存着被订阅的模式。

每当调用 PSUBSCRIBE 命令订阅一个模式时，程序就创建一个包含客户端信息和被订阅模式的 pubsubPattern 结构，并将该结构添加到 redisServer.pubsub_patterns 链表中。

作为例子，下图展示了一个包含两个模式的 pubsub_patterns 链表，其中 client123 和 client256 都正在订阅 tweet.shop.* 模式：

image.png

如果这时客户端 client10086 执行 PSUBSCRIBE broadcast.list.* ，那么 pubsub_patterns 链表将被更新成这样：

image.png

通过遍历整个 pubsub_patterns 链表，程序可以检查所有正在被订阅的模式，以及订阅这些模式的客户端。

发送信息到模式

发送信息到模式的工作也是由 PUBLISH 命令进行的，在前面讲解频道的时候，我们给出了这样一段伪代码，说它定义了 PUBLISH命令的行为：

def PUBLISH(channel, message):

    # 遍历所有订阅频道 channel 的客户端
    for client in server.pubsub_channels[channel]:

        # 将信息发送给它们
        send_message(client, message)

但是，这段伪代码并没有完整描述 PUBLISH命令的行为，因为 PUBLISH除了将 message 发送到所有订阅 channel 的客户端之外，它还会将 channel 和 pubsub_patterns 中的模式进行对比，如果 channel 和某个模式匹配的话，那么也将 message 发送到订阅那个模式的客户端。

完整描述 PUBLISH功能的伪代码定于如下：

def PUBLISH(channel, message):

    # 遍历所有订阅频道 channel 的客户端
    for client in server.pubsub_channels[channel]:

        # 将信息发送给它们
        send_message(client, message)

    # 取出所有模式，以及订阅模式的客户端
    for pattern, client in server.pubsub_patterns:

        # 如果 channel 和模式匹配
        if match(channel, pattern):

            # 那么也将信息发给订阅这个模式的客户端
            send_message(client, message)

举个例子，如果 Redis 服务器的 pubsub_patterns 状态如下：

image.png

那么当某个客户端发送信息 "Amazon Kindle, $69." 到 tweet.shop.kindle 频道时，除了所有订阅了 tweet.shop.kindle 频道的客户端会收到信息之外，客户端 client123 和 client256 也同样会收到信息，因为这两个客户端订阅的 tweet.shop.* 模式和 tweet.shop.kindle频道匹配。

退订模式

使用 PUNSUBSCRIBE 命令可以退订指定的模式，这个命令执行的是订阅模式的反操作：程序会删除 redisServer.pubsub_patterns 链表中，所有和被退订模式相关联的 pubsubPattern 结构，这样客户端就不会再收到和模式相匹配的频道发来的信息。

小结

订阅信息由服务器进程维持的 redisServer.pubsub_channels 字典保存，字典的键为被订阅的频道，字典的值为订阅频道的所有客户端。
当有新消息发送到频道时，程序遍历频道（键）所对应的（值）所有客户端，然后将消息发送到所有订阅频道的客户端上。
订阅模式的信息由服务器进程维持的 redisServer.pubsub_patterns 链表保存，链表的每个节点都保存着一个 pubsubPattern 结构，结构中保存着被订阅的模式，以及订阅该模式的客户端。程序通过遍历链表来查找某个频道是否和某个模式匹配。
当有新消息发送到频道时，除了订阅频道的客户端会收到消息之外，所有订阅了匹配频道的模式的客户端，也同样会收到消息。
退订频道和退订模式分别是订阅频道和订阅模式的反操作。

Java实现

依赖

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>2.10.2</version>
</dependency>

ps：springboot现在对于jedis的3.0的兼容还是有问题的，会有safeEncode的类找不到的错误，原因是3.0之后jedis的目录结构变化

redis.clients.util -> redis.clients.jedis.util

推送消息

@Component
public class ChannelComponent implements InitializingBean {
    @Autowired
    JedisConnectionFactory jedisConnectionFactory;

    private Jedis jedis;

    private static final String key = "userBehavior";

    /**
     * 发布一个消息
     *
     * @param message
     */
    public void publishMsg(String message) {
        try {
            jedis.publish(key, message);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        jedis = (Jedis) jedisConnectionFactory.getConnection().getNativeConnection();
    }
}

订阅
首先定义一个消息处理类，继承JedisPubSub

public class RedisMsgSubListener extends JedisPubSub {
    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    // 取得订阅的消息后的处理
    public void onMessage(String channel, String message) {
        logger.info(channel + "=" + message);
        System.out.println(channel + "=" + message);
    }
    @Override
    // 取得按表达式的方式订阅的消息后的处理
    public void onPMessage(String pattern, String channel, String message) {
        System.out.println(pattern + "=" + channel + "=" + message);
    }
    @Override
    // 初始化订阅时候的处理
    public void onSubscribe(String channel, int subscribedChannels) {
        System.out.println(channel + "=" + subscribedChannels);
    }
    @Override
    // 取消订阅时候的处理
    public void onUnsubscribe(String channel, int subscribedChannels) {
        System.out.println(channel + "=" + subscribedChannels);
    }
    @verride
    // 取消按表达式的方式订阅时候的处理
    public void onPUnsubscribe(String pattern, int subscribedChannels) {
        System.out.println(pattern + "=" + subscribedChannels);
    }
    @Override
    // 初始化按表达式的方式订阅时候的处理
    public void onPSubscribe(String pattern, int subscribedChannels) {
        System.out.println(pattern + "=" + subscribedChannels);
    }
}

@Component
public class RedisUtil implements InitializingBean {

    @Autowired
    JedisConnectionFactory jedisConnectionFactory;
    private Jedis jedisSub;
    private static final String key = "myWay";
    /**
     * 接收消息。在main方法调用后，会一直执行下去。当有发布对应消息时，就会在jedisPubSub中接收到！
     */
    public void subscribeMsg() {
        try {
            RedisMsgSubListener listener = new RedisMsgSubListener();
            jedisSub.subscribe(listener, key);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        this.jedisSub = (Jedis) jedisConnectionFactory.getConnection().getNativeConnection();
        Thread thread = new Thread(new Runnable() {
            @Override
            public void run() {
                subscribeMsg();
            }
        });
        thread.start();
    }

源码,有帮助的话，请点?

lpfasd123

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
Redis的发布订阅以及Java实现

转自订阅与发布Redis 通过 PUBLISH 、 SUBSCRIBE等命令实现了订阅与发布模式，这个功能提供两种信息机制，分别是订阅/发布到频道和订阅/发布到模式，下文先讨论订阅/发布到频道的实现，再讨论订阅/发布到模式的实现。频道的订阅与信息发送Redis 的SUBSCRIBE命令可以让客户端订阅任意数量的频道，每当有新信息发送到被订...
复制链接

扫一扫