SpringBoot 项目整合 Redis 教程详解
Posted Java Fans
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了SpringBoot 项目整合 Redis 教程详解相关的知识，希望对你有一定的参考价值。
✅作者简介：2022年博客新星 第八。热爱国学的Java后端开发者，修心和技术同步精进。
🍎个人主页：Java Fans的博客
🍊个人信条：不迁怒，不贰过。小知识，大智慧。
💞当前专栏：SpringBoot 框架从入门到精通
✨特色专栏：国学周更-心性养成之路
🥭本文内容：SpringBoot 项目整合 Redis 教程详解
文章目录
Redis 是完全开源的，遵守 BSD 协议，是一个高性能的 key-value 数据库.
Redis 与其他 key - value 缓存产品有以下三个特点：
- Redis支持数据的持久化，可以将内存中的数据保存在磁盘中，重启的时候可以再次加载进行使用。
- Redis不仅仅支持简单的key-value类型的数据，同时还提供list，set，zset，hash等数据结构的存储。
- Redis支持数据的备份，即master-slave模式的数据备份。
Redis 的优势
- 性能极高 – Redis能读的速度是110000次/s,写的速度是81000次/s
- 丰富的数据类型 – Redis支持二进制案例的 String, List, Hash, Set 及 zset数据类型操作。
- 原子 – Redis的所有操作都是原子性的，意思就是要么成功执行要么失败完全不执行。单个操作是原子性的。多个操作也支持事务，即原子性，通过MULTI和EXEC指令包起来。
- 丰富的特性 – Redis还支持 publish/subscribe, 通知, key 过期等等特性
- Redis 是单线程的，6.0版本开始支持开启多线程。
Redis 安装
下载地址： https://github.com/tporadowski/redis/releases。
解压下载后的压缩文件，解压后文件列表如下：
使用cmd窗口打开Redis
redis-server.exe redis.windows.conf #加载配置文件启动
注：启动之后，不要关闭窗口，关闭窗口服务停止！
安装Redis数据库客户端
库相关指令：
flushdb 清空当前库
flushall 清空所有库
select 1 切换库
key的相关指令
| 指令 | 作用 | 语法 |
|---|---|---|
| del | 删除一个或多个key | del keyname |
| exists | 判断一个或多个key是否存在，多个key时有一个存在则就会返回1 | exists keyname |
| expire | 设置key的生存时间 单位 ：秒 | expire keyname seconds |
| keys | 查询所有匹配模式的key ？匹配一个字符 *匹配0-n个字符 [] 满足其中的一个 | key * key h?llo |
| move | 将key移动到指定的库中 | move keyname db |
| pexpire | 设置key的生存时间 单位 ：毫秒 设置成功返回1 否则返回0 | pexpire keyname milliseconds |
| ttl | 以秒为单位返回key的剩余生存时间，返回-1表示永久存储，-2表示key不存在 | ttl keyname |
| randomkey | 从当前数据库中随机的返回一个key | randomkey |
| rename | 重命名key，成功返回ok，否则返回错误信息。 | rename key newkey |
| type | 返回key所存储的值的类型 | type keyname |
Redis 数据类型
1.String（字符串）
- string 是 redis 最基本的类型，你可以理解成与 Memcached 一模一样的类型，一个 key 对应一个 value。
- string 类型是二进制安全的。意思是 redis 的 string 可以包含任何数据。比如jpg图片或者序列化的对象。
- string 类型是 Redis 最基本的数据类型，string 类型的值最大能存储 512MB。
操作指令：
| 命令 | 描述 |
|---|---|
| SET | 设置指定 key 的值 |
| GET | 获取指定 key 的值。 |
| GETRANGE | 返回 key 中字符串值的子字符 |
| GETSET | 将给定 key 的值设为 value ，并返回 key 的旧值(old value)。 |
| SETEX | 将值 value 关联到 key ，并将 key 的过期时间设为 seconds (以秒为单位)。 |
| SETNX | 只有在 key 不存在时设置 key 的值 |
| STRLEN | 返回 key 所储存的字符串值的长度。 |
| MSET | 同时设置一个或多个 key-value 对。 |
| MSETNX | 同时设置一个或多个 key-value 对，当且仅当所有给定 key 都不存在 |
| INCR | 将 key 中储存的数字值增一 |
| INCRBY | 将 key 所储存的值加上给定的增量值（increment） |
| INCRBYFLOAT | 将 key 所储存的值加上给定的浮点增量值（increment） |
| DECR | 将 key 中储存的数字值减一。 |
| DECRBY | key 所储存的值减去给定的减量值（decrement） |
| APPEND | 如果 key 已经存在并且是一个字符串， APPEND 命令将指定的 value 追加到该 key 原来值（value）的末尾 |
2.Hash（哈希）
- Redis hash 是一个键值(key=>value)对集合。
- Redis hash 是一个 string 类型的 field 和 value 的映射表，hash 特别适合用于存储对象。
操作指令：
| 命令 | 描述 |
|---|---|
| hset | 设置一个key/value对 |
| hget | 获取key对应的value |
| hgetall | 获取所有的key/value对 |
| hdel | 删除某个key/value对 |
| hexists | 判断一个key是否存在 |
| hkeys | 获取所有的key |
| hvals | 获取所有的value |
| hmset | 设置多个key/value |
| hmget | 获取多个key的value |
| hsetnx | 设置一个不存在的key的值 |
| hincrby | 为value的值进行加法运算 |
| hincrbyfloat | 为value的值进行加浮点类型值运算 |
3.List（列表）
- Redis 列表是简单的字符串列表，按照插入顺序排序。你可以添加一个元素到列表的头部（左边）或者尾部（右边）。
操作指令
| 命令 | 描述 |
|---|---|
| LINDEX | 通过索引获取列表中的元素 lindex lists 0 |
| LINSERT key BEFORE|AFTER | 在列表的元素前或者后插入元素 |
| LLEN | 获取列表长度 |
| LPOP | 移出并获取列表的第一个元素 |
| LPUSH | 将一个或多个值插入到列表头部 |
| LPUSHX | 将一个值插入到已存在的列表头部 |
| LRANGE | 获取列表指定范围内的元素 （0 -1） |
| LREM | 移除列表重复元素 |
| LSET | 通过索引设置列表元素的值 ，但是索引必须存在，实质是根据索引修改值 |
| LTRIM | 对一个列表进行修剪(trim)，就是说，让列表只保留指定区间内的元素，不在指定区间之内的元素都将被删除 |
| RPOP | 移除列表的最后一个元素，返回值为移除的元素 |
| RPOPLPUSH | 移除列表的最后一个元素，并将该元素添加到另一个列表并返回 |
| RPUSH | 在列表中添加一个或多个值 |
| RPUSHX | 为已存在的列表添加值 |
4.Set（集合）
- Redis 的 Set 是 string 类型的无序集合。
- 集合是通过哈希表实现的，所以添加，删除，查找的复杂度都是 O(1)。
操作指令：
| 命令 | 描述 |
|---|---|
| sadd | 为集合添加元素 |
| smembers | 显示集合中所有元素 （无序） |
| scard | 返回集合中元素的个数 |
| spop | 随机返回一个元素，并将这个元素删除 |
| smove | 从一个集合向令一个集合中转移元素 |
| srem | 从集合中删除一个元素 |
| sismember | 判断集合中是否包含这个元素 |
| srandmember | 随机返回一个元素 |
| sinter | 求交集 |
| sunion | 求和集 |
5.ZSet（sorted set：有序集合）
- Redis ZSet 和 Set 一样也是 String 类型元素的集合,且不允许重复的成员。
- 不同的是每个元素都会关联一个 double 类型的分数。Redis 正是通过分数来为集合中的成员进行从小到大的排序。
- ZSet 的成员是唯一的,但分数(score)却可以重复。
操作指令：
| 命令 | 描述 |
|---|---|
| zadd | 添加一个有序集合元素 |
| zcard | 返回集合中元素的个数 |
| zrange升序 zrevrange降序 | 返回一个范围内的元素 |
| zrangebyscore | 按照分数查找一个范围内的元素 |
| zrank | 返回排名 |
| zrevrank | 倒叙排名 |
| zscore | 显示某个元素的分数 |
| zrem | 移除某个元素 |
| zincrby | 给某个特定元素加分 |
SpringBoot 操作 Redis
spring boot data redis中提供了RedisTemplate和StringRedisTemplate，其中StringRedisTemplate是Redistemplate的子类，两个方法基本一致，不同之处主要体现在操作的数据类型不同，RedisTemplate中的两个泛型都是Object，意味着存储的key和value都可以是一个对象，而StringRedisTemplate的两个泛型都是String，意味着StringRedisTemplate的key和value都只能是字符串。
引入依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
SpringBoot 配置 Redis
spring:
redis:
# Redis数据库索引（默认为0）
database: 0
# Redis服务器地址
host: 127.0.0.1
# Redis服务器连接端口
port: 6379
# Redis服务器连接密码（默认为空）
password:
# 连接池最大连接数（使用负值表示没有限制）
jedis.pool.max-active: 20
# 连接池最大阻塞等待时间（使用负值表示没有限制）
jedis.pool.max-wait: -1
# 连接池中的最大空闲连接
jedis.pool.max-idle: 10
# 连接池中的最小空闲连接
jedis.pool.min-idle: 0
# 连接超时时间（毫秒）
timeout: 1000
RedisTemplate 及其相关方法
1.RedisTemplate 介绍
Spring封装了RedisTemplate对象来进行对Redis的各种操作，它支持所有的Redis原生的api。RedisTemplate位于spring-data-redis包下。RedisTemplate提供了redis各种操作、异常处理及序列化，支持发布订阅。
2.Redis 5种数据结构操作
- redisTemplate.opsForValue(); //操作字符串
- redisTemplate.opsForHash(); //操作hash
- redisTemplate.opsForList(); //操作list
- redisTemplate.opsForSet(); //操作set
- redisTemplate.opsForZSet(); //操作有序set
或者：
- redistempalate.boundValueOps
- redistempalate.boundSetOps
- redistempalate.boundListOps
- redistempalate.boundHashOps
- redistempalate.boundZSetOps
opsForXXX和boundXXXOps的区别：XXX为value的类型，前者获取一个operator，但是没有指定操作的对象（key），可以在一个连接（事务）内操作多个key以及对应的value；后者获取了一个指定操作对象（key）的operator，在一个连接（事务）内只能操作这个key对应的value。
SpringBootTest 实现Redis数据库增删改查
/**
* 使用RedisTemplate 操作Redis数据的不同数据类型
*/
@SpringBootTest
public class Springbootday03ApplicationTests
@Autowired
private RedisTemplate<String, String> redisTemplate;
/**
* String 类型数据操作
*/
@Test
public void operateString()
//添加值
redisTemplate.opsForValue().set("str", "strValue1");
//添加值 判定是否存在 存在则不添加
Boolean aBoolean = redisTemplate.opsForValue().setIfAbsent("str", "strAbsent");
System.out.println("str设置成功:" + aBoolean);
//获取值
String str = redisTemplate.opsForValue().get("str");
System.out.println("str = " + str);
//更新值
redisTemplate.opsForValue().set("str", "strValue2");
str = redisTemplate.opsForValue().get("str");
System.out.println("newStr = " + str);
//删除值
Boolean b = redisTemplate.delete("str");
System.out.println("str删除成功：" + b);
/**
* 操作string类型数据 设置过期时间
*/
@Test
public void operateString2()
redisTemplate.opsForValue().set("str", "strTimeout", 10, TimeUnit.SECONDS);
//判定值是否存在 不存在则设置值 同时设置过期时间
Boolean aBoolean = redisTemplate.opsForValue().setIfAbsent("str2", "strTimeoutAbsent", 20, TimeUnit.SECONDS);
System.out.println("setIfAbsent:" + aBoolean);
/**
* 操作hash类型数据
*/
@Test
public void operateHash()
//添加hash类型数据 key - value
redisTemplate.opsForHash().put("hash", "username", "admin");
//修改hash类型数据
redisTemplate.opsForHash().put("hash", "username", "tom");
redisTemplate.opsForHash().put("hash", "password", "123456");
//添加hash类型数据 key - map
HashMap<String, String> map = new HashMap<>();
map.put("driverName", "com.mysql.jdbc.Driver");
map.put("url", "jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC");
redisTemplate.opsForHash().putAll("hash", map);
//获取hash类型数据 entries
Map<Object, Object> hash = redisTemplate.opsForHash().entries("hash");
hash.forEach((key, value) ->
System.out.println(key + "::" + value);
);
//获取所有的key
Set<Object> keys = redisTemplate.opsForHash().keys("hash");
for (Object key : keys)
System.out.println("key:" + key);
//获取所有value
List<Object> values = redisTemplate.opsForHash().values("hash");
values.forEach(value -> System.out.println("value:" + value));
//删除hash类型数据 删除一个 返回删除的个数
Long delete = redisTemplate.opsForHash().delete("hash", "username");
System.out.println("delete = " + delete);
//删除hash类型数据 删除多个 返回删除的个数
delete = redisTemplate.opsForHash().delete("hash", "username", "password", "driverName");
System.out.println("delete = " + delete);
//删除hash类型数据 删除所有
Boolean delHash = redisTemplate.delete("hash");
System.out.println("delHah:" + delHash);
/**
* 操作List类型 有序 可重复
*/
@Test
public void operateList()
//左压栈
// redisTemplate.opsForList().leftPush("list", "listValue1");
// redisTemplate.opsForList().leftPush("list", "listValue1");
// redisTemplate.opsForList().leftPush("list", "listValue2");
// redisTemplate.opsForList().leftPush("list", "listValue3");
//右压栈
redisTemplate.opsForList().rightPush("list", "listValue0");
redisTemplate.opsForList().rightPush("list", "listValue2");
redisTemplate.opsForList().rightPush("list", "listValue0");
//左出栈
String list1 = redisTemplate.opsForList().leftPop("list");
System.out.println("leftPop list1 = " + list1);
//右出栈
String list2 = redisTemplate.opsForList().rightPop("list");
System.out.println("rightPop list2 = " + list2);
//获取所有数据
List<String> lists = redisTemplate.opsForList().range("list", 0, redisTemplate.opsForList().size("list") - 1);
lists.forEach(list -> System.out.println(list));
//设置指定位置的数据
redisTemplate.opsForList().set("list", 0, "listValue0");
/**
* 从存储在键中的列表中删除等于值的元素的第一个计数事件。
* count> 0：删除等于从左到右移动的值的第一个元素；
* count< 0：删除等于从右到左移动的值的第一个元素；
* count = 0：删除等于value的所有元素。
*/
Long remove = redisTemplate.opsForList().remove("list", -1, "listValue0");
System.out.println("remove:" + remove);
//删除指定key的list数据
Boolean list = redisTemplate.delete("list");
System.out.println("list集合删除成功:" + list);
/**
* 操作Set类型 无序 不可重复
*/
@Test
public void operateSet()
//设置set值
redisTemplate.opsForSet().add("set", "setValue0");
redisTemplate.opsForSet().add("set", "setValue0");
redisTemplate.opsForSet().add("set", "setValue1");
//判定是否包含
Boolean member = redisTemplate.opsForSet().isMember("set", "setValue0");
System.out.println("isMember:" + member);
//删除set中的值
Long remove = redisTemplate.opsForSet().remove("set", "setValue0");
System.out.println("remove = " + remove);
//获取set类型值
Set<String> set = redisTemplate.opsForSet().members("set");
set.forEach(str ->
System.out.println("str = " + str);
);
/**
* 操作 ZSet 有序 不可重复
*/
@Test
public void operateZSet()
//存储值
Boolean add = redisTemplate.opsForZSet().add("zset", "zsetValue0", 10);
System.out.println("add = " + add);
System.out.println("add = " + add);
add = redisTemplate.opsForZSet().add("zset", "zsetValue2", 2);
System.out.println("add = " + add);
//获取值
// Boolean zset = redisTemplate.delete("zset");
// System.out.println("delete zset = " + zset);
Redis工具类的封装
/**
* Redis 工具类
* @author mosin
* date 2021/11/30
* @version 1.0
*/
@Component
public final class RedisUtil
private RedisUtil();
@Autowired
private RedisTemplate<String,String> redisTemplate;
//设置值
public void setValue(String key,String value)
redisTemplate.opsForValue().set(key, value);
// 设置值 同时设置有效时间
public void setValue(String key, String value, Long timeOut, TimeUnit timeUnit)
redisTemplate.opsForValue().setIfAbsent(key, value, timeOut, timeUnit);
//设置值 没有则设置 有则不设置
public void setNx(String key,String value)
redisTemplate.opsForValue().setIfAbsent(key, value);
//设置值 没有则设置 同时设置有效时间 有则不设置
public void setNx(String key,String value,long timeOut,TimeUnit timeUnit)
redisTemplate.opsForValue().
这篇教程主要实现如何将redis整合到redis项目中。如何使用docker安装redis在这篇《docker安装redis》教程中讲解了
一、添加依赖
pom.xml
<!-- redis -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!-- spring2.X集成redis所需common-pool2-->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
<version>2.6.0</version>
</dependency>
二、添加redis配置类
RedisConfig.java
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.CachingConfigurerSupport;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializationContext;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
import java.time.Duration;
@EnableCaching //开启缓存
@Configuration //配置类
public class RedisConfig extends CachingConfigurerSupport {
@Bean
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
RedisTemplate<String, Object> template = new RedisTemplate<>();
RedisSerializer<String> redisSerializer = new StringRedisSerializer();
Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
ObjectMapper om = new ObjectMapper();
om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
jackson2JsonRedisSerializer.setObjectMapper(om);
template.setConnectionFactory(factory);
//key序列化方式
template.setKeySerializer(redisSerializer);
//value序列化
template.setValueSerializer(jackson2JsonRedisSerializer);
//value hashmap序列化
template.setHashValueSerializer(jackson2JsonRedisSerializer);
return template;
}
@Bean
public CacheManager cacheManager(RedisConnectionFactory factory) {
RedisSerializer<String> redisSerializer = new StringRedisSerializer();
Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
//解决查询缓存转换异常的问题
ObjectMapper om = new ObjectMapper();
om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
jackson2JsonRedisSerializer.setObjectMapper(om);
// 配置序列化（解决乱码的问题）,过期时间600秒
RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig()
.entryTtl(Duration.ofSeconds(600))
.serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer))
.serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(jackson2JsonRedisSerializer))
.disableCachingNullValues();
RedisCacheManager cacheManager = RedisCacheManager.builder(factory)
.cacheDefaults(config)
.build();
return cacheManager;
}
}
三、配置redis
application.properties
spring.redis.host=ip
spring.redis.port=6379
spring.redis.database= 0
spring.redis.timeout=1800000
spring.redis.lettuce.pool.max-active=20
spring.redis.lettuce.pool.max-wait=-1
#最大阻塞等待时间(负数表示没限制)
spring.redis.lettuce.pool.max-idle=5
spring.redis.lettuce.pool.min-idle=0
#最小空闲
这样就完成了整合redis，在项目中就可以使用redis存取东西了，在Controller层实现注入
@Autowired
private RedisTemplate<String,String> redisTemplate;