在 Java 中使用 redis 的訊息佇列服務

楊高超發表於2018-01-04
JavaRedis佇列

前言

關於 redis 我們前面已經討論過了快取、分散式鎖、分散式唯一標識、LBS服務的用法，這裡我們來談談利用 redis 來實現一個訊息服務。

典型的訊息服務是一個生產者和消費者模式的服務。一般是有生產者產生訊息，將訊息傳送到佇列中。而訊息的消費者則監聽訊息，對訊息進行處理。

有很多非常優秀的訊息佇列服務的產品。例如 RabbitMQ、RocketMQ、Kafka 等。這些產品都具備非常高階的功能。可靠性、擴充套件性都非常的好。

但是 redis 自身也能夠很簡單的實現訊息佇列的生產者和消費者模式。本文簡單介紹一下在 Java 下是如何實現的。

相關命令介紹

參考 redis 官網 redis 和 pubsub 模式相關的命令如下。

  • PUBLISH channel message ：釋出一條訊息到指定的頻道
  • SUBSCRIBE channel [channel ...] ：訂閱指定頻道的訊息。頻道可以是多個
  • PSUBSCRIBE pattern [pattern ...] ：訂閱符合給定模式頻道的訊息
  • UNSUBSCRIBE [channel [channel ...]] ：停止訂閱指定頻道的訊息
  • PUNSUBSCRIBE [pattern [pattern ...]] ：停止訂閱指定模式頻道的訊息
  • PUBSUB subcommand [argument [argument ...]] ： 這個沒搞清

這裡面我們主要會用到前三個命令來實現一個基於 redis 的訊息佇列服務。

Jedis 相關介面

傳送訊息

public Long publish(final String channel, final String message)
複製程式碼

在這裡，我們會用這個介面來向訊息佇列指定的頻道傳送訊息，在 Java裡面的核心程式碼如下：

jedis = redisConnection.getJedis();
jedis.publish(channel, message);
複製程式碼

訂閱訊息

public void subscribe(final JedisPubSub jedisPubSub, final String... channels)
複製程式碼

在這裡，我們用這個介面來訂閱指定頻道的訊息，並且通過實現的 JedisPubSub 物件的回撥介面來處理收到的訊息。改邏輯核心程式碼如下所示

Jedis jedis = redisConnection.getJedis();
jedis.subscribe(new JedisPubSub() {
    @Override
    public void onMessage(String channel, String message) {
        //處理訊息邏輯程式碼
     }
複製程式碼

}, channels);

訊息釋出完整實現

定義介面

package com.x9710.common.redis;

/**
 * 訊息生產者服務介面
 *
 * @author 楊高超
 * @since 2018-01-03
 */
public interface MessagePublisher {
    boolean sendMessage(String message);
}
複製程式碼

實現介面

package com.x9710.common.redis.impl;

import com.x9710.common.redis.MessagePublisher;
import com.x9710.common.redis.RedisConnection;
import redis.clients.jedis.Jedis;

/**
 * 訊息生產者服務 redis 實現類
 *
 * @author 楊高超
 * @since 2018-01-03
 */
public class MessagePublisherRedisImpl implements MessagePublisher {
private RedisConnection redisConnection;

/**
 * 可以同時向多個頻道傳送資料
 */
private String[] channels;

public void setRedisConnection(RedisConnection redisConnection) {
    this.redisConnection = redisConnection;
}

public void setChannels(String[] channels) {
    this.channels = channels;
}

public boolean sendMessage(String message) {
    Jedis jedis = null;
    try {
        if (channels != null && channels.length > 0) {
            jedis = redisConnection.getJedis();
            for (String channel : channels) {
                jedis.publish(channel, message);
            }
            return true;
        }
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        if (jedis != null) {
            jedis.close();
        }
    }
    return false;
}
}
複製程式碼

訊息消費完整實現

定義介面

package com.x9710.common.redis;

/**
 * 訊息消費者服務介面
 *
 * @author 楊高超
 * @since 2018-01-03
 */
public interface MessageConsumer {
    void handleMessage(String message);
}
複製程式碼

實現介面

package com.x9710.common.redis.impl;

import com.x9710.common.redis.MessageConsumer;
import com.x9710.common.redis.RedisConnection;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPubSub;

/**
 * 訊息消費者服務 redis 實現類
 *
 * @author 楊高超
 * @since 2018-01-03
 */
public abstract class MessageConsumerRedisImpl implements MessageConsumer {

/**
 *
 * @param redisConnection redis 連線類
 * @param channels 訂閱的頻道列表
 */
public MessageConsumerRedisImpl(RedisConnection redisConnection, String[] channels) {
    Jedis jedis = null;
    try {
        if (channels != null && channels.length > 0) {
            jedis = redisConnection.getJedis();
            jedis.subscribe(new JedisPubSub() {
                @Override
                public void onMessage(String channel, String message) {
                    System.out.println("receive " + message + " from " + channel);
                    handleMessage(message);
                }
            }, channels);
        }
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        if (jedis != null) {
            jedis.close();
        }
    }
}
}
複製程式碼

這裡定義了一個抽象類，目的是讓使用者繼承該類來實現 handleMessage 方法，在該方法中實現收到訊息後的業務邏輯。

測試

實現訊息訂閱測試

package com.x9710.common.redis.test;

import com.x9710.common.redis.RedisConnection;
import com.x9710.common.redis.impl.MessageConsumerRedisImpl;
import org.junit.Test;

/**
 * 訊息消費服務測試類
 *
 * @author 楊高超
 * @since 2018-01-03
 */
public class RedisConsumerTest {

@Test
public void consumerTest() {
    RedisConnection redisConnection = RedisConnectionUtil.create();
    new MessageConsumerRedisImpl(redisConnection, new String[]{"channel1", "channel2"}) {
        public void handleMessage(String message) {
            System.out.println(message);
        }
    };
}

}
複製程式碼

實現訊息傳送測試

package com.x9710.common.redis.test;

import com.x9710.common.redis.RedisConnection;
import com.x9710.common.redis.impl.MessagePublisherRedisImpl;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;

/**
 * 訊息傳送服務測試類
 *
 * @author 楊高超
 * @since 2018-01-03
 */
public class RedisPublisherTest {
    private MessagePublisherRedisImpl messagePublisherRedis;

@Before
public void before() {
    RedisConnection redisConnection = RedisConnectionUtil.create();
    messagePublisherRedis = new MessagePublisherRedisImpl();
    messagePublisherRedis.setRedisConnection(redisConnection);
    messagePublisherRedis.setChannels(new String[]{"channel1", "channel2"});
}

@Test
public void publisherTest() {
    for (int i = 0; i < 3; i++) {
        Assert.assertTrue(messagePublisherRedis.sendMessage("message" + i));
    }
}
}
複製程式碼

執行測試

首先執行訊息消費測試用來訂閱訊息，然後執行訊息釋出測試用例來發布訊息。測試結果如下

redis pubsub 執行結果

後記

這個程式實在前面的文章《在 Java 中使用 redis》的基礎上新增新的實現類的方式完成的。程式碼同步釋出在 GitHub 倉庫中

原文發表在簡書中，原始連結

相關文章