springboot3 redis 常用操作工具类详解

 更新时间:2025年01月07日 09:23:18   作者:等一场春雨  
本文详细介绍了Spring Boot 3中使用Spring Data Redis进行Redis操作的工具类实现,该工具类涵盖了字符串、哈希、列表、集合和有序集合等常用功能,感兴趣的朋友一起看看吧

在 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;
    }
}

连接池和性能优化

使用 Redis 连接池提高性能,例如配置连接池大小和最大连接数。
避免频繁使用 keys 命令,生产环境建议使用 SCAN。

过期策略

对临时数据设置合理的过期时间,避免占用过多内存。

总结

工具类封装了 Redis 常见操作,方便调用和管理。
根据需求选择适合的 Redis 数据结构(String、Hash、List、Set、ZSet)。

配置合适的序列化方式和连接池,确保性能和数据易读性。

到此这篇关于springboot3 redis 常用操作工具类详解的文章就介绍到这了,更多相关springboot3 redis 工具类内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 使用Java visualVM监控远程JVM的流程分析

    使用Java visualVM监控远程JVM的流程分析

    我们经常需要对我们的开发的软件做各种测试, 软件对系统资源的使用情况更是不可少,JDK1.6开始自带的VisualVM就是不错的监控工具,本文给大家分享使用Java visualVM监控远程JVM的问题,感兴趣的朋友跟随小编一起看看吧
    2021-05-05
  • SpringBoot如何读取配置文件参数并全局使用

    SpringBoot如何读取配置文件参数并全局使用

    这篇文章主要介绍了SpringBoot如何读取配置文件参数并全局使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-12-12
  • Java 自定义注解的魅力

    Java 自定义注解的魅力

    这篇文章主要介绍了Java 自定义注解的相关资料,帮助大家更好的理解和学习使用Java,感兴趣的朋友可以了解下
    2021-03-03
  • java检测redis是否可用的方法示例

    java检测redis是否可用的方法示例

    这篇文章主要给大家介绍了关于java检测redis是否可用的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用java具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-08-08
  • IDEA无法识别SpringBoot项目的简单解决办法

    IDEA无法识别SpringBoot项目的简单解决办法

    今天使用idea的时候,遇到idea无法启动springboot,所以这篇文章主要给大家介绍了关于IDEA无法识别SpringBoot项目的简单解决办法,需要的朋友可以参考下
    2023-08-08
  • 阿里四面之Spring Exception的原理解析

    阿里四面之Spring Exception的原理解析

    本文给大家介绍阿里四面之Spring Exception的原理解析,本文通过错误场景分析给大家详细介绍Spring异常处理流程,感兴趣的朋友一起看看吧
    2021-10-10
  •  java简介及环境搭建

     java简介及环境搭建

    这篇文章主要介绍了java简介及环境搭建,文章主要介绍Java的发展史及环境搭建,对正在学Java的你有一定的参考价值,需要的小伙伴可以参考一下
    2022-03-03
  • Java中Cookie和Session的那些事儿

    Java中Cookie和Session的那些事儿

    Cookie和Session都是为了保持用户的访问状态,一方面为了方便业务实现,另一方面为了简化服务端的程序设计。这篇文章主要介绍了java中cookie和session的知识,需要的朋友可以参考下
    2016-09-09
  • dubbo 如何使用logback来输出日志

    dubbo 如何使用logback来输出日志

    这篇文章主要介绍了dubbo 如何使用logback来输出日志的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • java线程同步操作实例详解

    java线程同步操作实例详解

    这篇文章主要介绍了java线程同步操作,结合实例形式分析了Java线程同步与锁机制相关原理、操作技巧与注意事项,需要的朋友可以参考下
    2018-09-09

最新评论