使用Spring Boot实现Redis键过期回调功能

news2025/11/4 8:31:58

使用Spring Boot实现Redis键过期回调功能

当使用Redis作为缓存或数据存储的时候，有时候需要在键过期时执行一些特定的操作，比如清除相关数据或发送通知。在Spring Boot中，可以通过实现RedisMessageListener接口来实现Redis键过期回调功能。下面是一个实现Redis键过期回调功能的Spring Boot应用的示例：

在这里插入图片描述

步骤一：引入依赖

首先，在pom.xml文件中引入spring-boot-starter-data-redis依赖：

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

步骤二：配置Redis连接

在application.properties或application.yml文件中配置Redis连接信息，比如Redis的主机、端口号、密码等：

spring:
  redis:
    host: localhost
    port: 6379
    password: 
    database: 0

步骤三：创建Redis过期事件监听器

创建一个类实现RedisMessageListener接口，并实现onMessage方法，该方法会在键过期时被调用：

import org.springframework.data.redis.connection.Message;
import org.springframework.data.redis.connection.MessageListener;
import org.springframework.stereotype.Component;

@Component
public class RedisKeyExpirationListener implements MessageListener {

    @Override
    public void onMessage(Message message, byte[] pattern) {
        String expiredKey = message.toString();
        // 在这里添加你的业务逻辑，比如清除相关数据或发送通知
        System.out.println("键过期：" + expiredKey);
    }
}

步骤四：配置Redis监听器容器

创建一个配置类，配置Redis监听器容器RedisMessageListenerContainer，并将上一步创建的监听器注册到容器中：

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;

@Configuration
public class RedisConfig {

    private final RedisConnectionFactory redisConnectionFactory;

    @Autowired
    public RedisConfig(RedisConnectionFactory redisConnectionFactory) {
        this.redisConnectionFactory = redisConnectionFactory;
    }

    @Bean
    public RedisMessageListenerContainer redisMessageListenerContainer() {
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.setConnectionFactory(redisConnectionFactory);
        container.addMessageListener(redisKeyExpirationListener(), new PatternTopic("__keyevent@*__:expired"));
        return container;
    }

    @Bean
    public RedisKeyExpirationListener redisKeyExpirationListener() {
        return new RedisKeyExpirationListener();
    }
}