延时队列-基于Redisson实现的延时队列

前言

定时调度基本是每个项目都会遇到的业务场景,一般地,都会通过任务调度工具执行定时任务完成,定时任务有两点缺陷,一、定时任务执行频度限制,实际执行的时间可能会晚于理想的设定时间,例如,如果要通过定时任务实现在下单后15分钟仍未支付则取消订单的功能,假设定时任务的执行频度为每分钟执行一次,对于有些订单而言,其实际取消时间是介于15-16分钟之间,不够精确;二、定时任务执行需要时间,定时任务的执行也需要时间,如果业务场景的数据量较大,执行一次定时任务需要足够长的时间,进一步放大了缺点一。

Redisson延时队列

在上一篇文章中延时队列-基于RabbitMq延时消息插件实现的延时队列
介绍了一种基于RabbitMq延时消息插件实现的延时队列,除此之外,另一种比较常见的实现方式是Redisson延时队列。
在Redisson官网文档中,使用延时队列的代码如下:

RQueue distinationQueue = ...
RDelayedQueue delayedQueue = getDelayedQueue(distinationQueue);
// 10秒钟以后将消息发送到指定队列
delayedQueue.offer("msg1", 10, TimeUnit.SECONDS);
// 一分钟以后将消息发送到指定队列
delayedQueue.offer("msg2", 1, TimeUnit.MINUTES);

当该延时队列不需要使用时,应当主动销毁

RDelayedQueue delayedQueue = ...
delayedQueue.destroy();

Redisson的延时队列是对另一个队列的再包装,使用时要先将延时消息添加到延时队列中,当延时队列中的消息达到设定的延时时间后,该延时消息才会进行进入到被包装队列中,因此,我们只需要对被包装队列进行监听即可。

代码部分

在上一篇文章中,我们定义了DelayMessageManager延时消息管理器并提供了一种基于RabbitMq的实现,本文中我们再提供一种基于Redisson延时队列的实现即可。

package com.cube.share.delay.manager;

import cn.hutool.core.thread.ThreadUtil;
import com.cube.share.delay.handler.DelayMessageHandler;
import com.cube.share.delay.message.DelayMessage;
import com.cube.share.delay.message.DelayMessageType;
import lombok.extern.slf4j.Slf4j;
import org.redisson.Redisson;
import org.redisson.api.RBlockingQueue;
import org.redisson.api.RDelayedQueue;
import org.redisson.api.RedissonClient;
import org.springframework.stereotype.Component;

import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import static com.cube.share.base.utils.SpringContextUtil.getBean;

/**
 * @author cube.li
 * @date 2021/10/11 20:59
 * @description 基于redisson实现的延时消息管理器
 */
@Component
@Slf4j
public class RedissonDelayMessageManager implements DelayMessageManager {

    private RedissonClient redissonClient = Redisson.create();

    private RBlockingQueue rBlockingQueue = redissonClient.getBlockingDeque("redisson-delay-message-queue");

    private RDelayedQueue rDelayedQueue = redissonClient.getDelayedQueue(rBlockingQueue);

    private final Map handlerMap = new ConcurrentHashMap<>(16);

    @Override
    public void add(DelayMessage message) {
        if (rDelayedQueue.contains(message)) {
            return;
        }
        log.info("redisson-delay-message-queue,add message = {}", message);
        rDelayedQueue.offer(message, message.getProperties().getExpire(), message.getProperties().getTimeUnit());
    }

    @Override
    public boolean remove(DelayMessage message) {
        return rDelayedQueue.remove(message);
    }

    @Override
    public void destroy() {
        rDelayedQueue.destroy();
    }

    @Override
    public void afterPropertiesSet() {
        Arrays.stream(DelayMessageType.values()).forEach(delayMessageType -> handlerMap.put(delayMessageType, getBean(delayMessageType.getHandler())));
        Thread thread = new Thread(() -> {
            while (true) {
                try {
                    DelayMessage delayMessage = rBlockingQueue.take();
                    log.info("redisson-delay-message-queue,consume message = {}", delayMessage);
                    handlerMap.get(delayMessage.getType()).handle(delayMessage);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                    ThreadUtil.safeSleep(1000);
                    afterPropertiesSet();
                }
            }
        });
        thread.setDaemon(true);
        thread.start();
    }
}

