解決@CachePut設(shè)置的key值無法與@CacheValue的值匹配問題

更新時間：2021年12月28日 08:57:46 作者：王德法_一直有你

這篇文章主要介紹了解決@CachePut設(shè)置的key的值無法與@CacheValue的值匹配問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

@CachePut設(shè)置的key值無法與@CacheValue的值匹配

緩存注解key的基本數(shù)據(jù)類型要求必須要統(tǒng)一

//根據(jù)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("運(yùn)行結(jié)果："+testMapper.updateById(testEntity));
    System.out.println("id:"+testEntity.getId());
    return testEntity;
}

//實(shí)體類修改前
public class TestEntity {
    private String id;//注意這里
    private String name;
    private String sex;
}

//實(shí)體類修改后
public class TestEntity {
    private int id;
    private String name;
    private String sex;
}

現(xiàn)在修改完成可以總結(jié)出來一個結(jié)論，key的基本數(shù)據(jù)類型要求必須要統(tǒng)一。

在cache中，數(shù)據(jù)類型的要求是非常嚴(yán)格的，同樣的id的為1，int類型和String類型是不同。

我一開始在這個錯誤上面困擾了好久，因?yàn)閙ybatis返回的結(jié)果中，對于int和String類型的id并沒有提示什么錯誤，一開始打斷點(diǎn)，扒源碼發(fā)現(xiàn)對這個key的生成并沒有什么改變，我寫的result.id一直傳到了生成id的地方，盡管如何生成的并沒有看的十分明白。

直到今天我再反復(fù)測試的時候，在寫到”result.”的時候忽然發(fā)現(xiàn)id是String類型的才恍然大悟。

Spring-Cache key設(shè)置注意事項(xiàng)

為了提升項(xiàng)目的并發(fā)性能，考慮引入本地內(nèi)存Cache，對：外部數(shù)據(jù)源訪問、Restful API調(diào)用、可重用的復(fù)雜計(jì)算等3種類型的函數(shù)處理結(jié)果進(jìn)行緩存。目前采用的是Spring Cache的@Cacheable注解方式，緩存具體實(shí)現(xiàn)選取的是Guava Cache。

具體緩存的配置此處不再介紹，重點(diǎn)對于key的配置進(jìn)行說明：

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默認(rèn)的SimpleKeyGenerator是不會將函數(shù)名組合進(jìn)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

而實(shí)際上的輸出是：

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

此外，原子類型的數(shù)組，直接作為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();
    }
}

采用此方式后可以解決：多參數(shù)、原子類型數(shù)組、方法名識別等問題

以上為個人經(jīng)驗(yàn)，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: