redis開啟過期監(jiān)聽的實現(xiàn)示例

更新時間：2025年11月18日 10:05:37 作者：百***2714

在Java項目中使用Redis的過期監(jiān)聽功能來實現(xiàn)訂單未付款到期自動取消,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧

java項目中，場景：訂單沒有付款到期取消訂單，使用的是redis過期監(jiān)聽來做的，做個筆記！首先使用該功能需要下載2.8.0及以上的版本，這一部分詳細內(nèi)容可以訪問redis官網(wǎng)：http://redis.io/topics/notifications ，以下是我總結的：

第一步：配置redis的過期失效監(jiān)聽，需要修改redis.conf配置文件，找到 EVENT NOTIFICATION （事件通知）這個配置
將 notify-keyspace-events "" 修改為 notify-keyspace-events "Ex"

參數(shù)解釋，看配置文件或者官網(wǎng)都有詳細解釋，如下：

############################# EVENT NOTIFICATION ##############################

# 鍵空間通知使得客戶端可以通過訂閱頻道或模式，來接收那些以某種方式改動了 Redis 數(shù)據(jù)集的事件。
# 因為開啟鍵空間通知功能需要消耗一些 CPU ，所以在默認配置下，該功能處于關閉狀態(tài)。
# notify-keyspace-events 的參數(shù)可以是以下字符的任意組合，
# 它指定了服務器該發(fā)送哪些類型的通知：
# K 鍵空間通知，所有通知以 __keyspace@__ 為前綴
# E 鍵事件通知，所有通知以 __keyevent@__ 為前綴
# g DEL 、 EXPIRE 、 RENAME 等類型無關的通用命令的通知
# $ 字符串命令的通知
# l 列表命令的通知
# s 集合命令的通知
# h 哈希命令的通知
# z 有序集合命令的通知
# x 過期事件：每當有過期鍵被刪除時發(fā)送
# e 驅逐(evict)事件：每當有鍵因為 maxmemory 政策而被刪除時發(fā)送
# A 參數(shù) g$lshzxe 的別名
# 輸入的參數(shù)中至少要有一個 K 或者 E，否則的話，不管其余的參數(shù)是什么，都不會有任何 通知被分發(fā)。

第二步：重新啟動redis，沒什么好說的，修改配置文件以及啟動redis不會自行度娘

第三步：驗證配置是否成功

運行redis客戶端：
redis-cli
選擇你要監(jiān)聽的庫 @后面的值，redis默認連接0號庫，這里不做修改了，運行監(jiān)聽命令：
psubscribe __keyevent@0__:expired
在啟動一個客戶端redis-cli，這里也是默認0號庫，不做修改，設置一個10秒過期的key：
SETEX mykey 10 redis
拓展：Redis Setex 命令為指定的 key 設置值及其過期時間。如果 key 已經(jīng)存在， SETEX 命令將會替換舊的值。
10秒后，可以看到監(jiān)聽端口可以接收到失效的redis的key。如圖

springboot 項目集成ridis配置過期監(jiān)聽：

1.引入redis依賴，這塊不做過多解釋，不會的去搜集成reids

        <!--Spring boot Redis-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

2.創(chuàng)建兩個類，第一個類配置 RedisListenerConfig 實現(xiàn)監(jiān)聽 Redis key 過期時間,我這里是監(jiān)聽所有db的過期事件__keyevent@*__:expired，根據(jù)自己的業(yè)務需求自行配置，@幾號庫，@*是所有
RedisListenerConfig：

import org.springframework.beans.factory.annotation.Autowired;
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.PatternTopic;
import org.springframework.data.redis.listener.RedisMessageListenerContainer;

/**
 * @ClassName RedisListenerConfig
 * @Description redis監(jiān)聽配置
 * @Author cl
 * @Date 2021-09-09 10:45
 */
@Configuration
public class RedisListenerConfig {
    @Autowired
    RedisListen redisListen;

    @Bean
    RedisMessageListenerContainer container(RedisConnectionFactory factory) {
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.setConnectionFactory(factory);
        container.addMessageListener(redisListen, new PatternTopic("__keyevent@*__:expired"));
        return container;
    }
}

第二個類，定義監(jiān)聽器 RedisListen，監(jiān)聽 Redis key 過期事件,針對 Redis 數(shù)據(jù)失效事件，進行業(yè)務處理
RedisListen：

import com.tanghe.common.constant.RedisConstants;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.connection.Message;
import org.springframework.data.redis.connection.MessageListener;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.stereotype.Component;

/**
 * @ClassName RedisListen
 * @Description RedisListen
 * @Author cl
 * @Date 2021-09-09 10:46
 */
@Slf4j
@Component
public class RedisListen implements MessageListener {
    @Autowired
    private RedisTemplate<String, String> redisTemplate;

    @Override
    public void onMessage(Message message, byte[] pattern) {
        String expiredKey = message.toString();

        log.info("失效的redis是:"+expiredKey);
        RedisSerializer<?> serializer = redisTemplate.getValueSerializer();
        String channel = String.valueOf(serializer.deserialize(message.getChannel()));
        String body = String.valueOf(serializer.deserialize(message.getBody()));
        log.info("channel==="+channel+"-----------------"+"body === "+body);
        //key過期監(jiān)聽,在處理業(yè)務之前校驗下自己業(yè)務的key和監(jiān)聽的key以及庫號
        if("__keyevent@0__:expired".equals(channel) && body.indexOf(“自己業(yè)務的key”) != -1){
            log.info("進來了哈");
            //這里寫需要處理的業(yè)務

        }

    }
}