一种优雅的redis延迟队列实现

矫情吗；* 2023-10-04 22:08 43阅读 0赞

![format_png][]

### 前言 ###

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

工作中常常会遇到这样的场景，如订单到期未支付取消，到期自动续费等，我们发现延迟队列非常适合在这样的场景中使用。常见的延迟队列的优秀实现有rabbitMQ的死信队列，RocketMQ的延迟队列等，但是了有时候项目没有特别的大，没有引入类似的消息中间件，但是了又遇到了特别适合使用延迟队列的场景，我们一般会利用已有的redis实现一个简陋的延迟队列。常见的实现方式有监听过期key，使用zset利用分值进行一个匹配，但是了这些实现或多或少有些问题，不够优雅。监听过期key是一种危险行为，一是如果过redis中key数量较大监听过期key可能导致服务负载异常，二是redis中key过期后key是惰性删除的，因此监听机制需要主动触发。利用zset分值实现呢，需要自己开发代码处理定时轮训以及key删除的逻辑，具有一定的工作量和复杂度。哪有没有一种优雅的redis延迟队列的实现呢？

Redisson是Redis服务器上的分布式可伸缩Java数据结构----驻内存数据网格(In-Memory Data Grid，IMDG)。底层使用netty框架，并提供了与java对象相对应的分布式对象、分布式集合、分布式锁和同步器、分布式服务等一系列的Redisson的分布式对象。为我们提供了许多开箱即用的功能。今天介绍Redisson实现的优雅的延迟队列。

### 使用 ###

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

#### 依赖配置 ####

<?xml version="1.0" encoding="UTF-8"?><projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.3.12.RELEASE</version><relativePath/></parent><groupId>com.homeey</groupId><artifactId>redis-delay-queue</artifactId><version>0.0.1-SNAPSHOT</version><name>redis-delay-queue</name><description>redis-delay-queue</description><properties><java.version>1.8</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.redisson</groupId><artifactId>redisson-spring-boot-starter</artifactId><version>3.19.3</version></dependency><dependency><groupId>org.redisson</groupId><artifactId>redisson-spring-data-23</artifactId><version>3.19.3</version></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><configuration><excludes><exclude><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></exclude></excludes></configuration></plugin></plugins></build></project>复制代码

备注：[处理redisson和springboot兼容性问题][redisson_springboot]

#### 配置文件 ####

springboot整合redisson有三种方式

*  第一种：通用的redis配置+redisson的自动配置\[最简单\]

*  第二种：使用单独的redisson配置文件

*  第三种：使用spring.redis.redisson这个配置key下进行配置

详细的整合查看 [springboot整合redisson配置][redisson_springboot]

spring:redis:database:0host:localhostport:6379timeout:10000lettuce:pool:max-active:8max-wait:-1min-idle:0max-idle:8复制代码

#### demo代码 ####

package com.homeey.redisdelayqueue.delay;
    
    import lombok.RequiredArgsConstructor;
    import lombok.extern.slf4j.Slf4j;
    import org.redisson.api.RBlockingQueue;
    import org.redisson.api.RDelayedQueue;
    import org.redisson.api.RedissonClient;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.stereotype.Component;
    
    import javax.annotation.PostConstruct;
    import java.util.concurrent.ExecutorService;
    import java.util.concurrent.Executors;
    import java.util.concurrent.TimeUnit;
    
    /**
     * 明天的你会因今天到的努力而幸运
     *
     * @author jt4mrg@qq.com
     * 23:11 2023-02-19 2023
     **/@Slf4j@Component@RequiredArgsConstructorpublicclassRedissonDelayQueue {
    
        privatefinal RDelayedQueue<String> delayedQueue;
        privatefinal RBlockingQueue<String> blockingQueue;
    
    
        @PostConstructpublicvoidinit() {
            ExecutorServiceexecutorService= Executors.newFixedThreadPool(1);
            executorService.submit(() -> {
                while (true) {
                    try {
                        Stringtask= blockingQueue.take();
                        log.info("rev delay task:{}", task);
                    } catch (Exception e) {
                        log.error("occur error", e);
                    }
                }
            });
        }
    
        publicvoidofferTask(String task, long seconds) {
            log.info("add delay task:{},delay time:{}s", task, seconds);
            delayedQueue.offer(task, seconds, TimeUnit.SECONDS);
        }
    
    
        @ConfigurationstaticclassRedissonDelayQueueConfigure {
    
            @Beanpublic RBlockingQueue<String> blockingQueue(RedissonClient redissonClient) {
                return redissonClient.getBlockingQueue("TOKEN-RENEWAL");
            }
    
            @Beanpublic RDelayedQueue<String> delayedQueue(RBlockingQueue<String> blockingQueue,
                                                      RedissonClient redissonClient) {
                return redissonClient.getDelayedQueue(blockingQueue);
            }
        }
    }
    复制代码

#### 执行效果 ####

![format_png 1][]

### 原理分析 ###

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

从RedissonDelayedQueue实现中我们看到有四个角色

![format_png 2][]

*  **redisson\_delay\_queue\_timeout:xxx**，sorted set数据类型，存放所有延迟任务，按照延迟任务的到期时间戳（提交任务时的时间戳 + 延迟时间）来排序的，所以列表的最前面的第一个元素就是整个延迟队列中最早要被执行的任务，这个概念很重要

