解决@CachePut设置的key值无法与@CacheValue的值匹配问题

目录

• @CachePut设置的key值无法与@CacheValue的值匹配
• 缓存注解key的基本数据类型要求必须要统一
• Spring-Cache key设置注意事项
• 1、基本形式
• 2、组合形式
• 3、对象形式
• 4、自定义Key生成器
• 举个栗子

@CachePut设置的key值无法与@CacheValue的值匹配

缓存注解key的基本数据类型要求必须要统一

//根据id查询缓存的值
@Cacheable(value = "testCache")
public TestEntity listById(int id){
    return  testMapper.listById(id);
}
//修改缓存的值
@CachePut(value = "testCache" ,key = "#result.id")
public TestEntity updateById(TestEntity testEntity){
    System.out.println("运行结果："+testMapper.updateById(testEntity));
    System.out.println("id:"+testEntity.getId());
    return testEntity;
}

//实体类修改前
public class TestEntity {
    private String id;//注意这里
    private String name;
    private String sex;
}

//实体类修改后
public class TestEntity {
    private int id;
    private String name;
    private String sex;
}

现在修改完成可以总结出来一个结论，key的基本数据类型要求必须要统一。

在cache中，数据类型的要求是非常严格的，同样的id的为1，int类型和String类型是不同。

我一开始在这个错误上面困扰了好久，因为mybatis返回的结果中，对于int和String类型的id并没有提示什么错误，一开始打断点，扒源码发现对这个key的生成并没有什么改变，我写的result.id一直传到了生成id的地方，尽管如何生成的并没有看的十分明白。

直到今天我再反复测试的时候，在写到”result.”的时候忽然发现id是String类型的才恍然大悟。

Spring-Cache key设置注意事项

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

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

1、基本形式

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

2、组合形式

@Cacheable(value="cacheName", key"T(String).valueOf(#name).concat('-').concat(#password))
public ResultDTO method(int name, String password);

3、对象形式

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

4、自定义Key生成器

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

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

举个栗子

@Component
    public class CacheTestImpl implements CacheTest {
        @Cacheable("databaseCache")
        public Long test1()
        { return 1L; }

        @Cacheable("databaseCache")
        public Long test2()
        { return 2L; }

        @Cacheable("databaseCache")
        public Long test3()
        { return 3L; }

        @Cacheable("databaseCache")
        public String test4()
        { return "4"; }

    }

我们期望的输出是：

1
2
3
4

而实际上的输出是：

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

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

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

class CacheKeyGenerator implements KeyGenerator {

    // custom cache key
    public static final int NO_PARAM_KEY = 0;
    public static final int NULL_PARAM_KEY = 53;

    @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.append(NO_PARAM_KEY).toString();
        }
        for (Object param : params) {
            if (param == null) {
                log.warn("input null param for Spring cache, use default key={}", NULL_PARAM_KEY);
                key.append(NULL_PARAM_KEY);
            } else if (ClassUtils.isPrimitiveArray(param.getClass())) {
                int length = Array.getLength(param);
                for (int i = 0; i < length; i++) {
                    key.append(Array.get(param, i));
                    key.append(',');
                }
            } else if (ClassUtils.isPrimitiveOrWrapper(param.getClass()) || param instanceof String) {
                key.append(param);
            } else {
                log.warn("Using an object as a cache key may lead to unexpected results. " +
                        "Either use @Cacheable(key=..) or implement CacheKey. Method is " + target.getClass() + "#" + method.getName());
                key.append(param.hashCode());
            }
            key.append('-');
        }

        String finalKey = key.toString();
        long cacheKeyHash = Hashing.murmur3_128().hashString(finalKey, Charset.defaultCharset()).asLong();
        log.debug("using cache key={} hashCode={}", finalKey, cacheKeyHash);
        return key.toString();
    }
}

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

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。