Spring-Cache key设置注意事项,及自定义keyGenerator

为了提升项目的并发性能,考虑引入本地内存Cache,对:外部数据源访问、Restful API调用、可重用的复杂计算 等3种类型的函数处理结果进行缓存。目前采用的是Spring Cache的@Cacheable注解方式,缓存具体实现选取的是Guava Cache。


具体缓存的配置此处不再介绍,重点对于key的配置进行说明:


1、基本形式


   
   
   
   
  1. @Cacheable(value= "cacheName", key "#id")
  2. public ResultDTO method(int id);

2、组合形式


   
   
   
   
  1. @Cacheable(value= "cacheName", key "T(String).valueOf(#name).concat('-').concat(#password))
  2. public ResultDTO method(int name, String password);
3、对象形式


   
   
   
   
  1. @Cacheable(value= "cacheName", key "#user.id)
  2. public ResultDTO method(User user);

4、自定义Key生成器


   
   
   
   
  1. @Cacheable(value= "gomeo2oCache", keyGenerator = "keyGenerator")
  2. public ResultDTO method(User user);


有一个尤其需要注意的坑Spring默认的SimpleKeyGenerator是不会将函数名组合进key中的

举个栗子


   
   
   
   
  1. @Component
  2. public class CacheTestImpl implements CacheTest {
  3. @Cacheable( "databaseCache")
  4. public Long test1()
  5. { return 1L; }
  6. @Cacheable( "databaseCache")
  7. public Long test2()
  8. { return 2L; }
  9. @Cacheable( "databaseCache")
  10. public Long test3()
  11. { return 3L; }
  12. @Cacheable( "databaseCache")
  13. public String test4()
  14. { return "4"; }
  15. }
我们期望的输出是


   
   
   
   
  1. 1
  2. 2
  3. 3
  4. 4
而实际上的输出是


   
   
   
   
  1. 1
  2. 1
  3. 1
  4. ClassCastException: java.lang.Long cannot be cast to java.lang.String

此外,原子类型的数组,直接作为key使用也是不会生效的


为了解决上述2个问题,自定义了一个KeyGenerator如下:


   
   
   
   
  1. class CacheKeyGenerator implements KeyGenerator {
  2. // custom cache key
  3. public static final int NO_PARAM_KEY = 0;
  4. public static final int NULL_PARAM_KEY = 53;
  5. @Override
  6. public Object generate(Object target, Method method, Object... params) {
  7. StringBuilder key = new StringBuilder();
  8. key.append(target.getClass().getSimpleName()).append( ".").append(method.getName()).append( ":");
  9. if (params.length == 0) {
  10. return key.append(NO_PARAM_KEY).toString();
  11. }
  12. for (Object param : params) {
  13. if (param == null) {
  14. log.warn( "input null param for Spring cache, use default key={}", NULL_PARAM_KEY);
  15. key.append(NULL_PARAM_KEY);
  16. } else if (ClassUtils.isPrimitiveArray(param.getClass())) {
  17. int length = Array.getLength(param);
  18. for ( int i = 0; i < length; i++) {
  19. key.append(Array.get(param, i));
  20. key.append( ',');
  21. }
  22. } else if (ClassUtils.isPrimitiveOrWrapper(param.getClass()) || param instanceof String) {
  23. key.append(param);
  24. } else {
  25. log.warn( "Using an object as a cache key may lead to unexpected results. " +
  26. "Either use @Cacheable(key=..) or implement CacheKey. Method is " + target.getClass() + "#" + method.getName());
  27. key.append(param.hashCode());
  28. }
  29. key.append( '-');
  30. }
  31. String finalKey = key.toString();
  32. long cacheKeyHash = Hashing.murmur3_128().hashString(finalKey, Charset.defaultCharset()).asLong();
  33. log.debug( "using cache key={} hashCode={}", finalKey, cacheKeyHash);
  34. return key.toString();
  35. }
  36. }

采用此方式后可以解决:多参数、原子类型数组、方法名识别 等问题



https://blog.csdn.net/syani/article/details/52239967

你可能感兴趣的:(后端)