*  **redisson\_delay\_queue:xxx**，list数据类型，暂时没发现什么用，只是在提交任务时会写入这里面，队列转移时又会删除里面的元素

*  **xxx**：list数据类型，被称为目标队列，这个里面存放的任务都是已经到了延迟时间的，可以被消费者获取的任务，所以上面demo中的RBlockingQueue的take方法是从这个目标队列中获取到任务的

*  **redisson\_delay\_queue\_channel:xxx**，是一个channel，用来通知客户端开启一个延迟任务

#### 队列创建 ####

RedissonDelayedQueue延迟队列创建时，指定了队列转移服务，以及实现延迟队列的四个重要校色的key。核心代码是指定队列转移任务

QueueTransferTask task = newQueueTransferTask(commandExecutor.getConnectionManager()) {
                
                @OverrideprotectedRFuture<Long> pushTaskAsync() {
                    return commandExecutor.evalWriteAsync(getRawName(), LongCodec.INSTANCE, RedisCommands.EVAL_LONG,
                            "local expiredValues = redis.call('zrangebyscore', KEYS[2], 0, ARGV[1], 'limit', 0, ARGV[2]); "//拿到zset中过期的值列表
                          + "if #expiredValues > 0 then "//如果有
                              + "for i, v in ipairs(expiredValues) do "
                                  + "local randomId, value = struct.unpack('dLc0', v);"//解构消息，在提交任务时打包的消息
                                  + "redis.call('rpush', KEYS[1], value);"//放入无前缀的list 队头
                                  + "redis.call('lrem', KEYS[3], 1, v);"//移除带前缀list 队尾元素
                              + "end; "
                              + "redis.call('zrem', KEYS[2], unpack(expiredValues));"//移除zset中本次读取的过期元素
                          + "end; "// get startTime from scheduler queue head task
                          + "local v = redis.call('zrange', KEYS[2], 0, 0, 'WITHSCORES'); "//取zset最小分值的元素
                          + "if v[1] ~= nil then "
                             + "return v[2]; "//返回分值，即过期时间
                          + "end "
                          + "return nil;",
                          Arrays.asList(getRawName(), timeoutSetName, queueName),
                          System.currentTimeMillis(), 100);
                }
                
                @OverrideprotectedRTopicgetTopic() {
                    returnRedissonTopic.createRaw(LongCodec.INSTANCE, commandExecutor, channelName);
                }
            };
    复制代码

#### 生产者 ####

![format_png 3][]

核心代码RedissonDelayedQueue\#offerAsync

return commandExecutor.evalWriteNoRetryAsync(getRawName(), codec, RedisCommands.EVAL_VOID,
                    "local value = struct.pack('dLc0', tonumber(ARGV[2]), string.len(ARGV[3]), ARGV[3]);" //打包消息体：消息id，消息长度，消息值
                  + "redis.call('zadd', KEYS[2], ARGV[1], value);"//zset中加入消息及其超时分值
                  + "redis.call('rpush', KEYS[3], value);" //向带前缀的list中添加消息// if new object added to queue head when publish its startTime // to all scheduler workers 
                  + "local v = redis.call('zrange', KEYS[2], 0, 0); "//取出zset中第一个元素
                  + "if v[1] == value then " //如果最快过期的元素就是这次发送的消息
                     + "redis.call('publish', KEYS[4], ARGV[1]); " //channel中发布一下超时时间
                  + "end;",
                  Arrays.asList(getRawName(), timeoutSetName, queueName, channelName),
                  timeout, randomId, encode(e));
    复制代码

#### 消费者 ####

消费者最简单，直接从不带前缀的list中BLPOP读取就可以

#### 整个流程 ####

![format_png 4][]

### 总结思考 ###

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

Lua是redis的好朋友，我们可以看到Redisson实现延迟队列时，大量使用到lua脚本，因Redis会将整个脚本作为一个整体执行，中间不会被其他请求插入。因此在脚本运行过程中无需担心会出现竞态条件，无需使用事务。我们在平时开发时有多个redis命令操作的有简单的业务逻辑，不妨尝试一下lua脚本的方式，可以避免使用分布式锁来保障一致性。

Redisson的源码值得一读，有很多新东西值得学习，如果其用到的netty基于时间轮算法的定时任务调度，可以让我们基于此实现自己的任务调度框架，也让我有了去探究这种实现方式和基于ScheduledThreadPoolExecutor的定时调度的差异及各自优劣的欲望。

知道的越多，不知道的就越多。因为不知道所以想要去探究，我太喜欢这样的感觉，每天都要给自己充充电，学习是永无止境的，这种快乐也是永无止境的，共勉！！！

[format_png]: https://img-blog.csdnimg.cn/img_convert/b618cb2d235d887455269cd74d657711.webp?x-oss-process=image/format,png
[redisson_springboot]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2Fredisson%2Fredisson%2Ftree%2Fmaster%2Fredisson-spring-boot-starter
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/71b1c311102796a4a15f3940483b46d2.webp?x-oss-process=image/format,png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/9c6e9c279eff526599a87b1044c47863.webp?x-oss-process=image/format,png
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/6e412d515e3af5bcb423f9009b3bb478.webp?x-oss-process=image/format,png
[format_png 4]: https://img-blog.csdnimg.cn/img_convert/d42ccbdd87a352d5ec579a2c4f2d1dbd.webp?x-oss-process=image/format,png