Spring Boot 監(jiān)聽 Redis Key 失效事件實(shí)現(xiàn)定時(shí)任務(wù)
業(yè)務(wù)場(chǎng)景
我們以訂單功能為例說明下：
生成訂單后一段時(shí)間不支付訂單會(huì)自動(dòng)關(guān)閉。最簡單的想法是設(shè)置定時(shí)任務(wù)輪詢，但是每個(gè)訂單的創(chuàng)建時(shí)間不一樣，定時(shí)任務(wù)的規(guī)則無法設(shè)定，如果將定時(shí)任務(wù)執(zhí)行的間隔設(shè)置的過短，太影響效率。
還有一種想法，在用戶進(jìn)入訂單界面的時(shí)候，判斷時(shí)間執(zhí)行相關(guān)操作。方式可能有很多，在這里介紹一種監(jiān)聽 Redis 鍵值對(duì)過期時(shí)間來實(shí)現(xiàn)訂單自動(dòng)關(guān)閉。
實(shí)現(xiàn)思路
在生成訂單時(shí)，向 Redis 中增加一個(gè) KV 鍵值對(duì)，K 為訂單號(hào)，保證通過 K 能定位到數(shù)據(jù)庫中的某個(gè)訂單即可，V 可為任意值。
假設(shè)，生成訂單時(shí)向 Redis 中存放 K 為訂單號(hào)，V 也為訂單號(hào)的鍵值對(duì)，并設(shè)置過期時(shí)間為 30 分鐘，如果該鍵值對(duì)在 30 分鐘過期后能夠發(fā)送給程序一個(gè)通知，或者執(zhí)行一個(gè)方法，那么即可解決訂單關(guān)閉問題。
實(shí)現(xiàn)：通過監(jiān)聽 Redis 提供的過期隊(duì)列來實(shí)現(xiàn)，監(jiān)聽過期隊(duì)列后，如果 Redis 中某一個(gè) KV 鍵值對(duì)過期了，那么將向監(jiān)聽者發(fā)送消息，監(jiān)聽者可以獲取到該鍵值對(duì)的 K，注意，是獲取不到 V 的，因?yàn)橐呀?jīng)過期了，這就是上面所提到的，為什么要保證能通過 K 來定位到訂單，而 V 為任意值即可。拿到 K 后，通過 K 定位訂單，并判斷其狀態(tài)，如果是未支付，更新為關(guān)閉，或者取消狀態(tài)即可。
開啟 Redis key 過期提醒
修改 redis 相關(guān)事件配置。找到 redis 配置文件 redis.conf，查看 notify-keyspace-events 配置項(xiàng)，如果沒有，添加 notify-keyspace-events Ex，如果有值，則追加 Ex，相關(guān)參數(shù)說明如下：
K：keyspace 事件，事件以 keyspace@ 為前綴進(jìn)行發(fā)布E：keyevent 事件，事件以 keyevent@ 為前綴進(jìn)行發(fā)布g：一般性的，非特定類型的命令，比如del，expire，rename等$：字符串特定命令l：列表特定命令s：集合特定命令h：哈希特定命令z：有序集合特定命令x：過期事件，當(dāng)某個(gè)鍵過期并刪除時(shí)會(huì)產(chǎn)生該事件e：驅(qū)逐事件，當(dāng)某個(gè)鍵因 maxmemore 策略而被刪除時(shí)，產(chǎn)生該事件A：g$lshzxe的別名，因此”AKE”意味著所有事件
引入依賴
在 pom.xml 中添加 org.springframework.boot:spring-boot-starter-data-redis 依賴
<dependency>
????<groupId>org.springframework.bootgroupId>
????<artifactId>spring-boot-starter-data-redisartifactId>
dependency>
相關(guān)配置
定義配置 RedisListenerConfig 實(shí)現(xiàn)監(jiān)聽 Redis key 過期時(shí)間
import?org.springframework.context.annotation.Bean;
import?org.springframework.context.annotation.Configuration;
import?org.springframework.data.redis.connection.RedisConnectionFactory;
import?org.springframework.data.redis.listener.RedisMessageListenerContainer;
@Configuration
public?class?RedisListenerConfig?{
????@Bean
????RedisMessageListenerContainer?container(RedisConnectionFactory?connectionFactory)?{
????????RedisMessageListenerContainer?container?=?new?RedisMessageListenerContainer();
????????container.setConnectionFactory(connectionFactory);
????????return?container;
????}
}
定義監(jiān)聽器 RedisKeyExpirationListener，實(shí)現(xiàn)KeyExpirationEventMessageListener?接口，查看源碼發(fā)現(xiàn)，該接口監(jiān)聽所有 db 的過期事件?keyevent@*:expired"
import?org.springframework.data.redis.connection.Message;
import?org.springframework.data.redis.listener.KeyExpirationEventMessageListener;
import?org.springframework.data.redis.listener.RedisMessageListenerContainer;
import?org.springframework.stereotype.Component;
/**
?*?監(jiān)聽所有db的過期事件__keyevent@*__:expired"
?*/
@Component
public?class?RedisKeyExpirationListener?extends?KeyExpirationEventMessageListener?{
????public?RedisKeyExpirationListener(RedisMessageListenerContainer?listenerContainer)?{
????????super(listenerContainer);
????}
????/**
?????*?針對(duì)?redis?數(shù)據(jù)失效事件，進(jìn)行數(shù)據(jù)處理
?????*?@param?message
?????*?@param?pattern
?????*/
????@Override
????public?void?onMessage(Message?message,?byte[]?pattern)?{
????????//?獲取到失效的?key，進(jìn)行取消訂單業(yè)務(wù)處理
????????String?expiredKey?=?message.toString();
????????System.out.println(expiredKey);
????}
}