SpringBoot @Cacheable自定义KeyGenerator方式
@Cacheable自定义KeyGenerator
1. 概述
SpringBoot 使用 @Cacheable 可以方便的管理缓存数据,在不指定 key 属性的情况下,默认使用 SimpleKeyGenerator 生成 key。除此之外,我们也可以自定义实现 KeyGenerator 接口,生成自己的 key 名称策略。
2. MySimpleKey 类
MySimpleKey类的作用是存放参数数据,必须实现equals、hashCode。如果需要自定义key格式,同样需要实现toString接口,下面的例子是把参数用逗号分隔。
public class MySimpleKey implements Serializable { public static final MySimpleKey EMPTY = new MySimpleKey(new Object[0]); private final Object[] params; private transient int hashCode; public MySimpleKey(Object... elements) { Assert.notNull(elements, "Elements must not be null"); this.params = (Object[])elements.clone(); this.hashCode = Arrays.deepHashCode(this.params); } public boolean equals(@Nullable Object other) { return this == other || other instanceof MySimpleKey && Arrays.deepEquals(this.params, ((MySimpleKey)other).params); } public final int hashCode() { return this.hashCode; } public String toString() { return StringUtils.arrayToCommaDelimitedString(this.params); } }
3. MyKeyGenerator 类
MyKeyGenerator 实现 KeyGenerator 的接口,里面只有一个 generate 方法
public class MyKeyGenerator implements KeyGenerator { @Override public Object generate(Object o, Method method, Object... objects) { if (objects.length == 0) { return MySimpleKey.EMPTY; } else { if (objects.length == 1) { Object param = objects[0]; if (param != null && !param.getClass().isArray()) { return param; } } return new MySimpleKey(objects); } } }
定义MyKeyGenerator Bean:
@Component public class MyRedisConf { @Bean public MyKeyGenerator myKeyGenerator(){ return new MyKeyGenerator(); } }
4. 配置keyGenerator
在 @Cacheable 配置 keyGenerator 属性,值就是前面配置的Bean名称
@Override @Cacheable(value = {"REDIS:GETSTRING3"}, keyGenerator = "myKeyGenerator") public String getString3(String tag, String name) { return tag + " " + name; }
测试结果如下,tag、name 参数确实以逗号分隔
127.0.0.1:6379[5]> KEYS *
1) "REDIS:GETSTRING3::hello,zhangsan"
Spring-Cache key设置
第一种方式:手动设置
为了便于key的不重复,我们可以手动设置key有类名、方法名、参数等组合
属性名称 |
描述 |
示例 |
methodName |
当前方法名 |
#root.methodName |
method |
当前方法 |
#root.method.name |
target |
当前被调用的对象 |
#root.target |
targetClass |
当前被调用的对象的class |
#root.targetClass |
args |
当前方法参数组成的数组 |
#root.args[0] |
caches |
当前被调用的方法使用的Cache |
#root.caches[0].name |
key = "#root.targetClass.simpleName+':'+#root.methodName+':'+#param"
如下图所示
第二种方式:自定义keyGenerator
1、自定义CacheKeyGenerator 实现KeyGenerator
public class CacheKeyGenerator implements KeyGenerator { /** * (非 Javadoc) * <p> * Title: generate * </p> * * @param target * @param method * @param params * @return * @see org.springframework.cache.interceptor.KeyGenerator#generate(java.lang.Object, * java.lang.reflect.Method, java.lang.Object[]) */ @Override public Object generate(Object target, Method method, Object... params) { StringBuilder key = new StringBuilder(); key.append(target.getClass().getSimpleName()).append(":").append(method.getName()).append(":"); if (params.length == 0) { return key.toString(); } for (int i = 0; i < params.length; i++) { Object param = params[i]; if (param == null || param instanceof LogableParam) { del(key); } else if (ClassUtils.isPrimitiveArray(param.getClass())) { int length = Array.getLength(param); for (int j = 0; j < length; j++) { key.append(Array.get(param, j)); key.append(','); } } else if (ClassUtils.isPrimitiveOrWrapper(param.getClass()) || param instanceof String) { key.append(param); } else { key.append(param.toString()); } key.append('-'); } del(key); return key.toString(); } private StringBuilder del(StringBuilder stringBuilder) { if (stringBuilder.toString().endsWith("-")) { stringBuilder.deleteCharAt(stringBuilder.length() - 1); } return stringBuilder; } }
2、配置xml
<cache:annotation-driven cache-manager="cacheManager" key-generator="cacheKeyGenerator" proxy-target-class="true" /> <bean id="cacheKeyGenerator" class="com.tensoon.util.CacheKeyGenerator"></bean>
3、配置注解
如下图所示
以上为个人经验,希望能给大家一个参考,也希望大家多多支持猪先飞。
原文出处:https://blog.csdn.net/qq_28834355/article/details/109570572
相关文章
解决springboot使用logback日志出现LOG_PATH_IS_UNDEFINED文件夹的问题
这篇文章主要介绍了解决springboot使用logback日志出现LOG_PATH_IS_UNDEFINED文件夹的问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-04-28- 这篇文章主要为大家详细介绍了SpringBoot实现excel文件生成和下载,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-02-09
- 这篇文章主要介绍了详解springBoot启动时找不到或无法加载主类解决办法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-09-16
- 这篇文章主要介绍了SpringBoot集成Redis实现消息队列的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-02-10
- 这篇文章主要介绍了解决Springboot get请求是参数过长的情况,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-09-17
- 这篇文章主要介绍了Springboot+TCP监听服务器搭建过程,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2020-10-28
Spring Boot项目@RestController使用重定向redirect方式
这篇文章主要介绍了Spring Boot项目@RestController使用重定向redirect方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-02- 这篇文章主要介绍了springBoot 项目排除数据库启动方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-10
springboot中使用@Transactional注解事物不生效的坑
这篇文章主要介绍了springboot中使用@Transactional注解事物不生效的原因,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-01-26- 这篇文章主要介绍了SpringBoot接口接收json参数解析,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-10-19
详解SpringBoot之访问静态资源(webapp...)
这篇文章主要介绍了详解SpringBoot之访问静态资源(webapp...),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-09-14- 这篇文章主要介绍了springboot多模块包扫描问题的解决方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-09-16
Springboot mybatis plus druid多数据源解决方案 dynamic-datasource的使用详解
这篇文章主要介绍了Springboot mybatis plus druid多数据源解决方案 dynamic-datasource的使用,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2020-11-18- 这篇文章主要介绍了Springboot实现多线程注入bean的工具类操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-08-27
Springboot+MDC+traceId日志中打印唯一traceId
本文主要介绍了Springboot+MDC+traceId日志中打印唯一traceId,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-10-17SpringBoot部署到Linux读取resources下的文件及遇到的坑
本文主要给大家介绍SpringBoot部署到Linux读取resources下的文件,在平时业务开发过程中,很多朋友在获取到文件内容乱码或者文件读取不到的问题,今天给大家分享小编遇到的坑及处理方案,感兴趣的朋友跟随小编一起看看吧...2021-06-21- 这篇文章主要介绍了springboot中nacos动态路由的配置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-11
SpringBoot高版本修改为低版本时测试类报错的解决方案
这篇文章主要介绍了SpringBoot高版本修改为低版本时测试类报错的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-18解决Springboot整合shiro时静态资源被拦截的问题
这篇文章主要介绍了解决Springboot整合shiro时静态资源被拦截的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-01-26springboot配置多数据源后mybatis拦截器失效的解决
这篇文章主要介绍了springboot配置多数据源后mybatis拦截器失效的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-23