AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

redis入门到精通系列（十）：springboot快速集成redis

2022-04-24 1006
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
云数据库 Tair（兼容Redis），内存型 2GB
推荐场景：
通过缓存加速数据库访问
Redis 开源版，标准版 2GB
推荐场景：
搭建游戏排行榜
简介： 在前面的博客系列中，我们把redis的基础语法配置等比较详细的讲了一遍，但如果要用现在更多的是集成到spring系列的框架之中，今天我们就来讲解springboot集成redis的方法以及一些注意点。

点赞再看，养成习惯，听说微信搜《Java鱼仔》会让自己的技术更上一层楼


（一） 概述


在前面的博客系列中，我们把redis的基础语法配置等比较详细的讲了一遍，但如果要用现在更多的是集成到spring系列的框架之中，今天我们就来讲解springboot集成redis的方法以及一些注意点。


（二） 项目依赖


springboot对于redis的集成十分友好，我们创建springboot项目时可以直接勾选SpringDataRedis即可直接引入redis的相关依赖。


网络异常，图片无法展示
|
Spring Data Redis的依赖如下： 

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

按住Ctrl左键点击spring-boot-starter-data-redis可以看到redis中所引用的依赖，我们可以看到客户端从以前的jedis变成了lettuce


网络异常，图片无法展示
|


Lettuce 和 Jedis 都是Redis的client，所以他们都可以连接 Redis Server。 Jedis在实现上是直接连接的Redis Server，如果在多线程环境下是非线程安全的。每个线程都去拿自己的 Jedis 实例，当连接数量增多时，资源消耗阶梯式增大，连接成本就较高了。 Lettuce的连接是基于Netty的，Netty 是一个多线程、事件驱动的 I/O 框架。连接实例可以在多个线程间共享，当多线程使用同一连接实例时，是线程安全的。 所以在后续的使用中，我们将使用lettuce代替掉jedis。


（三）配置文件配置


关于配置文件是如何配置的，许多人的方法就是直接去百度查询redis集成到springboot配置文件如何写，这种方式虽然能解决问题，但是还有更好的办法就是查源码。我们点开项目目录下的External Libraries,找到spring-boot-autoconfigure，


网络异常，图片无法展示
|


然后在这个自动配置的配置文件中去寻找redis相关的配置


网络异常，图片无法展示
|


看到第一个就是我们要找的配置文件，源码如下：


网络异常，图片无法展示
|


我们关注两个点，第一个是配置文件的属性，也就是第一个红框框出来的位置，另一个就是@ConditionalOnMissingBean注解，这个注解的意思是如果我们自己写了一个名字为redisTemplate的Bean，源码中的这个Bean就不会生效，我的秒杀项目实战中就自己写了redisTemplate这样一个Bean。


下面点开第一个红框中的RedisProperties,这是我们配置文件所要参考的类:


网络异常，图片无法展示
|


所有的配置文件都在这里了，我们可以看到host和port都给了默认的值，这也意味着如果只是在本地跑的话，你在springboot的application.properties中甚至不需要配置。

作为教程系列的博客，我还是会配上：


#配置redis
spring.redis.host=127.0.0.1
spring.redis.port=6379

（四）在springboot中使用redis


在springboot使用redis和直接操作redis的语法十分类似，首先我们需要引入RedisTemplate，通过源码我们也看到了，我们可以直接使用RedisTemplate，也可以自己写一个Bean自己配置，系统自带的RedisTemplate只设置了一个连接工厂，而没有设置序列化等其他参数，因此如果在正式项目中我们都会自己定义这样一个redisTemplate。

直接在test包下进行测试


@SpringBootTestclassRedisSpringbootApplicationTests {
@AutowiredprivateRedisTemplateredisTemplate;
@TestvoidcontextLoads() {
//相当于redis中的string类型redisTemplate.opsForValue().set("k1","v1");
System.out.println(redisTemplate.opsForValue().get("k1"));
    }
}

在redis中的操作都可以通过opsForXXX来实现，比如redis中的String可以通过opsForValue()实现，redis的五种数据结构分别对应于redisTemplate的以下五种方法：

