Java实现Redis发布订阅

拼搏现实的明天。 2021-09-22 15:06 261阅读 0赞

今天因为项目需求，要实现redis的发布订阅功能，百度了下，然后把自己的经验总结了下

### 简介 ###

Redis提供了基于“发布/订阅”模式的消息机制，此种模式下，消息发布者和订阅者不进行直接通信，发布者客户端向指定的频道（channel）发布消息，订阅该频道的每个客户端都可以收到该消息（频道没有”创建“的概念，可以直接订阅、亦可直接发布消息）。

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

![20181117101156260.png][]

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3h1ZW1lbmdydWkxMg_size_16_color_FFFFFF_t_70][]

**实例**

以下实例演示了发布订阅是如何工作的。首先在我们封装的JedisUtils中加入发布和订阅操作的方法：

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

参数channel是消息的频道，message是消息的内容。在Junit测试或者其他的地方，使用工具类的此方法即可发布一个消息。

接收消息代码稍微复杂一些。首先定义一个类继承JedisPubSub，然后实现其中未实现的方法，最后在工具类JedisUtils中定义一个操作的方法即可。代码如下：

public class RedisMsgSubListener extends JedisPubSub {
        // 取得订阅的消息后的处理
        public void onMessage(String channel, String message) {
            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);
        }
    
    }

在工具类JedisUtils中定义一个操作的方法

/**
     * 接收消息。在main方法调用后，会一直执行下去。当有发布对应消息时，就会在jedisPubSub中接收到！
     *
     * @param jedisPubSub
     * @param channels
     */
    public void subscribeMsg(JedisPubSub jedisPubSub, String channels) {
        try {
            jedis.subscribe(jedisPubSub, channels);
        } catch (Exception e) {
        }
    }

下面写个方法测试下吧：

public class PubTest {
        JedisUtil4 jedisUtil;
        public void  publishMsg(){
            jedisUtil= JedisUtil4.getInstance();
            jedisUtil.publishMsg("test","hello world!");
        }
    
        public static void main(String[] args) {
            PubTest pubTest=new PubTest();
            pubTest.publishMsg();
        }
    }
    public class SubTest {
        JedisUtil4 jedisUtil;
        public void subscribeMsg(){
            jedisUtil=JedisUtil4.getInstance();
            RedisMsgSubListener pubsub = new RedisMsgSubListener();
            jedisUtil.subscribeMsg(pubsub, "test");
    
        }
    
        public static void main(String[] args) {
            new SubTest().subscribeMsg();
        }
    }

建议测试时，分开方法进行测试。其中publishMsg()方法是用来测试发布消息的,subscribeMsg()是用来测试接收订阅消息的。这里只是使用了普通订阅，大家还可以使用模式订阅。执行subscribeMsg()方法后，客户端会一直开启着，不会关闭。另外，在其他的redis客户端中发布一条消息，控制台就会立刻输出该消息。

参考：

[https://redis.io/commands][https_redis.io_commands]

[http://www.runoob.com/redis/redis-pub-sub.html][http_www.runoob.com_redis_redis-pub-sub.html]

[http://www.redis.net.cn/tutorial/3514.html][http_www.redis.net.cn_tutorial_3514.html]

[https://www.yiibai.com/redis/redis\_pub\_sub.html][https_www.yiibai.com_redis_redis_pub_sub.html]

[20181117101156260.png]: /images/20210920/8b54f7d97f624562893ba115bb90bf48.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3h1ZW1lbmdydWkxMg_size_16_color_FFFFFF_t_70]: /images/20210920/1b3ec784175a4207a3b1ccbfafce57b7.png
[https_redis.io_commands]: https://redis.io/commands
[http_www.runoob.com_redis_redis-pub-sub.html]: http://www.runoob.com/redis/redis-pub-sub.html
[http_www.redis.net.cn_tutorial_3514.html]: http://www.redis.net.cn/tutorial/3514.html
[https_www.yiibai.com_redis_redis_pub_sub.html]: https://www.yiibai.com/redis/redis_pub_sub.html