代码中,首先创建了一个Redisson实现的阻塞队列RBlockingQueue的实例rBlockingQueue,然后又使用该阻塞队列rBlockingQueue创建了一个延时队列RDelayedQueue的实例rDelayedQueue,按照前文中的描述,延时消息添加后并不是立即进入到阻塞队列rBlockingQueue中,而是到达了设定的延时时间之后才会从延时队列rDelayedQueue进入到阻塞队列rBlockingQueue;因此,延时消息的添加由延时队列rDelayedQueue完成而延时队列的消费则由阻塞队列rBlockingQueue完成,注意,这里如果直接对延时队列rDelayedQueue进行监听,则延时消息刚加入时就会被消费,达不到延时的效果。
相比于Redisson官网文档延时队列中给出的代码示例,这里被包装队列使用阻塞队列RBlockingQueue的好处是rBlockingQueue.take()会一直阻塞直至队列内有可消费延时消息,避免无意义的循环占用CPU。

测试

单元测试代码与上一篇文章基本相同,只是将DelayMessageManager的实现换成了RedissonDelayMessageManager

package com.cube.share.delay.manager;

import com.cube.share.base.utils.JacksonUtils;
import com.cube.share.delay.entity.ExecuteTask;
import com.cube.share.delay.entity.QrCode;
import com.cube.share.delay.message.DelayMessage;
import com.cube.share.delay.message.DelayMessageType;
import com.fasterxml.jackson.core.JsonProcessingException;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import javax.annotation.Resource;
import java.util.concurrent.TimeUnit;

/**
 * @author cube.li
 * @date 2021/9/22 17:12
 * @description 测试
 */
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class DelayMessageManagerTest {

    @Resource(type = RedissonDelayMessageManager.class)
    DelayMessageManager delayMessageManager;

    @Test
    void add() throws JsonProcessingException {
        DelayMessage delayMessage = new DelayMessage();
        QrCode qrCode = new QrCode();
        qrCode.setConfigId("fadfdaf110");
        qrCode.setUrl("http://www.baidu.com");
        delayMessage.setBody(JacksonUtils.toJsonString(qrCode));
        delayMessage.setType(DelayMessageType.DELETE_QR_CODE);
        DelayMessage.DelayMessageProperties properties = new DelayMessage.DelayMessageProperties();
        properties.setExpire(10);
        properties.setTimeUnit(TimeUnit.SECONDS);
        delayMessage.setProperties(properties);
        delayMessageManager.add(delayMessage);


        DelayMessage delayMessage1 = new DelayMessage();
        QrCode qrCode1 = new QrCode();
        qrCode1.setConfigId("fadfdaf1405");
        qrCode1.setUrl("http://www.baidu.com");
        delayMessage1.setBody(JacksonUtils.toJsonString(qrCode1));
        delayMessage1.setType(DelayMessageType.DELETE_QR_CODE);
        DelayMessage.DelayMessageProperties properties1 = new DelayMessage.DelayMessageProperties();
        properties1.setExpire(5);
        properties1.setTimeUnit(TimeUnit.SECONDS);
        delayMessage1.setProperties(properties1);
        delayMessageManager.add(delayMessage1);

        DelayMessage delayMessage2 = new DelayMessage();
        ExecuteTask task = new ExecuteTask();
        task.setId(1L);
        delayMessage2.setBody(JacksonUtils.toJsonString(task));
        delayMessage2.setType(DelayMessageType.EXECUTE_TASK);

        DelayMessage.DelayMessageProperties properties2 = new DelayMessage.DelayMessageProperties();
        properties2.setExpire(9);
        properties2.setTimeUnit(TimeUnit.SECONDS);
        delayMessage2.setProperties(properties2);
        delayMessage2.setSerialId(11235813L);
        delayMessageManager.add(delayMessage2);
        //delayMessageManager.remove(delayMessage2);

    }
}

启动项目,并执行单元测试
向延时队列中加入三条延时分别为5s 9s 10s 的延时消息,单元测试控制台输出如下:

