SpringBoot 集成 Redis 主要就是使用 RedisTemplate 类来进行各种操作。可以很多人没有注意到,在 SpringBoot 2.x 之后,底层访问redis 已经不再使用 jedis,而是 lettuce。
至于 jedis 和 lettuce 有什么区别呢,对我们有什么影响呢?
jeids:采用的直连redis server,在多个线程之间共用一个 jedis 实例时,是线程不安全的,如果想要避免线程不安全的,使用 jedis pool 连接池,这样每个线程单独使用一个 jedis 实例。由此带来的问题是,如果线程数过多,带来redis server的负载加大。有点类似于 BIO 模式。
lettuce:采用 netty 连接 redis server,实例可以在多个线程中进行共享,不存在线程不安全的情况,可以减少线程数量,在特殊情况下,lettuce 也可以使用多个实例。有点类似于 NIO 模式。
整合测试
1、新建一个 SpringBoot 项目
2、引入 spring-boot-starter-data-redis 的坐标
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
3、配置redis连接
# Redis 服务地址
spring.redis.host=127.0.0.1
# Reds 服务连接端口
spring.redis.port=6379
3、测试使用
@SpringBootTest
class SpringbootRedisApplicationTests {
@Autowired
private RedisTemplate redisTemplate;
@Test
void contextLoads() {
// 操作不同的数据类型,api和我们的命令是一样的
redisTemplate.opsForValue();//操作字符串
redisTemplate.opsForHash();//操作hash
redisTemplate.opsForList();//操作list
redisTemplate.opsForSet();//操作set
redisTemplate.opsForZSet();//操作有序set
// 除了基本的操作,我们常用的方法可以直接通过redisTemplate 操作,比如事务,和基本的CRUD
// 获取redis 的连接对象
RedisConnection connection = redisTemplate.getConnectionFactory().getConnection();
connection.flushAll();
connection.flushDb();
}
@Test
public void contextLoads2(){
redisTemplate.opsForValue().set("mykey","zhangsan");
System.out.println(redisTemplate.opsForValue().get("mykey"));
}
}
源码分析
查看一下源码:RedisAutoConfiguration
自动配置类
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(RedisOperations.class)
@EnableConfigurationProperties(RedisProperties.class)
@Import({ LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class })
public class RedisAutoConfiguration {
@Bean
@ConditionalOnMissingBean(name = "redisTemplate") // 我们可以自己定义一个RedisTemplate 来替换这个默认的
public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory)
throws UnknownHostException {
// 默认的 RedisTemplate 没有过多的设置,redis对象都是需要序列化的
// 两个泛型都是<Object, Object> 类型,我们后面使用需要强制转换<String, String>
RedisTemplate<Object, Object> template = new RedisTemplate<>();
template.setConnectionFactory(redisConnectionFactory);
return template;
}
@Bean
@ConditionalOnMissingBean // 由于String 是redis 是最常使用的类型,所以丹玉提出来一个bean。
public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory)
throws UnknownHostException {
StringRedisTemplate template = new StringRedisTemplate();
template.setConnectionFactory(redisConnectionFactory);
return template;
}
}
点进去查看:RedisProperties
配置文件
@ConfigurationProperties(prefix = "spring.redis")
public class RedisProperties {
private int database = 0; // 使用的0号数据库,默认是16个
private String url; // url地址
private String host = "localhost";
private String password; // 密码
private int port = 6379; // 端口
private boolean ssl; // 是否开启安全连接
private Duration timeout; // 超时等待
private String clientName; // 客户端名字
private Sentinel sentinel; // 哨兵模式
private Cluster cluster; // 集群
private final Jedis jedis = new Jedis();
private final Lettuce lettuce = new Lettuce();
}
继续探索源码:RedisTemplate
往下看继续看,
通过源码可以看出,SpringBoot 自动帮我们在容器中生成了一个 RedisTemplate
和一个 StringRedisTemplate
。
但是,这个 RedisTemplate 的泛型是 <Obejct,Object>
,写代码不方便,需要写好多类型转换的代码,我们需要一个泛型为<String,Object>
形式的 RedisTemplate。
而且,这个 RedisTemplate 没有设置数据存在 Redis 时,key 及 value 的系列化方式。
Spring Data Redis 提供了 RedisSerializer
接口,同时提供了多个实现该接口的系列化工具,如 JdkSerializationRedisSerializer
,Jackson2JsonRedisSerializer
和 GenericToStringSerializer
等。通过调用其实例的 serialize 和 deserialize 进行序列化和反序列化。
关于对象的保存
1、新建一个User类
@Component
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private String name;
private int age;
}
2、插入测试
@Test
public void contextLoads3() throws JsonProcessingException {
// 真实的开发中一般使用json来传递对象
User user = new User("蛋蛋", 3);
// String jsonUser = new ObjectMapper().writeValueAsString(user);
redisTemplate.opsForValue().set("user",user);
System.out.println(redisTemplate.opsForValue().get("user"));
}
发现报错,原因是实体类没有序列化。
此时我们把User类 实现 Serializable
类,重新测试即可。
看到这个 ConditionalOnMissingBean
注解后,就知道如果 Spring 容器有了 RedisTemplate 对象了,这个自动配置的 RedisTemplate 不会实例化。因此我们可以直接自己写一个配置类,配置 RedisTemplate 。
3、既然自动配置不好用,就重新配置一个 RedisTemplate
@Configuration
public class RedisConfig {
// 编写自己的 RedisTemplate
@Bean
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory)
throws UnknownHostException {
// 我们为了自己开发方便,一般使用 <String, Object>
RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
template.setConnectionFactory(factory);
// Json序列化配置
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);
// String的序列化
StringRedisSerializer stringRedisSerializer =new StringRedisSerializer();
// key 采用String的序列化方式
template.setKeySerializer(stringRedisSerializer);
// hash 的key 也采用String的序列化方式
template.setHashKeySerializer(stringRedisSerializer);
// value 序列化方式采用 Jackson
template.setValueSerializer(jackson2JsonRedisSerializer);
// hash 的 value序列化方式采用 Jackson
template.setHashValueSerializer(jackson2JsonRedisSerializer);
template.afterPropertiesSet();
return template;
}
}
重新测试插入数据,可以看到 redis中 没有转义字符。
4、写一个 Redis 工具类(直接用 RedisTemplate 操作redis,需要很多行代码,可以直接封装好一个RedisUtils,这样写代码更方便点。这个RedisUtils 交给Spring 容器实例化,使用时直接注解注入)
@Component
public final class RedisUtil {
@Autowired
private RedisTemplate<String,Object> redisTemplate;
/**
* 指定缓存失效时间
* @param key 键
* @param time 时间(秒)
* @return
*/
public boolean expire(String key, long time){
try {
if(time > 0){
redisTemplate.expire(key ,time,TimeUnit.SECONDS);
}
return true;
}catch (Exception e){
e.printStackTrace();
return false;
}
}
/**
* 根据 key 获取过期时间
* @param key 键 不能为null
* @return 时间(秒)返回0代表为永久有效
*/
public long getExpire(String key){
return redisTemplate.getExpire(key, TimeUnit.SECONDS);
}
/**
* 判断key 是否存在
* @param key 键
* @return true 存在 false 不存在
*/
public boolean hasKey(String key){
try {
return redisTemplate.hasKey(key);
} catch (Exception e){
e.printStackTrace();
return false;
}
}
/**
* 删除缓存
* @param key 可以传一个值 或多个
*/
public void del(String ... key){
if(key != null && key.length > 0){
if (key.length == 1) {
redisTemplate.delete(key[0]);
}else{
redisTemplate.delete(CollectionUtils.arrayToList(key));
}
}
}
/**
* 普通缓存获取
* @param key
* @return
*/
public Object get(String key){
return key == null ? null : redisTemplate.opsForValue().get(key);
}
/**
* 普通缓存存入
* @param key 键
* @param value 值
* @return true 成功 false 失败
*/
public boolean set(String key, Object value){
try {
redisTemplate.opsForValue().set(key,value);
return true;
} catch (Exception e){
e.printStackTrace();
return false;
}
}
/**
* 普通缓存放入并设置时间
* @param key 键
* @param value 值
* @param time 时间(秒) time要大于 0 如果time 小于等于0 将设置无限期
* @return true 成功 false 失败
*/
public boolean set(String key ,Object value ,long time){
try {
if (time > 0){
redisTemplate.opsForValue().set(key,value,time,TimeUnit.SECONDS);
}else{
set(key,value);
}
return true;
} catch (Exception e){
e.printStackTrace();
return false;
}
}
/**
* 递增
* @param key 键
* @param delta 要增加几(大于0)
* @return
*/
public long incr(String key,long delta){
if (delta < 0 ){
throw new RuntimeException("递增因子必须大于0");
}
return redisTemplate.opsForValue().increment(key, delta);
}
/**
* 递减
* @param key 键
* @param delta 要减少几(小于0)
* @return
*/
public long decr(String key,long delta){
if (delta < 0 ){
throw new RuntimeException("递减因子必须大于0");
}
return redisTemplate.opsForValue().increment(key, -delta);
}
/**
* HashGet
* @param key 键 不能为null
* @param item 项 不能为null
* @return
*/
public Object hget(String key, String item){
return redisTemplate.opsForHash().get(key, item);
}
/**
* 获取hashKey 对应的所有键值
* @param key
* @return
*/
public Map<Object,Object> hmget(String key){
return redisTemplate.opsForHash().entries(key);
}
/**
* HashSet
* @param key 键
* @param map 对应多个键值
* @return
*/
public boolean hmset(String key, Map<String,Object> map){
try {
redisTemplate.opsForHash().putAll(key,map);
return true;
}catch (Exception e){
e.printStackTrace();
return false;
}
}
/**
* HashSet 并设置时间
* @param key 键
* @param map 对应多个键值
* @param time 时间(秒)
* @return true 成功 false 失败
*/
public boolean hmset(String key, Map<String,Object> map, long time){
try {
redisTemplate.opsForHash().putAll(key, map);
if (time > 0){
expire(key,time);
}
return true;
}catch (Exception e){
e.printStackTrace();
return false;
}
}
/**
* 向一张hash 表中放入数据,如果不存在将创建
* @param key 键
* @param item 项
* @param value 值
* @return true 成功 false 失败
*/
public boolean hset(String key, String item, Object value){
try {
redisTemplate.opsForHash().put(key, item, value);
return true;
}catch (Exception e){
e.printStackTrace();
return false;
}
}
/**
* 删除hash 表中的值
* @param key 键 不能为null
* @param item 项 可以是多个 不能为null
*/
public void hdel(String key, Object... item){
redisTemplate.opsForHash().delete(key,item);
}
/**
* 判断hash表中是否有该项的值
* @param key 键 不能为null
* @param item 项 可以是多个 不能为null
* @return
*/
public boolean hHashKey(String key, String item){
return redisTemplate.opsForHash().hasKey(key,item);
}
/**
* hash 递增 如果不存在,就不创建一个 并不新增后的值返回
* @param key 键
* @param item 项
* @param by 要增加几(大于0)
* @return
*/
public double hincr(String key, String item,double by){
return redisTemplate.opsForHash().increment(key, item, by);
}
/**
* hash 递增
* @param key 键
* @param item 项
* @param by 要减少几(小于0)
* @return
*/
public double hdecr(String key, String item,double by){
return redisTemplate.opsForHash().increment(key, item, -by);
}
/**
* 根据 key 获取Set中的所有值
* @param key
* @return
*/
public Set<Object> sGet(String key){
try {
return redisTemplate.opsForSet().members(key);
}catch (Exception e){
e.printStackTrace();
return null;
}
}
/**
* 根据value 从一个set 中查询,是否存在
* @param key 键
* @param value 值
* @return true 存在 false 不存在
*/
public boolean sHasKey(String key,Object value){
try {
return redisTemplate.opsForSet().isMember(key, value);
} catch (Exception e){
e.printStackTrace();
return false;
}
}
/**
* 将数据存放入set缓存
* @param key 键
* @param values 值,可以是多个
* @return 成功个数
*/
public long sSet(String key, Object... values){
try {
return redisTemplate.opsForSet().add(key,values);
}catch (Exception e){
e.printStackTrace();
return 0;
}
}
/**
* 将set数据存入缓存
* @param key 键
* @param time 时间(秒)
* @param values 值 可以是多个
* @return 成功个数
*/
public long sSetAndTime(String key, long time, Object... values){
try {
Long count = redisTemplate.opsForSet().add(key, values);
if (time > 0){
expire(key, time);
}
return count;
}catch (Exception e){
e.printStackTrace();
return 0;
}
}
/**
* 获取set缓存的长度
* @param key
* @return
*/
public long sGetSetSize(String key){
try {
return redisTemplate.opsForSet().size(key);
}catch (Exception e){
e.printStackTrace();
return 0;
}
}
/**
* 移除值为value的
* @param key
* @param values
* @return 移除的个数
*/
public long setRemove(String key, Object... values){
try {
Long count =redisTemplate.opsForSet().remove(key, values);
return count;
}catch (Exception e){
e.printStackTrace();
return 0;
}
}
/**
* 获取list缓存的内容
* @param key
* @param start
* @param end 结束 0 到 -1 代表所有值
* @return
*/
public List<Object> lGet(String key, long start, long end){
try {
return redisTemplate.opsForList().range(key, start, end);
}catch (Exception e){
e.printStackTrace();
return null;
}
}
/**
* 获取list缓存的长度
* @param key
* @return
*/
public long lGetListSize(String key){
try {
return redisTemplate.opsForList().size(key);
}catch (Exception e){
e.printStackTrace();
return 0;
}
}
/**
* 通过索引获取list中的值
* @param key
* @param index
* @return 索引index>= 0时 0表头,1 第二个元素
*/
public Object IGetIndex(String key, long index){
try{
return redisTemplate.opsForList().index(key,index);
} catch (Exception e){
e.printStackTrace();
return null;
}
}
/**
* 将list 放入缓存
* @param key
* @param value
* @return
*/
public boolean lSet(String key, Object value){
try {
redisTemplate.opsForList().rightPush(key,value);
return true;
}catch (Exception e){
e.printStackTrace();
return false;
}
}
/**
* 将list放入缓存
* @param key
* @param value
* @return
*/
public boolean lSet(String key, List<Object> value){
try {
redisTemplate.opsForList().rightPushAll(key, value);
return true;
}catch (Exception e){
e.printStackTrace();
return false;
}
}
/**
* 将list放入缓存
* @param key
* @param value
* @param time
* @return
*/
public boolean lSet(String key, List<Object> value, long time){
try {
redisTemplate.opsForList().rightPushAll(key, value);
if (time > 0){
expire(key, time);
}
return true;
}catch (Exception e){
e.printStackTrace();
return false;
}
}
/**
* 感觉索引修改list 中的某条数据
* @param key
* @param index
* @param value
* @return
*/
public boolean lUpdateIndex(String key, long index, Object value){
try {
redisTemplate.opsForList().set(key,index,value);
return true;
}catch (Exception e){
e.printStackTrace();
return false;
}
}
/**
* 移除N个值为value
* @param key
* @param count
* @param value
* @return
*/
public long lRemove(String key, long count, Object value){
try {
Long remove = redisTemplate.opsForList().remove(key, count, value);
return remove;
}catch (Exception e){
e.printStackTrace();
return 0;
}
}
}
编写完工具类, 以后再调用就变得尤其的简单了。
如果有收获!!! 希望老铁们来个三连,点赞、收藏、转发。
创作不易,别忘点个赞,可以让更多的人看到这篇文章,顺便鼓励我写出更好的博客