SpringBoot的源码我全部放在下面链接上了,链接里面有我整理的SpringBoot整合其他技术的源码以及教程,还有SpringBoot的其他学习资料,欢迎大家来下载学习,如果该教程对你有所帮助,还请star支持一下,谢谢!
源码链接:https://gitee.com/oldou/springbootstudy
简介
SpringBoot操作数据:spring-data jpa jdbc mongodbredis !
SpringData是和SpringBoot齐名的项目!
说明∶在SpringBoot2.x之后,原来使用的jedis被替换为了lettuce,我们可以在我们的pom文件中查看:
lettuce与jedis的区别:
- jedis:采用的直连,多个线程操作的话,是不安全的,如果想要避免不安全的,使用jedis pool连接池!更像BIO模式
- lettuce:采用netty,实例可以再多个线程中进行共享,不存在线程不安全的情况,可以减少线程数据了,更像NIO模式
SpringBoot中Redis的自动配置
SpringBoot的所有配置都会有一个自动配置类XxxxAutoConfiguration,而Redis的自动配置类就是RedisAutoConfiguration
,我们可以去SpringBoot的自动配置的源码中查看,也就是spring-boot-autoconfigure-2.3.3.RELEASE.jar
这个包下的META-INF/spring.factories
文件中查看
搜索Redis就可以看见Redis的自动配置类RedisAutoConfiguration
,并且SpringBoot的每个自动配置类都会绑定一个properties配置文件,Redis的配置文件为RedisProperties.properties
。
在该properties文件中会有相关的属性介绍,而在application.properties/yml文件中对Redis进行配置相当于操作该RedisProperties.properties文件中的属性。
RedisAutoConfiguration中的两个方法介绍
我们在RedisAutoConfiguration这个自动配置类中可以看见有两个方法redisTemplate和stringRedisTemplate,源码如下所示:
@Bean //下面这个注解的意思是如果redisTemplate这个Bean存在那么这里的redisTemplate就会失效。
@ConditionalOnMissingBean(name = "redisTemplate") //这是默认的redisTemplate,我们可以自己定义一个redisTemplate来替换这个默认的
public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory)
throws UnknownHostException {
//默认的RedisTemplate,没有过多的设置,使用Redis对象都需要序列化
//两个泛型都是Object,Object类型,我们使用时需要进行强制转换<String,Object>
RedisTemplate<Object, Object> template = new RedisTemplate<>();
template.setConnectionFactory(redisConnectionFactory);
return template;
}
@Bean
@ConditionalOnMissingBean //由于String是Redis中最常使用的类型,所以说单独提取出来了一个Bean。如果要使用String类型直接调用这个方法就可以了。
public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory)
throws UnknownHostException {
StringRedisTemplate template = new StringRedisTemplate();
template.setConnectionFactory(redisConnectionFactory);
return template;
}
以上方法在自定义RedisTemplate中会有说明。
SpringBoot整合Redis
新建项目
我们新建一个项目,添加以下Dependencies:
配置连接
项目建立好之后,这里我是在Linux中搭建了一个单机版的Redis,因此在Linux上启动Redis之后,记得要关闭防火墙(不然连接不了),我们就在application.properties文件中去配置连接。
# SpringBoot的所有配置类都会有一个自动配置类 Redis的自动配置类 RedisAutoConfiguration
# SpringBoot的每个自动配置类都会绑定一个properties配置文件 RedisProperties.properties
# 配置Redis 这里我连接Linux上的Redis 默认是localhost
spring.redis.host=192.168.15.133
spring.redis.port=6379
测试连接
我们在测试类中编写以下测试代码进行测试:
@Autowired
private RedisTemplate redisTemplate;
@Test
void contextLoads() {
/**使用redisTemplate操作不同的数据类型,api和指令是一样的
* opsForValue():操作字符串 类似String
* opsForList():操作List 类似List
* opsForHash():操作Hash
* opsForZSet()
* opsForGeo()
* opsForHyperLogLog()
* 除了基本的操作,我们常用的方法都可以直接通过redisTemplate操作,比如事务和基本的CURD
*/
redisTemplate.opsForValue().set("MyKey1","hello redisTemplate!");
System.out.println(redisTemplate.opsForValue().get("MyKey1"));
/** 获取Redis的连接对象
* RedisConnection connection = redisTemplate.getConnectionFactory().getConnection();
* connection.flushAll();
* connection.flushDb();
*/
}
控制台输出:
Linux中的Redis中使用keys *
命令查看:
可以发现,在键的前面多了一连串的转义字符,那么为什么会输出前面那部分呢?首先我们得去源码中查看,我们进到RedisAutoConfiguration
—>找到RedisTemplate
点进去查看
我们发现这个RedisTemplate比较庞大,里面进行了很多操作,其中如上图中显示的代码,RedisTemplate对键和值都进行了序列化的配置,那它们是使用什么序列化方式进行序列化的呢?我们往下去找它们的赋值方式,找到如下图所示:
可以看见默认对值的序列化操作是使用JDK
来进行的,而JDK序列化
就会让我们的字符串进行转义。因此会出现linux中那样的输出结果。
使用JDK序列化出现的问题不方便我们的使用,并且当我们传递对象的时候,如果对象没有被序列化就会直接报错。有时候我们不想使用JDK序列化,想使用其他的序列化方式怎么办?
这个时候我们就需要自定义一个RedisTemplate,自己定义一个配置类,而在前面的源码分析中也介绍了如果我们自己定义一个RedisTemplate,那么默认的RedisTemplate就会失效。
自定义RedisTemplate
新建一个RedisConfig配置类,记得给类加上@Configuration注解,自定义一个redisTemplate方法,具体代码如下所示:
@Configuration
public class RedisConfig {
//配置我们自己的redisTemplate 固定模板
@Bean
@SuppressWarnings("all") //告诉编译器忽略全部的警告,不用在编译完成后出现警告信息
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(); //JackSon对象
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);
//配置完之后将所有的properties设置进去
template.afterPropertiesSet();
return template;
}
}
以上使用了两种序列化方式,分别是Json序列化
和String序列化方式
,当然还有其它的序列化方式,要想查看其他的序列化方式只需要找到RedisSerializer接口
,查看其实现类即可,如下所示:
默认的是采用JDK序列化方式,如果想自定义其他的序列化方式,可以按照以上方式修改。
RedisUtil工具类
一般来说,我们redisTemplate对象去操作数据类型比较麻烦,我们一般会将操作封装成一个工具类,用的时候直接调用就可以了。
package com.oldou.utils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
@Component
public final class RedisUtil {
@Autowired
private RedisTemplate<String, Object> redisTemplate;
// =============================common============================
/**
* 指定缓存失效时间
* @param key 键
* @param time 时间(秒)
*/
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 可以传一个值 或多个
*/
@SuppressWarnings("unchecked")
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));
}
}
}
// ============================String=============================
/**
* 普通缓存获取
* @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)
*/
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)
*/
public long decr(String key, long delta) {
if (delta < 0) {
throw new RuntimeException("递减因子必须大于0");
}
return redisTemplate.opsForValue().increment(key, -delta);
}
// ================================Map=================================
/**
* HashGet
* @param key 键 不能为null
* @param item 项 不能为null
*/
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 对应多个键值
*/
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 键
* @param item 项
* @param value 值
* @param time 时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间
* @return true 成功 false失败
*/
public boolean hset(String key, String item, Object value, long time) {
try {
redisTemplate.opsForHash().put(key, item, value);
if (time > 0) {
expire(key, time);
}
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 true 存在 false不存在
*/
public boolean hHasKey(String key, String item) {
return redisTemplate.opsForHash().hasKey(key, item);
}
/**
* hash递增 如果不存在,就会创建一个 并把新增后的值返回
*
* @param key 键
* @param item 项
* @param by 要增加几(大于0)
*/
public double hincr(String key, String item, double by) {
return redisTemplate.opsForHash().increment(key, item, by);
}
/**
* hash递减
*
* @param key 键
* @param item 项
* @param by 要减少记(小于0)
*/
public double hdecr(String key, String item, double by) {
return redisTemplate.opsForHash().increment(key, item, -by);
}
// ============================set=============================
/**
* 根据key获取Set中的所有值
* @param key 键
*/
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 键
*/
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=================================
/**
* 获取list缓存的内容
*
* @param key 键
* @param start 开始
* @param end 结束 0 到 -1代表所有值
*/
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 键
*/
public long lGetListSize(String key) {
try {
return redisTemplate.opsForList().size(key);
} catch (Exception e) {
e.printStackTrace();
return 0;
}
}
/**
* 通过索引 获取list中的值
*
* @param key 键
* @param index 索引 index>=0时, 0 表头,1 第二个元素,依次类推;index<0时,-1,表尾,-2倒数第二个元素,依次类推
*/
public Object lGetIndex(String key, long index) {
try {
return redisTemplate.opsForList().index(key, index);
} catch (Exception e) {
e.printStackTrace();
return null;
}
}
/**
* 将list放入缓存
*
* @param key 键
* @param value 值
*/
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 值
* @param time 时间(秒)
*/
public boolean lSet(String key, Object value, long time) {
try {
redisTemplate.opsForList().rightPush(key, value);
if (time > 0)
expire(key, time);
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;
}
}
}
OK,关于SpringBoot整合Redis就介绍到这里了,虽然没有详细的说明每个步骤,但是看代码我觉得应该还是能够看得明白,这里需要注意的是,以上的自定义RedisTemplate和封装的工具类可以直接使用,重要的是要清楚Redis的RedisTemplate的序列化方式以及是如何操作数据的,还有工具类中还是要对Redis的数据类型以及类型对应的指令有一定的理解。