2021-10-12 22:26:40.690  INFO 21340 --- [           main] c.c.s.d.m.RedissonDelayMessageManager    : redisson-delay-message-queue,add message = DelayMessage(body={"url":"http://www.baidu.com","configId":"fadfdaf110"}, type=DELETE_QR_CODE, serialId=null, properties=DelayMessage.DelayMessageProperties(timeUnit=SECONDS, expire=10))
2021-10-12 22:26:40.693  INFO 21340 --- [           main] c.c.s.d.m.RedissonDelayMessageManager    : redisson-delay-message-queue,add message = DelayMessage(body={"url":"http://www.baidu.com","configId":"fadfdaf1405"}, type=DELETE_QR_CODE, serialId=null, properties=DelayMessage.DelayMessageProperties(timeUnit=SECONDS, expire=5))
2021-10-12 22:26:40.698  INFO 21340 --- [           main] c.c.s.d.m.RedissonDelayMessageManager    : redisson-delay-message-queue,add message = DelayMessage(body={"id":1}, type=EXECUTE_TASK, serialId=11235813, properties=DelayMessage.DelayMessageProperties(timeUnit=SECONDS, expire=9))

项目的控制台输出如下:

2021-10-12 22:26:45.719  INFO 10452 --- [      Thread-11] c.c.s.d.m.RedissonDelayMessageManager    : redisson-delay-message-queue,consume message = DelayMessage(body={"url":"http://www.baidu.com","configId":"fadfdaf1405"}, type=DELETE_QR_CODE, serialId=null, properties=DelayMessage.DelayMessageProperties(timeUnit=SECONDS, expire=5))
2021-10-12 22:26:45.719  INFO 10452 --- [      Thread-11] c.c.s.d.h.QrCodeDelayMessageHandler      : 二维码延时消息处理中,message = DelayMessage(body={"url":"http://www.baidu.com","configId":"fadfdaf1405"}, type=DELETE_QR_CODE, serialId=null, properties=DelayMessage.DelayMessageProperties(timeUnit=SECONDS, expire=5))
2021-10-12 22:26:49.719  INFO 10452 --- [      Thread-11] c.c.s.d.m.RedissonDelayMessageManager    : redisson-delay-message-queue,consume message = DelayMessage(body={"id":1}, type=EXECUTE_TASK, serialId=11235813, properties=DelayMessage.DelayMessageProperties(timeUnit=SECONDS, expire=9))
2021-10-12 22:26:49.719  INFO 10452 --- [      Thread-11] c.c.s.d.h.ExecuteTaskDelayMessageHandler : 任务延时消息处理中,message=DelayMessage(body={"id":1}, type=EXECUTE_TASK, serialId=11235813, properties=DelayMessage.DelayMessageProperties(timeUnit=SECONDS, expire=9))
2021-10-12 22:26:50.718  INFO 10452 --- [      Thread-11] c.c.s.d.m.RedissonDelayMessageManager    : redisson-delay-message-queue,consume message = DelayMessage(body={"url":"http://www.baidu.com","configId":"fadfdaf110"}, type=DELETE_QR_CODE, serialId=null, properties=DelayMessage.DelayMessageProperties(timeUnit=SECONDS, expire=10))
2021-10-12 22:26:50.719  INFO 10452 --- [      Thread-11] c.c.s.d.h.QrCodeDelayMessageHandler      : 二维码延时消息处理中,message = DelayMessage(body={"url":"http://www.baidu.com","configId":"fadfdaf110"}, type=DELETE_QR_CODE, serialId=null, properties=DelayMessage.DelayMessageProperties(timeUnit=SECONDS, expire=10))

在经过5s 9s 10s后,对应的消息均成功被消费。

总结

在上一篇基于RabbitMq延时消息插件实现的延时队列之后,本文又提供了一种基于Redisson实现的延时队列,大体上能够满足各种业务场景的需求;希望大家在写业务代码时能够举一反三,不止于代码,不止于业务,才能在程序员的职业生涯里有更进一步的发展。
示例代码

你可能感兴趣的:(延时队列-基于Redisson实现的延时队列)