SpringBoot集成Redisson實作延遲佇列

使用場景

1、下單成功，30分鐘未支付，支付超時，自動取消訂單

2、訂單簽收，簽收后7天未進行評價，訂單超時未評價，系統默認好評

3、下單成功，商家5分鐘未接單，訂單取消

4、配送超時，推送短信提醒

......

對于延時比較長的場景、實時性不高的場景，我們可以采用任務調度的方式定時輪詢處理，如：xxl-job

今天我們采用一種比較簡單、輕量級的方式，使用 Redis 的延遲佇列來進行處理，當然有更好的解決方案，可根據公司的技術選型和業務體系選擇最優方案，如：使用訊息中間件Kafka、RabbitMQ 的延遲佇列

先不討論其實作原理，直接實戰上代碼先實作基于 Redis 的延遲佇列

1、引入 Redisson 依賴

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

2、Nacos 配置 Redis 連接

spring:
  redis:
    host: 127.0.0.1
    port: 6379
    password: 123456
    database: 12
    timeout: 3000

3、創建 RedissonConfig 配置

/**
 * Created by LPB on 2020/04/20.
 */
@Configuration
public class RedissonConfig {

	@Value("${spring.redis.host}")
	private String host;
	@Value("${spring.redis.port}")
	private int port;
	@Value("${spring.redis.database}")
	private int database;
	@Value("${spring.redis.password}")
	private String password;

	@Bean
	public RedissonClient redissonClient() {
		Config config = new Config();
		config.useSingleServer()
			.setAddress("redis://" + host + ":" + port)
			.setDatabase(database)
			.setPassword(password);
		return Redisson.create(config);
	}

}

4、封裝 Redis 延遲佇列工具類

/**
 * redis延遲佇列工具
 * Created by LPB on 2021/04/20.
 */
@Slf4j
@Component
public class RedisDelayQueueUtil {

    @Autowired
	private RedissonClient redissonClient;

    /**
     * 添加延遲佇列
     * @param value 佇列值
     * @param delay 延遲時間
     * @param timeUnit 時間單位
     * @param queueCode 佇列鍵
     * @param <T>
     */
    public <T> void addDelayQueue(T value, long delay, TimeUnit timeUnit, String queueCode){
        try {
            RBlockingDeque<Object> blockingDeque = redissonClient.getBlockingDeque(queueCode);
            RDelayedQueue<Object> delayedQueue = redissonClient.getDelayedQueue(blockingDeque);
            delayedQueue.offer(value, delay, timeUnit);
			log.info("(添加延時佇列成功) 佇列鍵：{}，佇列值：{}，延遲時間：{}", queueCode, value, timeUnit.toSeconds(delay) + "秒");
        } catch (Exception e) {
            log.error("(添加延時佇列失敗) {}", e.getMessage());
            throw new RuntimeException("(添加延時佇列失敗)");
        }
    }

	/**
	 * 獲取延遲佇列
	 * @param queueCode
	 * @param <T>
	 * @return
	 * @throws InterruptedException
	 */
    public <T> T getDelayQueue(String queueCode) throws InterruptedException {
        RBlockingDeque<Map> blockingDeque = redissonClient.getBlockingDeque(queueCode);
        T value  = (T) blockingDeque.take();
        return value;
	}
}

5、創建延遲佇列業務列舉

/**
 * 延遲佇列業務列舉
 * Created by LPB on 2021/04/20.
 */
@Getter
@NoArgsConstructor
@AllArgsConstructor
public enum RedisDelayQueueEnum {

	ORDER_PAYMENT_TIMEOUT("ORDER_PAYMENT_TIMEOUT","訂單支付超時，自動取消訂單", "orderPaymentTimeout"),
	ORDER_TIMEOUT_NOT_EVALUATED("ORDER_TIMEOUT_NOT_EVALUATED", "訂單超時未評價，系統默認好評", "orderTimeoutNotEvaluated");

	/**
	 * 延遲佇列 Redis Key
	 */
	private String code;

	/**
	 * 中文描述
	 */
	private String name;

	/**
	 * 延遲佇列具體業務實作的 Bean
	 * 可通過 Spring 的背景關系獲取
	 */
	private String beanId;

}