redisTemplate.opsForValue();
redisTemplate.opsForHash();
redisTemplate.opsForList();
redisTemplate.opsForSet();
redisTemplate.opsForZSet();

(五)编写一个redis的通用配置类


通过进入RedisTemplate的源码我们可以看到，redis所有的序列化都采用了Jdk的序列化方式


网络异常，图片无法展示
|


这种方式的问题在于我们传输到redis中的数据会出现乱码，比如以上面的例子为例，我们设置一个key为“k1”，value为"v1"的数据，看一下redis的控制台：


网络异常，图片无法展示
|


为了解决这个问题我们需要自己去定义序列化方式，一般来说我们会给key定义为String的序列化方式，value定义为json的序列化方式。下面的这个工具类属于通用的工具类，可以在项目中直接使用


@ConfigurationpublicclassRedisConfig {
//自定义的redistemplate@Bean(name="redisTemplate")
publicRedisTemplate<String,Object>redisTemplate(RedisConnectionFactoryfactory){
//创建一个RedisTemplate对象，为了方便返回key为string，value为ObjectRedisTemplate<String,Object>template=newRedisTemplate<>();
template.setConnectionFactory(factory);
//设置json序列化配置Jackson2JsonRedisSerializerjackson2JsonRedisSerializer=newJackson2JsonRedisSerializer(Object.class);
ObjectMapperobjectMapper=newObjectMapper();
objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
objectMapper.activateDefaultTyping(LaissezFaireSubTypeValidator.instance);
//string的序列化StringRedisSerializerstringRedisSerializer=newStringRedisSerializer();
//key采用string的序列化方式template.setKeySerializer(stringRedisSerializer);
//value采用jackson的序列化方式template.setValueSerializer(jackson2JsonRedisSerializer);
//hashkey采用string的序列化方式template.setHashKeySerializer(stringRedisSerializer);
//hashvalue采用jackson的序列化方式template.setHashValueSerializer(jackson2JsonRedisSerializer);
template.afterPropertiesSet();
returntemplate;
    }
}

配置完成后再使用redisTemplate时就会使用我们自定义的这个redistemplate，数据传输也不会再乱码。


(六) 编写一个redis的通用工具类


我在接下来的代码中封装了redis的一个通用工具类，之后在使用redis时可以直接采用RedisUtil工具类操控，让代码更加的精炼。

