springboot 2.x整合redis，spring aop实现接口缓存
Posted chuhongyun
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了springboot 2.x整合redis，spring aop实现接口缓存相关的知识，希望对你有一定的参考价值。
pox.xml：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId><!-- redis -->
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId><!-- spring aop -->
</dependency>
application.yml：
redis:
database: 0
host: localhost
port: 6379
password:
jedis:
pool:
max-active: 200
max-wait: -1
max-idle: 10
min-idle: 0
timeout: 1000redis配置类：RedisConfig.java????
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
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.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
/**
* redis配置类
*
* @author chuhongyun
*/
@Configuration
public class RedisConfig
@Bean
@SuppressWarnings("all")
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory)
RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
template.setConnectionFactory(factory);
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);
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;
缓存接口：RedisCache.java
import java.lang.annotation.*;
/**
* redis 缓存接口
*
* @author chuhongyun
*/
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RedisCache
/**
* 键
* @return
*/
String key() default "";
/**
* 过期时间
* @return
*/
long expired() default -1;
/**
* 是否为查询操作
* 如果为写入数据库的操作，该值需置为 false
* @return
*/
boolean read() default true;
切面程序：RedisCacheAspect.java
import com.alibaba.fastjson.JSON;
import com.zhuyou.common.encryption.ShaUtil;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import java.util.concurrent.TimeUnit;
/**
* redis 切面程序
*
* @author chuhongyun
*/
@Component
@Aspect
public class RedisCacheAspect
private final static Logger logger = LoggerFactory.getLogger(RedisCacheAspect.class);
@Autowired
private RedisTemplate redisTemplate;
/**
* 定义切入点，使用了 @RedisCache 的方法
*/
@Pointcut("@annotation(RedisCache)")
public void redisServicePoint()
/**
* 环绕通知，方法拦截器
*/
@Around("redisServicePoint()")
public Object WriteReadFromRedis(ProceedingJoinPoint point)
logger.info("<====== 进入 redisCache 环绕通知 ======>");
try
// 获取RedisCache注解
RedisCache redisCache = ((MethodSignature) point.getSignature()).getMethod().getAnnotation(RedisCache.class);
if (redisCache != null && redisCache.read())
//类路径 方法参数 方法名 加密生成redis key
StringBuilder builder = new StringBuilder(point.getTarget().getClass().getName())
.append(JSON.toJSONString(point.getArgs()))
.append(point.getSignature().getName());
String key = RedisKey.I+ ShaUtil.setMD5(builder.toString());
// 查询操作
Object obj = redisTemplate.opsForValue().get(key);
if (obj == null)
// Redis 中不存在，则从数据库中查找，并保存到 Redis
logger.info("<====== Redis 中不存在该记录，从数据库查找 ======>");
obj = point.proceed();
if (obj != null)
if (redisCache.expired() > 0)
redisTemplate.opsForValue().set(key, obj, redisCache.expired(), TimeUnit.SECONDS);
else
redisTemplate.opsForValue().set(key, obj);
return obj;
catch (Throwable ex)
logger.error("<====== RedisCache 执行异常: ======>", ex);
return null;
Redis工具类：RedisService.java
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
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;
/**
* Redis工具类
*
* @author chuhongyun
*/
@Component
public class RedisService
@Autowired
private RedisTemplate<String, Object> redisTemplate;
// =============================common============================
/**
* 指定缓存失效时间
*
* @param key 键
* @param time 时间(秒)
* @return
*/
public boolean expire(String key, long time)
boolean result = false;
try
if (time > 0)
result = redisTemplate.expire(key, time, TimeUnit.SECONDS);
return result;
catch (Exception e)
e.printStackTrace();
return result;
/**
* 根据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 boolean del(String... key)
boolean result = false;
if (key != null && key.length > 0)
if (key.length == 1)
redisTemplate.delete(key[0]);
result = true;
else
redisTemplate.delete(CollectionUtils.arrayToList(key));
result = true;
return result;
/**
* 删除缓存 模糊匹配
*
* @param prex 匹配值
*/
public void deleteByPrex(String prex)
try
Set<String> keys = redisTemplate.keys(prex + "*");
redisTemplate.delete(keys);
catch (Exception e)
e.printStackTrace();
// ============================String=============================
/**
* 获取redis中的值
*
* @param key 键
* @return 值
*/
public String get(String key)
String result = null;
try
result = redisTemplate.opsForValue().get(key).toString();
catch (Exception e)
// e.printStackTrace();
return result;
/**
* 普通缓存放入
*
* @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;
目录结构如下：
?
以上是关于springboot 2.x整合redis，spring aop实现接口缓存的主要内容，如果未能解决你的问题，请参考以下文章
springboot 2.x整合redis，spring aop实现接口缓存