SpringBoot系列：11. SpringBoot整合Redis详解
- Redis前言概述
1.1 Redis底层
1.2 Redis序列化问题 - SpringBoot整合Redis实战
前言
- 本文主要对SpringBoot集成Redis做一个大致的说明及应用。
1. Redis前言概述
1.1 Redis底层
- 在Spring2.x之后，原来使用的Jedis被替换为了lettuce。
- jedis：底层采用的是直连，多个线程操作的话，是不安全的。如果想要避免不安全的这个因素，就是使用jedis pool的连接池，但是使用jedis pool的连接池由此带来的问题也非常大(线程数量多，>service非常多等，很麻烦)
- lettuce：底层采用netty，高性能网络框架，异步请求速度快，实>例可以在多个线程之间共享。 因此lettuce不存在线程不安全的情况，可以减少线程数量，就不需>要去开连接池了。
- 所以jedis更像：BIO模式，lettuce更像：NIO模式。
1.2 Redis序列化问题
- 在Redis中，如存入的数据是中文，取出来可能会是乱码。
⑴ 关于Redis的中文乱码问题，这就涉及到RedisTemplate底层的数据类型问题。
------->如图所示-“图Ser1”。跟这几个序列化类型有关系。
⑵ 在RedisTemplate默认的序列化方式是JDK序列化，JDK序列化就会让我们的字符串
转义(这就是造成乱码的原因)，因此我们可能会使用Json来序列化实现中文乱码的解决。
⑶ 所以就需要我们去自定义一个配置类，不使用Redis底层默认的JDK序列化配置方式。- 因此Redis官方表示：如果我们自己写一个RedisTemplate类，Redis底层的默认的RedisTemplate类就会失效！
----->如图所示-“图Ser2”
图Ser1
图Ser2
2. SpringBoot整合Redis实战
① 第一步：导入依赖
<!--操作redis-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
② 第二步：application.properties中配置Redis的连接
# 配置redis
spring.redis.host= 填入redis的IP地址(例如：127.0.0.1)
springboot.redis.port=6379(redis端口)
③ 第三步：创建一个User实体类并实现序列化
- 让User实现序列化，防止使用Redis存储并传递User对象的时候，报序列化的错误，
@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
public class User implements Serializable {
private String username;
private int age;
}
④ 第四步：由于User实现了序列化之后，User中的数据在传递的过程中需要进行解析，
才可使正常显示，Redis默认的序列化解析方式是：JDK序列化，对于默认的序列化方式
我们可以自定义一个自己的序列化方式来取代Redis默认的序列化方式"RedisConfig"
/**
* -->下面重写Redis的配置类，解决序列化乱码问题
* -->编写自己的redisTemplate的序列化方式
* -->下面的redisTemplate就是一个模板，以后关于Redis的序列化问题，
* 此RedisConfig类，直接拿来使用即可！
*
*/
@Configuration //告诉Spring这是一个配置类
public class RedisConfig {
/**
* 下面自定义了一个redisTemplate
* -->分别创建了两种序列化解析方式，来替换运来的JDK序列化解析方式
* 方式一：Json序列化方式
* 方式二：String类型的序列化方式
*/
@Bean
public RedisTemplate<String, Object> redisTemplate1(RedisConnectionFactory factory)
throws UnknownHostException {
//我们为了开发方便，直接使用类型
RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
template.setConnectionFactory(factory);
/**
* 1. 方式一：创建Json的序列化方式
* -->配置Redis的序列化解析方式是Json
* -->即：通过Json去解析任何传进来的实体类对象，
* 而不是使用原来的JDK去解析。
*/
Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
//1.1 Json的序列化方式，我们需要通过ObjectMapper进行转义
ObjectMapper om = new ObjectMapper();
om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
//1.2 转义完就可以使用Json的序列化方式了
jackson2JsonRedisSerializer.setObjectMapper(om);
/**
* 2.方式二：创建String类型的序列化方式
* -->配置Redis的序列化解析方式是Json
* -->即：通过Json去解析任何传进来的实体类对象，
* 而不是使用原来的JDK去解析。
*/
StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
/**
* 3. 上面创建好两种序列化方式后，将两种序列化方式
* 分别应用到(set)Redis的不同数据类型里面去使用
*
*/
// 所有String类型的key都采用String的序列化方式
template.setKeySerializer(stringRedisSerializer);
// 所有hash类型的key也采用String的序列化方式
template.setHashKeySerializer(stringRedisSerializer);
// 所有的value类型的序列化方式采用jackson
template.setValueSerializer(jackson2JsonRedisSerializer);
// 如果是hash的value序列化方式采用jackson
template.setHashValueSerializer(jackson2JsonRedisSerializer);
//上面设置好每一种类型对应的序列化方式后，将所有的properties设置set进去。
template.afterPropertiesSet();
return template;
}
}
⑤ 第五步：在企业开发中，要使用Redis操作各种类型，就将Redis里面各个指令的操作方法封装
到一个工具类中RedisUtil，直接调用这个RedisUtil工具类即可！
RedisUtils工具类↓：
/**
*
* 操作Redis的工具类
*/
@Component
public final class RedisUtil {
//以下@Autowired导入的是我们自己写的RedisTemplate配置类
@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;
}
}
}
⑥ 第六步：测试
-注意一： 此时底层使用的序列化方式redisTemplate就是我们自定义的redisTemplate而不是redis
默认的那个RedisTemplate类。
-注意二： 由于我们将Redis的增删改查方法封装进一个工具类中，此工具类RedisUtil
里面使用的就是我们自定义的RedisTemplate类，因此我们要实现Redis的增删改查的操作，
直接调用此工具类RedisUtil来实现即可。
@SpringBootTest
class SpringbootRedisApplicationTests {
/**
* 引入Redis的工具类
*/
@Autowired
private RedisUtil redisUtil;
@Test
public void test1() {
/**
* 1. 利用创建的User实体类来保存数据
* 2. 真实开发一般都是使用json来传递对象
*
*/
//创建User对象并赋值
User user = new User("linzk123",3);
//将序列化后的对象存到Redis中
redisUtil.set("user", user);
//根据键user获取存到Redis的jsonUser值
System.out.println(redisUtil.get("user"));
}
}
------>↑运行test1()程序测试，成功序列化并解析出"user"的数据。