6、定義延遲佇列執行器

/**
 * 延遲佇列執行器
 * Created by LPB on 2021/04/20.
 */
public interface RedisDelayQueueHandle<T> {

	void execute(T t);

}

7、創建列舉中定義的Bean，并實作延遲佇列執行器

• OrderPaymentTimeout：訂單支付超時延遲佇列處理類

/**
 * 訂單支付超時處理類
 * Created by LPB on 2021/04/20.
 */
@Component
@Slf4j
public class OrderPaymentTimeout implements RedisDelayQueueHandle<Map> {
	@Override
	public void execute(Map map) {
		log.info("(收到訂單支付超時延遲訊息) {}", map);
		// TODO 訂單支付超時，自動取消訂單處理業務...

	}
}

• OrderTimeoutNotEvaluated：訂單超時未評價延遲佇列處理類

/**
 * 訂單超時未評價處理類
 * Created by LPB on 2021/04/20.
 */
@Component
@Slf4j
public class OrderTimeoutNotEvaluated implements RedisDelayQueueHandle<Map> {
	@Override
	public void execute(Map map) {
		log.info("(收到訂單超時未評價延遲訊息) {}", map);
		// TODO 訂單超時未評價，系統默認好評處理業務...

	}
}

8、創建延遲佇列消費執行緒，專案啟動完成后開啟

/**
 * 啟動延遲佇列
 * Created by LPB on 2021/04/20.
 */
@Slf4j
@Component
public class RedisDelayQueueRunner implements CommandLineRunner {

	@Autowired
	private RedisDelayQueueUtil redisDelayQueueUtil;

	@Override
	public void run(String... args) {
		new Thread(() -> {
			while (true){
				try {
					RedisDelayQueueEnum[] queueEnums = RedisDelayQueueEnum.values();
					for (RedisDelayQueueEnum queueEnum : queueEnums) {
						Object value = redisDelayQueueUtil.getDelayQueue(queueEnum.getCode());
						if (value != null) {
							RedisDelayQueueHandle redisDelayQueueHandle = SpringUtil.getBean(queueEnum.getBeanId());
							redisDelayQueueHandle.execute(value);
						}
					}
				} catch (InterruptedException e) {
					log.error("(Redis延遲佇列例外中斷) {}", e.getMessage());
				}
			}
		}).start();
		log.info("(Redis延遲佇列啟動成功)");
	}
}

以上步驟，Redis 延遲佇列核心代碼已經完成，下面我們寫一個測驗介面，用 PostMan 模擬測驗一下

9、創建一個測驗介面，模擬添加延遲佇列

/**
 * 延遲佇列測驗
 * Created by LPB on 2020/04/20.
 */
@RestController
public class RedisDelayQueueController {

	@Autowired
	private RedisDelayQueueUtil redisDelayQueueUtil;

	@PostMapping("/addQueue")
	public void addQueue() {
		Map<String, String> map1 = new HashMap<>();
		map1.put("orderId", "100");
		map1.put("remark", "訂單支付超時，自動取消訂單");

		Map<String, String> map2 = new HashMap<>();
		map2.put("orderId", "200");
		map2.put("remark", "訂單超時未評價，系統默認好評");

		// 添加訂單支付超時，自動取消訂單延遲佇列，為了測驗效果，延遲10秒鐘
		redisDelayQueueUtil.addDelayQueue(map1, 10, TimeUnit.SECONDS, RedisDelayQueueEnum.ORDER_PAYMENT_TIMEOUT.getCode());

		// 訂單超時未評價，系統默認好評，為了測驗效果，延遲20秒鐘
		redisDelayQueueUtil.addDelayQueue(map2, 20, TimeUnit.SECONDS, RedisDelayQueueEnum.ORDER_TIMEOUT_NOT_EVALUATED.getCode());
	}

}

10、啟動 SpringBoot 專案，用 PostMan 呼叫介面添加延遲佇列

• 通過 Redis 客戶端可看到兩個延遲佇列已添加成功

• 查看 IDEA 控制臺日志可看到延遲佇列已消費成功