当前位置：首页 > article >正文

springboot3 redis 常用操作工具类

article 2025/1/9 4:14:52

在 Spring Boot 3 中，操作 Redis 通常使用 Spring Data Redis 提供的工具类，如 RedisTemplate 和 StringRedisTemplate。以下是一个详细的 Redis 操作工具类的实现，涵盖了常用功能。

完整的 Redis 工具类

以下工具类可以实现基本的 Redis 操作，例如字符串、哈希、列表、集合和有序集合等。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.*;
import org.springframework.stereotype.Component;

import java.util.*;
import java.util.concurrent.TimeUnit;

@Component
public class RedisUtils {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    /**
     * 设置值
     */
    public void set(String key, Object value, long timeout, TimeUnit timeUnit) {
        redisTemplate.opsForValue().set(key, value, timeout, timeUnit);
    }

    /**
     * 获取值
     */
    public Object get(String key) {
        return redisTemplate.opsForValue().get(key);
    }

    /**
     * 删除键
     */
    public void delete(String key) {
        redisTemplate.delete(key);
    }

    /**
     * 批量删除
     */
    public void deleteKeys(String pattern) {
        Set<String> keys = redisTemplate.keys(pattern);
        if (keys != null && !keys.isEmpty()) {
            redisTemplate.delete(keys);
        }
    }

    /**
     * 设置键的过期时间
     */
    public boolean expire(String key, long timeout, TimeUnit unit) {
        return Boolean.TRUE.equals(redisTemplate.expire(key, timeout, unit));
    }

    /**
     * 获取剩余过期时间
     */
    public long getExpire(String key) {
        return Optional.ofNullable(redisTemplate.getExpire(key)).orElse(0L);
    }

    /**
     * 检查键是否存在
     */
    public boolean hasKey(String key) {
        return Boolean.TRUE.equals(redisTemplate.hasKey(key));
    }

    /**
     * 增加值
     */
    public long increment(String key, long delta) {
        return Optional.ofNullable(redisTemplate.opsForValue().increment(key, delta)).orElse(0L);
    }

    /**
     * 哈希操作：设置值
     */
    public void hSet(String key, String hashKey, Object value) {
        redisTemplate.opsForHash().put(key, hashKey, value);
    }

    /**
     * 哈希操作：获取值
     */
    public Object hGet(String key, String hashKey) {
        return redisTemplate.opsForHash().get(key, hashKey);
    }

    /**
     * 列表操作：左推入
     */
    public void lPush(String key, Object value) {
        redisTemplate.opsForList().leftPush(key, value);
    }

    /**
     * 列表操作：右弹出
     */
    public Object rPop(String key) {
        return redisTemplate.opsForList().rightPop(key);
    }

    /**
     * 集合操作：添加元素
     */
    public void sAdd(String key, Object... values) {
        redisTemplate.opsForSet().add(key, values);
    }

    /**
     * 集合操作：获取所有元素
     */
    public Set<Object> sMembers(String key) {
        return redisTemplate.opsForSet().members(key);
    }

    /**
     * 有序集合操作：添加元素
     */
    public void zAdd(String key, Object value, double score) {
        redisTemplate.opsForZSet().add(key, value, score);
    }

    /**
     * 有序集合操作：获取范围内的元素
     */
    public Set<Object> zRange(String key, long start, long end) {
        return redisTemplate.opsForZSet().range(key, start, end);
    }
}

工具类的使用

设置和获取值

@Autowired
private RedisUtils redisUtils;

public void testSetValue() {
    redisUtils.set("key", "value", 10, TimeUnit.MINUTES);
    Object value = redisUtils.get("key");
    System.out.println("Value: " + value);
}

删除键

redisUtils.delete("key");

哈希操作

redisUtils.hSet("hashKey", "field", "value");
Object value = redisUtils.hGet("hashKey", "field");
System.out.println("Hash Value: " + value);

列表操作

redisUtils.lPush("listKey", "value1");
Object value = redisUtils.rPop("listKey");
System.out.println("List Value: " + value);

集合操作

redisUtils.sAdd("setKey", "value1", "value2");
Set<Object> members = redisUtils.sMembers("setKey");
System.out.println("Set Members: " + members);

有序集合操作

redisUtils.zAdd("zSetKey", "value1", 1.0);
Set<Object> range = redisUtils.zRange("zSetKey", 0, -1);
System.out.println("ZSet Range: " + range);

注意事项

使用合适的序列化方式默认情况下，RedisTemplate 使用的是 JdkSerializationRedisSerializer，这可能导致数据在 Redis 中以二进制形式存储。你可以配置自定义的序列化器，例如 StringRedisSerializer 或 Jackson2JsonRedisSerializer。

示例配置：

@Configuration
public class RedisConfig {

    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(connectionFactory);

        // 设置 Key 和 Value 的序列化器
        template.setKeySerializer(new StringRedisSerializer());
        template.setValueSerializer(new Jackson2JsonRedisSerializer<>(Object.class));

        // 设置 Hash Key 和 Value 的序列化器
        template.setHashKeySerializer(new StringRedisSerializer());
        template.setHashValueSerializer(new Jackson2JsonRedisSerializer<>(Object.class));

        template.afterPropertiesSet();
        return template;
    }
}