springboot项目集成Redis

梦里梦外; 2023-10-05 09:55 48阅读 0赞

springboot项目集成Redis很方便的，唯一需要注意的地方就是yml配置文件中的Redis信息，不要出现格式不正确。

引入Redis依赖是第一步，不在阐述，复制进去即可：

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

（一）修改yml文件，添加Redis配置参数

\# Spring配置  
spring:

\# Redis配置  
redis:  
database: 0  
timeout: 200  
host: 127.0.0.1（Redis服务器地址）  
port: 6379  
password: 123456（Redis密码）  
pool:  
max-active: 8  
max-wait: -1  
max-idle: 8  
min-idle: 0

（二）覆盖Redis默认的RedisTemplate(此步骤参考于网络)

因为Redis提供的RedisTemplate泛型是<Object, Object>，为了方便我们重写一个<String, Object>类型的，具体代码如下：

import com.fasterxml.jackson.annotation.JsonAutoDetect;  
import com.fasterxml.jackson.annotation.PropertyAccessor;  
import com.fasterxml.jackson.databind.ObjectMapper;

import org.springframework.cache.annotation.CachingConfigurerSupport;  
import org.springframework.context.annotation.Bean;  
import org.springframework.context.annotation.Configuration;  
import org.springframework.data.redis.connection.RedisConnectionFactory;  
import org.springframework.data.redis.core.\*;  
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;  
import org.springframework.data.redis.serializer.StringRedisSerializer;

@Configuration  
public class RedisConfig extends CachingConfigurerSupport\{

/\*\*  
\* retemplate相关配置  
\* @param factory  
\* @return  
\*/  
@Bean  
@SuppressWarnings("all")  
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) \{

RedisTemplate<String, Object> template = new RedisTemplate<>();  
// 配置连接工厂  
template.setConnectionFactory(factory);

//使用Jackson2JsonRedisSerializer来序列化和反序列化redis的value值（默认使用JDK的序列化方式）  
Jackson2JsonRedisSerializer jacksonSeial = new Jackson2JsonRedisSerializer(Object.class);

ObjectMapper om = new ObjectMapper();  
// 指定要序列化的域，field,get和set,以及修饰符范围，ANY是都有包括private和public  
om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);  
// 指定序列化输入的类型，类必须是非final修饰的，final修饰的类，比如String,Integer等会跑出异常  
om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON\_FINAL);  
jacksonSeial.setObjectMapper(om);

// 值采用json序列化  
template.setValueSerializer(jacksonSeial);  
//使用StringRedisSerializer来序列化和反序列化redis的key值  
template.setKeySerializer(new StringRedisSerializer());

// 设置hash key 和value序列化模式  
template.setHashKeySerializer(new StringRedisSerializer());  
template.setHashValueSerializer(jacksonSeial);  
template.afterPropertiesSet();

return template;  
\}

/\*\*  
\* 对hash类型的数据操作  
\*  
\* @param redisTemplate  
\* @return  
\*/  
@Bean  
public HashOperations<String, String, Object> hashOperations(RedisTemplate<String, Object> redisTemplate) \{  
return redisTemplate.opsForHash();  
\}

/\*\*  
\* 对redis字符串类型数据操作  
\*  
\* @param redisTemplate  
\* @return  
\*/  
@Bean  
public ValueOperations<String, Object> valueOperations(RedisTemplate<String, Object> redisTemplate) \{  
return redisTemplate.opsForValue();  
\}

/\*\*  
\* 对链表类型的数据操作  
\*  
\* @param redisTemplate  
\* @return  
\*/  
@Bean  
public ListOperations<String, Object> listOperations(RedisTemplate<String, Object> redisTemplate) \{  
return redisTemplate.opsForList();  
\}

/\*\*  
\* 对无序集合类型的数据操作  
\*  
\* @param redisTemplate  
\* @return  
\*/  
@Bean  
public SetOperations<String, Object> setOperations(RedisTemplate<String, Object> redisTemplate) \{  
return redisTemplate.opsForSet();  
\}

/\*\*  
\* 对有序集合类型的数据操作  
\*  
\* @param redisTemplate  
\* @return  
\*/  
@Bean  
public ZSetOperations<String, Object> zSetOperations(RedisTemplate<String, Object> redisTemplate) \{  
return redisTemplate.opsForZSet();  
\}

（三）、Redis工具类：

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;

/\*\*  
\* redisTemplate封装  
\*  
\* @author zjjlive@dist.com.cn  
\*/  
@Component  
public 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 可以传一个值 或多个  
\*/  
@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)  
\* @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);  
\}

//================================Map=================================  
/\*\*  
\* 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 true 成功 false 失败  
\*/  
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)  
\* @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);  
\}

//============================set=============================  
/\*\*  
\* 根据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=================================

/\*\*  
\* 获取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 索引 index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推  
\* @return  
\*/  
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 值  
\* @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 值  
\* @param time 时间(秒)  
\* @return  
\*/  
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;  
\}  
\}

（四）、测试代码：

import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.stereotype.Controller;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.bind.annotation.ResponseBody;

import com.ruoyi.system.utils.RedisUtil;

import java.util.HashMap;  
import java.util.Map;

@Controller  
@RequestMapping("/bearapi/redis")  
public class RedisController \{

private static int ExpireTime = 60; // redis中存储的过期时间60s

@Autowired  
private RedisUtil redisUtil;

@RequestMapping("set")  
@ResponseBody  
public Boolean redisset(String key,long time)\{  
Map<String,Object> map=new HashMap<String,Object>();

//return redisUtil.set(key,userEntity,ExpireTime);  
map.put("no",key);  
map.put("name", "张三");  
map.put("address","亚洲中国人民路中华大街等等！");  
/\*return redisUtil.set(key,map);\*/  
return redisUtil.set(key,map,time);  
\}

@RequestMapping("get")  
@ResponseBody  
public Object redisget(String key)\{  
return redisUtil.get(key);  
\}

测试通过，Bingo！