@ComponentpublicclassRedisUtil {
@AutowiredprivateRedisTemplate<String,Object>redisTemplate;
/*** 指定缓存失效时间*/publicbooleanexpire(Stringkey,longtime){
try {
if (time>0){
redisTemplate.expire(key,time, TimeUnit.SECONDS);
            }
returntrue;
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/*** 根据key获取过期时间*/publiclonggetExpire(Stringkey){
returnredisTemplate.getExpire(key,TimeUnit.SECONDS);
    }
/***判断key是否存在*/publicbooleanhasKey(Stringkey){
try {
returnredisTemplate.hasKey(key);
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/***删除缓存*/publicvoiddel(String... key){
if (key!=null&&key.length>0){
if (key.length==1){
redisTemplate.delete(key[0]);
            }else {
redisTemplate.delete(CollectionUtils.arrayToList(key));
            }
        }
    }
/*** 根据key获取value*/publicObjectget(Stringkey){
returnkey==null?null :redisTemplate.opsForValue().get(key);
    }
/*** set方法*/publicbooleanset(Stringkey,Objectvalue){
try {
redisTemplate.opsForValue().set(key,value);
returntrue;
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/*** set 方法带时间*/publicbooleanset(Stringkey,Objectvalue,longtime){
try {
if (time>0){
redisTemplate.opsForValue().set(key,value,time,TimeUnit.SECONDS);
            }else {
set(key,value);
            }
returntrue;
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/*** 增加*/publiclongincr(Stringkey,longdelta){
if (delta<0){
thrownewRuntimeException("递增数必须大于0");
        }
returnredisTemplate.opsForValue().increment(key,delta);
    }
/*** 减少*/publiclongdecr(Stringkey,longdelta){
if (delta<0){
thrownewRuntimeException("递增数必须大于0");
        }
returnredisTemplate.opsForValue().increment(key,-delta);
    }
// =======================hash===============================/*** hash set*/publicbooleanhSet(Stringkey,Stringitem,Stringvalue){
try {
redisTemplate.opsForHash().put(key,item,value);
returntrue;
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/*** hash set 并设置时间*/publicbooleanhSet(Stringkey,Stringitem,Stringvalue,longtime){
try {
redisTemplate.opsForHash().put(key,item,value);
if (time>0){
expire(key,time);
            }
returntrue;
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/*** hash mset*/publicbooleanhmset(Stringkey,Map<String,Object>map){
try {
redisTemplate.opsForHash().putAll(key,map);
returntrue;
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/*** Hash mSet并设置时间*/publicbooleanhmset(Stringkey,Map<String,Object>map, longtime){
try {
redisTemplate.opsForHash().putAll(key,map);
if (time>0){
expire(key,time);
            }
returntrue;
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/*** Hash get*/publicObjecthGet(Stringkey,Stringitem){
returnredisTemplate.opsForHash().get(key,item);
    }
/*** 获取hashKey的所有键值*/publicMap<Object,Object>hmget(Stringkey){
returnredisTemplate.opsForHash().entries(key);
    }
/*** 删除hash表的数据*/publicvoidhDel(Stringkey,Object... item){
redisTemplate.opsForHash().delete(key,item);
    }
/*** 判断hash表中是否存在数据*/publicbooleanhHasKey(Stringkey,Stringitem){
returnredisTemplate.opsForHash().hasKey(key,item);
    }
/*** hash递增，如果不存在就会创建一个，返回递增后的值*/publicdoublehIncr(Stringkey,Stringitem,doubleby){
returnredisTemplate.opsForHash().increment(key,item,by);
    }
/*** hash递减*/publicdoublehDecr(Stringkey,Stringitem,doubleby){
returnredisTemplate.opsForHash().increment(key,item,-by);
    }
//===========================set=======================/*** 根据key获取Set中的所有值*/publicSet<Object>sGet(Stringkey){
try {
returnredisTemplate.opsForSet().members(key);
        }catch (Exceptione){
e.printStackTrace();
returnnull;
        }
    }
/*** 根据value从一个set中查值*/publicbooleansHasKey(Stringkey,Objectobject){
try{
returnredisTemplate.opsForSet().isMember(key,object);
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/*** 将数据放入set*/publiclongsSet(Stringkey ,Object... values){
try {
returnredisTemplate.opsForSet().add(key,values);
        }catch (Exceptione){
e.printStackTrace();
return0;
        }
    }
/*** 将数据放入set并设置时间*/publiclongsSet(Stringkey ,longtime ,Object... values){
try {
longcount=redisTemplate.opsForSet().add(key,values);
if (time>0){
expire(key,time);
            }
returncount;
        }catch (Exceptione){
e.printStackTrace();
return0;
        }
    }
/*** 获取set的长度*/publiclongsGetSetSize(Stringkey){
try {
returnredisTemplate.opsForSet().size(key);
        }catch (Exceptione){
e.printStackTrace();
return0;
        }
    }
/*** 移除值为value的*/publiclongsRemove(Stringkey,Object... values){
try {
Longcount=redisTemplate.opsForSet().remove(key,values);
returncount;
        }catch (Exceptione){
e.printStackTrace();
return0;
        }
    }
//==============================List==============================/*** 获取list的长度*/publiclonglGetListSize(Stringkey){
try{
returnredisTemplate.opsForList().size(key);
        }catch (Exceptione){
e.printStackTrace();
return0;
        }
    }
/*** 通过索引获取List中的值*/publicObjectlGetIndex(Stringkey,longindex){
try{
returnredisTemplate.opsForList().index(key,index);
        }catch (Exceptione){
e.printStackTrace();
returnnull;
        }
    }
/*** 存放数据到list*/publicbooleanlSet(Stringkey,Objectvalue){
try{
redisTemplate.opsForList().rightPush(key,value);
returntrue;
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/*** 存放数据到list,并设置时间*/publicbooleanlSet(Stringkey,Objectvalue,longtime){
try{
redisTemplate.opsForList().rightPush(key,value);
if (time>0){
expire(key,time);
            }
returntrue;
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/*** 将list集合放入缓存*/publicbooleanlSet(Stringkey,Object... values){
try{
redisTemplate.opsForList().rightPushAll(key,values);
returntrue;
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/*** 将list集合放入缓存,并设置时间*/publicbooleanlSet(Stringkey,longtime,Object... values){
try{
redisTemplate.opsForList().rightPushAll(key,values);
if (time>0){
expire(key,time);
            }
returntrue;
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/*** 根据索引修改list中的某条数据*/publicbooleanlUpdateIndex(Stringkey,longindex,Objectvalue){
try{
redisTemplate.opsForList().set(key,index,value);
returntrue;
        }catch (Exceptione){
e.printStackTrace();
returnfalse;
        }
    }
/*** 移除n个值为value*/publiclonglRemove(Stringkey,longcount,Objectvalue){
try{
longremove=redisTemplate.opsForList().remove(key,count,value);
returnremove;
        }catch (Exceptione){
e.printStackTrace();
return0;
        }
    }
}


文章标签：
云数据库 Tair（兼容 Redis）
Java
NoSQL
Redis
Spring
安全
数据格式
JSON
关键词：
云数据库 Tair（兼容 Redis）Springboot
集成入门
springboot云数据库 Tair（兼容 Redis）
集成redis
集成springboot
1658538813089932
目录
相关文章
Quan_Chen
|
6月前
|
安全 Java Apache
微服务——SpringBoot使用归纳——Spring Boot中集成 Shiro——Shiro 身份和权限认证
本文介绍了 Apache Shiro 的身份认证与权限认证机制。在身份认证部分，分析了 Shiro 的认证流程，包括应用程序调用 `Subject.login(token)` 方法、SecurityManager 接管认证以及通过 Realm 进行具体的安全验证。权限认证部分阐述了权限（permission）、角色（role）和用户（user）三者的关系，其中用户可拥有多个角色，角色则对应不同的权限组合，例如普通用户仅能查看或添加信息，而管理员可执行所有操作。
Quan_Chen
323 0
Quan_Chen
|
6月前
|
安全 Java 数据安全/隐私保护
微服务——SpringBoot使用归纳——Spring Boot中集成 Shiro——Shiro 三大核心组件
本课程介绍如何在Spring Boot中集成Shiro框架，主要讲解Shiro的认证与授权功能。Shiro是一个简单易用的Java安全框架，用于认证、授权、加密和会话管理等。其核心组件包括Subject（认证主体）、SecurityManager（安全管理员）和Realm（域）。Subject负责身份认证，包含Principals（身份）和Credentials（凭证）；SecurityManager是架构核心，协调内部组件运作；Realm则是连接Shiro与应用数据的桥梁，用于访问用户账户及权限信息。通过学习，您将掌握Shiro的基本原理及其在项目中的应用。
Quan_Chen
248 0
小宋1021
|
3月前
|
前端开发
SpringBoot2.3.1集成Knife4j接口文档
SpringBoot2.3.1集成Knife4j接口文档
小宋1021
456 44
糊涂糊涂123
|
2月前
|
缓存 JSON 前端开发
第07课：Spring Boot集成Thymeleaf模板引擎
第07课：Spring Boot集成Thymeleaf模板引擎
糊涂糊涂123
386 0
第07课：Spring Boot集成Thymeleaf模板引擎
刘大猫.
|
2月前
|
Java 关系型数据库 MySQL
springboot项目集成dolphinscheduler调度器 实现datax数据同步任务
springboot项目集成dolphinscheduler调度器 实现datax数据同步任务
刘大猫.
343 2
刘大猫.
|
2月前
|
分布式计算 Java 大数据
springboot项目集成dolphinscheduler调度器 可拖拽spark任务管理
springboot项目集成dolphinscheduler调度器 可拖拽spark任务管理
刘大猫.
155 2
aliyun7374574637-16425
|
2月前
|
存储 人工智能 Java
Springboot集成AI Springboot3 集成阿里云百炼大模型CosyVoice2 实现Ai克隆语音(未持久化存储)
本项目基于Spring Boot 3.5.3与Java 17，集成阿里云百炼大模型CosyVoice2实现音色克隆与语音合成。内容涵盖项目搭建、音色创建、音频合成、音色管理等功能，适用于希望快速掌握Spring Boot集成语音AI技术的开发者。需提前注册阿里云并获取API Key。
aliyun7374574637-16425
383 0
刘大猫.
|
3月前
|
缓存 安全 Java
Shiro简介及SpringBoot集成Shiro(狂神说视频简易版)
Shiro简介及SpringBoot集成Shiro(狂神说视频简易版)
刘大猫.
296 6
蓝易云
|
4月前
|
缓存 Java 数据库
SpringBoot集成Ehcache缓存使用指南
以上是SpringBoot集成Ehcache缓存的基本操作指南，帮助你在实际项目中轻松实现缓存功能。当然，Ehcache还有诸多高级特性，通过学习和实践，你可以更好地发挥它的威力。
蓝易云
452 20

热门文章

最新文章

  • 1
    Spring Cloud Gateway 全解析：路由配置、断言规则与过滤器实战指南
  • 2
    深度剖析【Spring】事务：万字详解，彻底掌握传播机制与事务原理
  • 3
    微服务配置管理：Spring Cloud Config 实践指南
  • 4
    Spring 微服务和多租户：处理多个客户端
  • 5
    【Spring】原理解析：Spring Boot 自动配置
  • 6
    Spring Cloud 常见注解解析
  • 7
    Spring Boot 技术详解与应用实践
  • 8
    Spring Cloud 微服务架构技术解析与实践指南
  • 9
    Spring Batch 批处理框架技术详解与实践指南
  • 10
    Spring中@Cacheable、@CacheEvict以及其他缓存相关注解的实用介绍
  • 1
    springBoot——Web开发简介【七】
    126
  • 2
    【神操作！】Spring Boot打造RESTful API：从零到英雄，只需这几步，让你的Web应用瞬间飞起来！
    226
  • 3
    Spring Boot 接口返回文件流
    732
  • 4
    SpringBoot 读取 yml 配置的几种方式
    583
  • 5
    SpringBoot 配置多数据源
    139
  • 6
    SpringBoot 拦截器 统一日志 记录用户请求返回日志
    577
  • 7
    SpringBoot 记录 access.log 日志
    319
  • 8
    SpringBoot Scheduled 常见用法
    161
  • 9
    SpringBoot yml 小格子 变 小叶子
    80
  • 10
    Spring Boot Admin 自定义健康检查
    140

    • 相关课程

    更多
  • 大数据实战项目：反爬虫系统（Lua+Spark+Redis+Hadoop框架搭建）第二阶段
  • 精通Spring Cloud Alibaba
  • 微服务框架 Spring Cloud 快速入门
  • Java Web开发系列课程 - Spring框架入门
  • Spring Boot 2.5.x开发实战
  • Spring Cloud微服务架构设计与开发实战

    • 相关电子书

    更多
  • 云栖社区特邀专家徐雷Java Spring Boot开发实战系列课程（第20讲）：经典面试题与阿里等名企内部招聘求职面试技巧
  • 微服务架构模式与原理Spring Cloud开发实战
  • 阿里特邀专家徐雷Java Spring Boot开发实战系列课程（第18讲）：制作Java Docker镜像与推送到DockerHub和阿里云Docker仓库

    • 相关实验场景

    更多
  • AnalyticDB Zero-ETL：简单易用零成本的一站式数据分析
    • 下一篇
    2025云栖大会，阿里云百炼邀请您的参与和见证