Redisson 延时队列实现（Java）

一、依赖

1.1 pom

<dependency>
    <groupId>org.redisson</groupId>
    <artifactId>redisson-spring-boot-starter</artifactId>
    <version>3.21.1</version>
</dependency>

1.2 yml

spring:
  # Redis 相关配置
  redis:
    host: 127.0.0.1 # Redis 服务器主机。
    port: 13678 # Redis 服务器端口。（默认：6379）
    database: 0 # 连接工厂使用的数据库索引。（默认：0）
    password: 123456
    
# redission 配置
redisson:
  singleServerConfig:
    address: "redis://${spring.redis.host}:${spring.redis.port}"
    password: "${spring.redis.password}"
    database: "${spring.redis.database}"

二、RedissonConfig 配置类

import org.redisson.Redisson;
import org.redisson.api.RedissonClient;
import org.redisson.config.Config;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Author cb
 * @CreateTime 2023/6/12 22:07 星期一
 */
@Configuration
public class RedissonConfig {

    /**
     * 延时队列名称
     */
    public static final String DELAY_NAME = "warning-record";

    @Value("${redisson.singleServerConfig.address}")
    private String address;
    @Value("${redisson.singleServerConfig.password}")
    private String password;
    @Value("${redisson.singleServerConfig.database}")
    private int database;

    @Bean(destroyMethod = "shutdown")
    public RedissonClient redissonClient() {
        Config config = new Config();
        config.useSingleServer().setAddress(address).setDatabase(database).setPassword(password);
        return Redisson.create(config);
    }

}

三、RedisDelayQueueUtil 工具类

import com.ccbx.rmbmanage.common.exception.BusinessException;
import com.ccbx.rmbmanage.config.RedissonConfig;
import lombok.extern.slf4j.Slf4j;
import org.redisson.api.RBlockingDeque;
import org.redisson.api.RDelayedQueue;
import org.redisson.api.RedissonClient;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;

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

/**
 * @Author cb
 * @CreateTime 2023/6/12 22:18 星期一
 */
@Slf4j
@Component
public class RedisDelayQueueUtil {

    /**
     * 延时队列名称
     */
    public static final String DELAY_NAME = "warning-record";

    @Resource
    private RedissonConfig redissonConfig;

    /**
     * 添加消息进入延迟队列
     *
     * @param value     消息值
     * @param delay     延迟时间
     * @param timeUnit  时间单位
     * @param queueCode 队列键
     * @param <T>       值类型
     */
    public <T> void addDelayQueue(T value, long delay, TimeUnit timeUnit, String queueCode) {
        if (!StringUtils.hasText(queueCode)) {
            queueCode = DELAY_NAME;
        }
        try {
            RedissonClient redissonClient = redissonConfig.redissonClient();
            RBlockingDeque<Object> blockingDeque = redissonClient.getBlockingDeque(queueCode);
            RDelayedQueue<Object> delayedQueue = redissonClient.getDelayedQueue(blockingDeque);
            // TODO cb 删除之前进来的id值 (判断之前是否已存在值)
            // delayedQueue.remove(value);
            delayedQueue.offer(value, delay, timeUnit);
            log.info("(添加延时队列成功) 队列键：{}，队列值：{}，延迟时间：{}", queueCode, value, timeUnit.toSeconds(delay) + "秒");
        } catch (Exception e) {
            log.error("(添加延时队列失败) {}", e.getMessage());
            throw new BusinessException("(添加延时队列失败)");
        }
    }

    /**
     * 获取延迟队列消息
     *
     * @param queueCode 队列键
     * @param <T>       队列中获取的值类型
     * @return 队列中返回的值
     * @throws InterruptedException
     */
    public <T> T getDelayQueue(String queueCode) throws InterruptedException {
        if (!StringUtils.hasText(queueCode)) {
            queueCode = DELAY_NAME;
        }
        RBlockingDeque<Map> blockingDeque = redissonConfig.redissonClient().getBlockingDeque(queueCode);
        return (T) blockingDeque.take();
    }

    /**
     * 删除延迟队列中的元素
     *
     * @param queueCode 队列名
     * @param <T>       删除元素值
     * @return 删除的元素
     */
    public <T> T removeDelayQueue(T value, String queueCode) {
        if (!StringUtils.hasText(queueCode)) {
            queueCode = DELAY_NAME;
        }
        RBlockingDeque<Object> blockingDeque = redissonConfig.redissonClient().getBlockingDeque(queueCode);
        RDelayedQueue<Object> delayedQueue = redissonConfig.redissonClient().getDelayedQueue(blockingDeque);
        delayedQueue.remove(value);
        return value;
    }

    /**
     * 项目重启时操作延时队列，消费因服务停止造成的阻塞的消息
     */
    @PostConstruct
    public void reScheduleDelayedTasks() {
        removeDelayQueue(null, null);
    }

}

四、RedisDelayQueueRunner 消费者

import com.ccbx.rmbmanage.domain.redisson.BicycleState;
import com.ccbx.rmbmanage.utils.RedisDelayQueueUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;

/**
 * 启动延迟队列消费
 *
 * @Author cb
 * @CreateTime 2023/6/12 22:30 星期一
 */
@Slf4j
@Component
public class RedisDelayQueueRunner implements CommandLineRunner {

    @Resource
    private RedisDelayQueueUtil redisDelayQueueUtil;

    @Override
    public void run(String... args) throws Exception {
        new Thread(() -> {
            try {
                while (true) {
                    BicycleState value = redisDelayQueueUtil.getDelayQueue(RedisDelayQueueUtil.DELAY_NAME);
                    // 消费
                    consumerMessage(value);
                }
            }catch (InterruptedException e) {
                log.error("Redis 延迟队列消费监听器异常中断，{}", e.getMessage());
            }
        }).start();
        log.info("Redis 延迟队列消费监听器启动成功");
    }

    private void consumerMessage(BicycleState bicycleState) {
        log.warn("收到延迟消息进行处理，消息内容：{}", bicycleState);
    }

}

五、消息生产者

package com.ccbx.rmbmanage.controller.redisson;

import cn.hutool.core.lang.UUID;
import com.ccbx.rmbmanage.common.ApiResp;
import com.ccbx.rmbmanage.domain.redisson.BicycleState;
import com.ccbx.rmbmanage.utils.RedisDelayQueueUtil;
import org.springframework.web.bind.annotation.*;

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

/**
 * @Author cb
 * @CreateTime 2023/6/12 22:59 星期一
 */
@RestController
@RequestMapping("redisson")
public class RedissonController {

    @Resource
    private RedisDelayQueueUtil redisDelayQueueUtil;

    @PostMapping("create")
    public ApiResp<List<BicycleState>> createDelayMsg() {
        List<BicycleState> rltList = new ArrayList<>(5);
        for (int i = 0; i < 5; i++) {
            BicycleState bicycleState = new BicycleState();
            bicycleState.setBicycleSerialNumber(UUID.randomUUID().toString(true));
            bicycleState.setTerminalSerialNumber(UUID.randomUUID().toString(true));
            bicycleState.setState(i%2 == 0);

            redisDelayQueueUtil.addDelayQueue(bicycleState, 1, TimeUnit.MINUTES, null);
            rltList.add(bicycleState);
        }
        return ApiResp.success(rltList);
    }

}